com.unboundid.ldap.sdk.examples
Class ModRate

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

@ThreadSafety(level=NOT_THREADSAFE)
public final class ModRate
extends LDAPCommandLineTool
implements java.io.Serializable

This class provides a tool that can be used to perform repeated modifications in an LDAP directory server using multiple threads. It can help provide an estimate of the modify performance that a directory server is able to achieve. The target entry DN may be a value pattern as described in the ValuePattern class. This makes it possible to modify a range of entries rather than repeatedly updating the same entry.

Some of the APIs demonstrated by this example include:



All of the necessary information is provided using command line arguments. Supported arguments include those allowed by the LDAPCommandLineTool class, as well as the following additional arguments:

See Also:
Serialized Form

Constructor Summary
ModRate(java.io.OutputStream outStream, java.io.OutputStream errStream)
          Creates a new instance of this tool.
 
Method Summary
 void addNonLDAPArguments(ArgumentParser parser)
          Adds the arguments used by this program that aren't already provided by the generic LDAPCommandLineTool framework.
 ResultCode doToolProcessing()
          Performs the actual processing for this tool.
 LDAPConnectionOptions getConnectionOptions()
          Retrieves the connection options that should be used for connections created for use with 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 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.
static void main(java.lang.String[] args)
          Parse the provided command line arguments and make the appropriate set of changes.
static ResultCode main(java.lang.String[] args, java.io.OutputStream outStream, java.io.OutputStream errStream)
          Parse the provided command line arguments and make the appropriate set of changes.
 void stopRunning()
          Requests that this tool stop running.
protected  boolean supportsMultipleServers()
          Indicates whether this tool supports creating connections to multiple servers.
 
Methods inherited from class com.unboundid.util.LDAPCommandLineTool
addToolArguments, createBindRequest, createServerSet, createSSLUtil, createSSLUtil, doExtendedArgumentValidation, doExtendedNonLDAPArgumentValidation, getBindControls, getConnection, getConnectionPool, getUnauthenticatedConnection, supportsAuthentication
 
Methods inherited from class com.unboundid.util.CommandLineTool
createArgumentParser, doShutdownHookProcessing, err, getErr, getMaxTrailingArguments, getOut, getTrailingArgumentsPlaceholder, 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

ModRate

public ModRate(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 make the appropriate set of changes.

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 make the appropriate set of changes.

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.

addNonLDAPArguments

public void addNonLDAPArguments(ArgumentParser parser)
                         throws ArgumentException
Adds the arguments used by this program that aren't already provided by the generic LDAPCommandLineTool framework.

Specified by:
addNonLDAPArguments in class LDAPCommandLineTool
Parameters:
parser - The argument parser to which the arguments should be added.
Throws:
ArgumentException - If a problem occurs while adding the arguments.

supportsMultipleServers

protected boolean supportsMultipleServers()
Indicates whether this tool supports creating connections to multiple servers. If it is to support multiple servers, then the "--hostname" and "--port" arguments will be allowed to be provided multiple times, and will be required to be provided the same number of times. The same type of communication security and bind credentials will be used for all servers.

Overrides:
supportsMultipleServers in class LDAPCommandLineTool
Returns:
true if this tool supports creating connections to multiple servers, or false if not.

getConnectionOptions

public LDAPConnectionOptions getConnectionOptions()
Retrieves the connection options that should be used for connections created for use with this tool.

Overrides:
getConnectionOptions in class LDAPCommandLineTool
Returns:
The connection options that should be used for connections created for use with this tool.

doToolProcessing

public ResultCode doToolProcessing()
Performs the actual processing for this tool. In this case, it gets a connection to the directory server and uses it to perform the requested modifications.

Specified by:
doToolProcessing in class CommandLineTool
Returns:
The result code for the processing that was performed.

stopRunning

public void stopRunning()
Requests that this tool stop running. This method will attempt to wait for all threads to complete before returning control to the caller.


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.