|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.util.CommandLineTool
com.unboundid.ldap.sdk.unboundidds.examples.SummarizeAccessLog
@NotMutable @ThreadSafety(level=NOT_THREADSAFE) public final class SummarizeAccessLog
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:
com.unboundid.ldap.sdk.unboundidds.logs
package)com.unboundid.util.args
package)
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 |
---|
public SummarizeAccessLog(java.io.OutputStream outStream, java.io.OutputStream errStream)
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 |
---|
public static void main(java.lang.String[] args)
args
- The command line arguments provided to this program.public static ResultCode main(java.lang.String[] args, java.io.OutputStream outStream, java.io.OutputStream errStream)
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.
public java.lang.String getToolName()
getToolName
in class CommandLineTool
public java.lang.String getToolDescription()
getToolDescription
in class CommandLineTool
public java.lang.String getToolVersion()
getToolVersion
in class CommandLineTool
public int getMaxTrailingArguments()
getMaxTrailingArguments
in class CommandLineTool
public java.lang.String getTrailingArgumentsPlaceholder()
getTrailingArgumentsPlaceholder
in class CommandLineTool
public void addToolArguments(ArgumentParser parser) throws ArgumentException
addToolArguments
in class CommandLineTool
parser
- The argument parser to which the arguments are to be added.
ArgumentException
- If a problem occurs while adding any of the
tool-specific arguments to the provided
argument parser.public void doExtendedArgumentValidation() throws ArgumentException
CommandLineTool.doToolProcessing()
method is invoked.
doExtendedArgumentValidation
in class CommandLineTool
ArgumentException
- If there was a problem with the command-line
arguments provided to this program.public ResultCode doToolProcessing()
doToolProcessing
in class CommandLineTool
public java.util.LinkedHashMap<java.lang.String[],java.lang.String> getExampleUsages()
getExampleUsages
in class CommandLineTool
null
or empty if no example usage
information is available.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |