@NotMutable @ThreadSafety(level=NOT_THREADSAFE) public final class InMemoryDirectoryServerTool extends CommandLineTool implements java.io.Serializable, LDAPListenerExceptionHandler
InMemoryDirectoryServer
class.
Constructor and Description |
---|
InMemoryDirectoryServerTool(java.io.OutputStream outStream,
java.io.OutputStream errStream)
Creates a new instance of this tool that use the provided output streams
for standard output and standard error.
|
Modifier and Type | Method and Description |
---|---|
void |
addToolArguments(ArgumentParser parser)
Adds the command-line arguments supported for use with this tool to the
provided argument parser.
|
void |
connectionCreationFailure(java.net.Socket socket,
java.lang.Throwable cause)
Indicates that the specified connection is about to be terminated because
an unexpected error occurred during processing.
|
void |
connectionTerminated(LDAPListenerClientConnection connection,
LDAPException cause)
Indicates that the specified connection is about to be terminated because
an unexpected error occurred during processing.
|
ResultCode |
doToolProcessing()
Performs the core set of processing for this tool.
|
InMemoryDirectoryServer |
getDirectoryServer()
Retrieves the in-memory directory server instance that has been created by
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.
|
java.lang.String |
getToolDescription()
Retrieves a human-readable description for this tool.
|
java.lang.String |
getToolName()
Retrieves the name of this tool.
|
java.lang.String |
getToolVersion()
Retrieves the version string for this tool.
|
static void |
main(java.lang.String... args)
Parse the provided command line arguments and uses them to start the
directory server.
|
static ResultCode |
main(java.lang.String[] args,
java.io.OutputStream outStream,
java.io.OutputStream errStream)
Parse the provided command line arguments and uses them to start the
directory server.
|
createArgumentParser, doExtendedArgumentValidation, doShutdownHookProcessing, err, getErr, getMaxTrailingArguments, getOut, getTrailingArgumentsPlaceholder, out, registerShutdownHook, runTool, wrapErr, wrapOut
public InMemoryDirectoryServerTool(java.io.OutputStream outStream, java.io.OutputStream errStream)
outStream
- The output stream to use for standard output. It may be
System.out
for the JVM's default standard output
stream, null
if no output should be generated,
or a custom output stream if the output should be sent
to an alternate location.errStream
- The output stream to use for standard error. It may be
System.err
for the JVM's default standard error
stream, null
if no output should be generated,
or a custom output stream if the output should be sent
to an alternate location.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)
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.args
- The command line arguments provided to this program.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 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 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.public InMemoryDirectoryServer getDirectoryServer()
doToolProcessing()
method has been called.null
if the directory server instance has
not been successfully created.public void connectionCreationFailure(java.net.Socket socket, java.lang.Throwable cause)
connectionCreationFailure
in interface LDAPListenerExceptionHandler
socket
- The socket to be used for the failed connection. It may be
null
if the failure occurred while attempting to
accept the socket rather than attempting to create the
client connection from an accepted socket.cause
- An exception providing additional information about the
problem that occurred. It will not be null
.public void connectionTerminated(LDAPListenerClientConnection connection, LDAPException cause)
connectionTerminated
in interface LDAPListenerExceptionHandler
connection
- The connection that will be terminated. It will not be
null
.cause
- An exception providing additional information about the
reason for the termination. It will not be
null
.