com.unboundid.ldap.sdk.examples
Class LDAPCompare

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

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

This class provides a simple tool that can be used to perform compare operations in an LDAP directory server. All of the necessary information is provided using command line arguments. Supported arguments include those allowed by the LDAPCommandLineTool class. In addition, a set of at least two unnamed trailing arguments must be given. The first argument should be a string containing the name of the target attribute followed by a colon and the assertion value to use for that attribute (e.g., "cn:john doe"). Alternately, the attribute name may be followed by two colons and the base64-encoded representation of the assertion value (e.g., "cn:: am9obiBkb2U="). Any subsequent trailing arguments will be the DN(s) of entries in which to perform the compare operation(s).

Some of the APIs demonstrated by this example include:

See Also:
Serialized Form

Constructor Summary
LDAPCompare(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.
protected  java.util.List<Control> getBindControls()
          Retrieves a set of controls that should be included in any bind request generated 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.
 int getMaxTrailingArguments()
          Retrieves the maximum number of unnamed trailing arguments that are allowed.
 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 may be used to indicate what kinds of trailing arguments are allowed.
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.
 
Methods inherited from class com.unboundid.util.LDAPCommandLineTool
addToolArguments, createBindRequest, createServerSet, createSSLUtil, createSSLUtil, doExtendedArgumentValidation, doExtendedNonLDAPArgumentValidation, getConnection, getConnectionOptions, getConnectionPool, getUnauthenticatedConnection, supportsAuthentication, supportsMultipleServers
 
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

LDAPCompare

public LDAPCompare(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.

getMaxTrailingArguments

public int getMaxTrailingArguments()
Retrieves the maximum number of unnamed trailing arguments that are allowed.

Overrides:
getMaxTrailingArguments in class CommandLineTool
Returns:
A negative value to indicate that any number of trailing arguments may be provided.

getTrailingArgumentsPlaceholder

public java.lang.String getTrailingArgumentsPlaceholder()
Retrieves a placeholder string that may be used to indicate what kinds of trailing arguments are allowed.

Overrides:
getTrailingArgumentsPlaceholder in class CommandLineTool
Returns:
A placeholder string that may be used to indicate what kinds of trailing arguments are allowed.

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.

getBindControls

protected java.util.List<Control> getBindControls()
Retrieves a set of controls that should be included in any bind request generated by this tool.

Overrides:
getBindControls in class LDAPCommandLineTool
Returns:
A set of controls that should be included in any bind request generated by this tool. It may be null or empty if no controls should be included in the bind request.

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 comparisons.

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

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.