Class SummarizeAccessLog
- java.lang.Object
-
- com.unboundid.util.CommandLineTool
-
- 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
This class provides a tool that may be used to read and summarize the contents of one or more access log files from Ping Identity, UnboundID and Nokia/Alcatel-Lucent 8661 server products.
NOTE: This class, and other classes within the
Information that will be reported includes:com.unboundid.ldap.sdk.unboundidds
package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.- The total length of time covered by the log files.
- The number of connections established and disconnected, the addresses of the most commonly-connecting clients, and the average rate of connects and disconnects per second.
- The number of operations processed, overall and by operation type, and the average rate of operations per second.
- The average duration for operations processed, overall and by operation type.
- A breakdown of operation processing times into a number of predefined categories (less than 1ms, between 1ms and 2ms, between 2ms and 3ms, between 3ms and 5ms, between 5ms and 10ms, between 10ms and 20ms, between 20ms and 30ms, between 30ms and 50ms, between 50ms and 100ms, between 100ms and 1000ms, and over 1000ms).
- A breakdown of the most common result codes for each type of operation and their relative frequencies.
- The most common types of extended requests processed and their relative frequencies.
- The number of unindexed search operations processed.
- A breakdown of the relative frequencies for each type of search scope.
- The most common types of search filters used for search operations and their relative frequencies.
The APIs demonstrated by this example include:- Access log parsing (from the
com.unboundid.ldap.sdk.unboundidds.logs
package) - Argument parsing (from the
com.unboundid.util.args
package)
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description SummarizeAccessLog(java.io.OutputStream outStream, java.io.OutputStream errStream)
Creates a new instance of this tool.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addToolArguments(ArgumentParser parser)
Adds the command-line arguments supported for use with this tool to the provided argument parser.boolean
defaultsToInteractiveMode()
Indicates whether this tool defaults to launching in interactive mode if the tool is invoked without any command-line arguments.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.int
getMinTrailingArguments()
Retrieves the minimum number of unnamed trailing arguments that are required.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.boolean
supportsInteractiveMode()
Indicates whether this tool should provide support for an interactive mode, in which the tool offers a mode in which the arguments can be provided in a text-driven menu rather than requiring them to be given on the command line.protected boolean
supportsOutputFile()
Indicates whether this tool should provide arguments for redirecting output to a file.boolean
supportsPropertiesFile()
Indicates whether this tool supports the use of a properties file for specifying default values for arguments that aren't specified on the command line.-
Methods inherited from class com.unboundid.util.CommandLineTool
addEnableSSLDebuggingArgument, createArgumentParser, doShutdownHookProcessing, err, getAdditionalDescriptionParagraphs, getErr, getOriginalErr, getOriginalOut, getOut, getPasswordFileReader, getToolCompletionMessage, logToolInvocationByDefault, out, registerShutdownHook, requestToolArgumentsInteractively, runTool, wrapErr, wrapOut
-
-
-
-
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 benull
if output should be suppressed.errStream
- The output stream to which standard error should be written. It may benull
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 benull
if output should be suppressed.errStream
- The output stream to which standard error should be written. It may benull
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 classCommandLineTool
- Returns:
- The name for this tool.
-
getToolDescription
public java.lang.String getToolDescription()
Retrieves the description for this tool.- Specified by:
getToolDescription
in classCommandLineTool
- Returns:
- The description for this tool.
-
getToolVersion
public java.lang.String getToolVersion()
Retrieves the version string for this tool.- Overrides:
getToolVersion
in classCommandLineTool
- Returns:
- The version string for this tool.
-
getMinTrailingArguments
public int getMinTrailingArguments()
Retrieves the minimum number of unnamed trailing arguments that are required.- Overrides:
getMinTrailingArguments
in classCommandLineTool
- Returns:
- One, to indicate that at least one trailing argument (representing the path to an access log file) must be provided.
-
getMaxTrailingArguments
public int getMaxTrailingArguments()
Retrieves the maximum number of unnamed trailing arguments that may be provided for this tool.- Overrides:
getMaxTrailingArguments
in classCommandLineTool
- 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 classCommandLineTool
- Returns:
- A placeholder string that should be used for trailing arguments in the usage information for this tool.
-
supportsInteractiveMode
public boolean supportsInteractiveMode()
Indicates whether this tool should provide support for an interactive mode, in which the tool offers a mode in which the arguments can be provided in a text-driven menu rather than requiring them to be given on the command line. If interactive mode is supported, it may be invoked using the "--interactive" argument. Alternately, if interactive mode is supported anddefaultsToInteractiveMode()
returnstrue
, then interactive mode may be invoked by simply launching the tool without any arguments.- Overrides:
supportsInteractiveMode
in classCommandLineTool
- Returns:
true
if this tool supports interactive mode, orfalse
if not.
-
defaultsToInteractiveMode
public boolean defaultsToInteractiveMode()
Indicates whether this tool defaults to launching in interactive mode if the tool is invoked without any command-line arguments. This will only be used ifsupportsInteractiveMode()
returnstrue
.- Overrides:
defaultsToInteractiveMode
in classCommandLineTool
- Returns:
true
if this tool defaults to using interactive mode if launched without any command-line arguments, orfalse
if not.
-
supportsOutputFile
protected boolean supportsOutputFile()
Indicates whether this tool should provide arguments for redirecting output to a file. If this method returnstrue
, then the tool will offer an "--outputFile" argument that will specify the path to a file to which all standard output and standard error content will be written, and it will also offer a "--teeToStandardOut" argument that can only be used if the "--outputFile" argument is present and will cause all output to be written to both the specified output file and to standard output.- Overrides:
supportsOutputFile
in classCommandLineTool
- Returns:
true
if this tool should provide arguments for redirecting output to a file, orfalse
if not.
-
supportsPropertiesFile
public boolean supportsPropertiesFile()
Indicates whether this tool supports the use of a properties file for specifying default values for arguments that aren't specified on the command line.- Overrides:
supportsPropertiesFile
in classCommandLineTool
- Returns:
true
if this tool supports the use of a properties file for specifying default values for arguments that aren't specified on the command line, orfalse
if not.
-
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 classCommandLineTool
- 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 theCommandLineTool.doToolProcessing()
method is invoked.- Overrides:
doExtendedArgumentValidation
in classCommandLineTool
- 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 classCommandLineTool
- 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 classCommandLineTool
- 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.
-
-