|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.util.CommandLineTool
com.unboundid.util.LDAPCommandLineTool
com.unboundid.ldap.sdk.examples.AuthRate
@ThreadSafety(level=NOT_THREADSAFE) public final class AuthRate
This class provides a tool that can be used to test authentication processing
in an LDAP directory server using multiple threads. Each authentication will
consist of two operations: a search to find the target entry followed by a
bind to verify the credentials for that user. The search will use the given
base DN and filter, either or both of which may be a value pattern as
described in the ValuePattern
class. This makes it possible to
search over a range of entries rather than repeatedly performing searches
with the same base DN and filter.
Some of the APIs demonstrated by this example include:
com.unboundid.util.args
package)com.unboundid.util
package)com.unboundid.ldap.sdk
package)com.unboundid.util
package)LDAPCommandLineTool
class, as well as the following additional arguments:
Constructor Summary | |
---|---|
AuthRate(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 |
---|
public AuthRate(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 void addNonLDAPArguments(ArgumentParser parser) throws ArgumentException
LDAPCommandLineTool
framework.
addNonLDAPArguments
in class LDAPCommandLineTool
parser
- The argument parser to which the arguments should be added.
ArgumentException
- If a problem occurs while adding the arguments.protected boolean supportsMultipleServers()
supportsMultipleServers
in class LDAPCommandLineTool
true
if this tool supports creating connections to
multiple servers, or false
if not.public LDAPConnectionOptions getConnectionOptions()
getConnectionOptions
in class LDAPCommandLineTool
public ResultCode doToolProcessing()
doToolProcessing
in class CommandLineTool
public void stopRunning()
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 |