com.unboundid.ldap.sdk.unboundidds.examples
Class SummarizeAccessLog

java.lang.Object
  extended by com.unboundid.util.CommandLineTool
      extended by com.unboundid.ldap.sdk.unboundidds.examples.SummarizeAccessLog
All Implemented Interfaces:
java.io.Serializable

@NotMutable
@ThreadSafety(level=NOT_THREADSAFE)
public final class SummarizeAccessLog
extends CommandLineTool
implements java.io.Serializable

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
This class provides a tool that may be used to read and summarize the contents of one or more access log files from UnboundID or Alcatel-Lucent 8661 server products. Information that will be reported includes: It is designed to work with access log files using either the default log format with separate request and response messages, as well as log files in which the request and response details have been combined on the same line. The log files to be processed should be provided as command-line arguments.

The APIs demonstrated by this example include:

See Also:
Serialized Form

Constructor Summary
SummarizeAccessLog(java.io.OutputStream outStream, java.io.OutputStream errStream)
          Creates a new instance of this tool.
 
Method Summary
 void addToolArguments(ArgumentParser parser)
          Adds the command-line arguments supported for use with this tool to the provided argument parser.
 void doExtendedArgumentValidation()
          Performs any necessary processing that should be done to ensure that the provided set of command-line arguments were valid.
 ResultCode doToolProcessing()
          Performs the core set of processing for this tool.
 java.util.LinkedHashMap<java.lang.String[],java.lang.String> getExampleUsages()
          Retrieves a set of information that may be used to generate example usage information.
 int getMaxTrailingArguments()
          Retrieves the maximum number of unnamed trailing arguments that may be provided for this tool.
 java.lang.String getToolDescription()
          Retrieves the description for this tool.
 java.lang.String getToolName()
          Retrieves the name for this tool.
 java.lang.String getToolVersion()
          Retrieves the version string for this tool.
 java.lang.String getTrailingArgumentsPlaceholder()
          Retrieves a placeholder string that should be used for trailing arguments in the usage information for this tool.
static void main(java.lang.String[] args)
          Parse the provided command line arguments and perform the appropriate processing.
static ResultCode main(java.lang.String[] args, java.io.OutputStream outStream, java.io.OutputStream errStream)
          Parse the provided command line arguments and perform the appropriate processing.
 
Methods inherited from class com.unboundid.util.CommandLineTool
createArgumentParser, doShutdownHookProcessing, err, getErr, getOut, out, registerShutdownHook, runTool, wrapErr, wrapOut
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SummarizeAccessLog

public SummarizeAccessLog(java.io.OutputStream outStream,
                          java.io.OutputStream errStream)
Creates a new instance of this tool.

Parameters:
outStream - The output stream to which standard out should be written. It may be null if output should be suppressed.
errStream - The output stream to which standard error should be written. It may be null if error messages should be suppressed.
Method Detail

main

public static void main(java.lang.String[] args)
Parse the provided command line arguments and perform the appropriate processing.

Parameters:
args - The command line arguments provided to this program.

main

public static ResultCode main(java.lang.String[] args,
                              java.io.OutputStream outStream,
                              java.io.OutputStream errStream)
Parse the provided command line arguments and perform the appropriate processing.

Parameters:
args - The command line arguments provided to this program.
outStream - The output stream to which standard out should be written. It may be null if output should be suppressed.
errStream - The output stream to which standard error should be written. It may be null if error messages should be suppressed.
Returns:
A result code indicating whether the processing was successful.

getToolName

public java.lang.String getToolName()
Retrieves the name for this tool.

Specified by:
getToolName in class CommandLineTool
Returns:
The name for this tool.

getToolDescription

public java.lang.String getToolDescription()
Retrieves the description for this tool.

Specified by:
getToolDescription in class CommandLineTool
Returns:
The description for this tool.

getToolVersion

public java.lang.String getToolVersion()
Retrieves the version string for this tool.

Overrides:
getToolVersion in class CommandLineTool
Returns:
The version string for this tool.

getMaxTrailingArguments

public int getMaxTrailingArguments()
Retrieves the maximum number of unnamed trailing arguments that may be provided for this tool.

Overrides:
getMaxTrailingArguments in class CommandLineTool
Returns:
The maximum number of unnamed trailing arguments that may be provided for this tool.

getTrailingArgumentsPlaceholder

public java.lang.String getTrailingArgumentsPlaceholder()
Retrieves a placeholder string that should be used for trailing arguments in the usage information for this tool.

Overrides:
getTrailingArgumentsPlaceholder in class CommandLineTool
Returns:
A placeholder string that should be used for trailing arguments in the usage information for this tool.

addToolArguments

public void addToolArguments(ArgumentParser parser)
                      throws ArgumentException
Adds the command-line arguments supported for use with this tool to the provided argument parser. The tool may need to retain references to the arguments (and/or the argument parser, if trailing arguments are allowed) to it in order to obtain their values for use in later processing.

Specified by:
addToolArguments in class CommandLineTool
Parameters:
parser - The argument parser to which the arguments are to be added.
Throws:
ArgumentException - If a problem occurs while adding any of the tool-specific arguments to the provided argument parser.

doExtendedArgumentValidation

public void doExtendedArgumentValidation()
                                  throws ArgumentException
Performs any necessary processing that should be done to ensure that the provided set of command-line arguments were valid. This method will be called after the basic argument parsing has been performed and immediately before the CommandLineTool.doToolProcessing() method is invoked.

Overrides:
doExtendedArgumentValidation in class CommandLineTool
Throws:
ArgumentException - If there was a problem with the command-line arguments provided to this program.

doToolProcessing

public ResultCode doToolProcessing()
Performs the core set of processing for this tool.

Specified by:
doToolProcessing in class CommandLineTool
Returns:
A result code that indicates whether the processing completed successfully.

getExampleUsages

public java.util.LinkedHashMap<java.lang.String[],java.lang.String> getExampleUsages()
Retrieves a set of information that may be used to generate example usage information. Each element in the returned map should consist of a map between an example set of arguments and a string that describes the behavior of the tool when invoked with that set of arguments.

Overrides:
getExampleUsages in class CommandLineTool
Returns:
A set of information that may be used to generate example usage information. It may be null or empty if no example usage information is available.