com.unboundid.ldap.sdk.examples

Class LDAPSearch

java.lang.Object

com.unboundid.util.CommandLineTool

com.unboundid.util.LDAPCommandLineTool

com.unboundid.ldap.sdk.examples.LDAPSearch

All Implemented Interfaces:

SearchResultListener, java.io.Serializable

@ThreadSafety(level=NOT_THREADSAFE)
public final class LDAPSearch
extends LDAPCommandLineTool
implements SearchResultListener

This class provides a simple tool that can be used to search an LDAP directory server. Some of the APIs demonstrated by this example include:

• Argument Parsing (from the com.unboundid.util.args package)
• LDAP Command-Line Tool (from the com.unboundid.util package)
• LDAP Communication (from the com.unboundid.ldap.sdk package)

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:

• "-b {baseDN}" or "--baseDN {baseDN}" -- specifies the base DN to use for the search. This must be provided.
• "-s {scope}" or "--scope {scope}" -- specifies the scope to use for the search. The scope value should be one of "base", "one", "sub", or "subord". If this isn't specified, then a scope of "sub" will be used.
• "-R" or "--followReferrals" -- indicates that the tool should follow any referrals encountered while searching.
• "-t" or "--terse" -- indicates that the tool should generate minimal output beyond the search results.
• "-i {millis}" or "--repeatIntervalMillis {millis}" -- indicates that the search should be periodically repeated with the specified delay (in milliseconds) between requests.
• "-n {count}" or "--numSearches {count}" -- specifies the total number of times that the search should be performed. This may only be used in conjunction with the "--repeatIntervalMillis" argument. If "--repeatIntervalMillis" is used without "--numSearches", then the searches will continue to be repeated until the tool is interrupted.
• "--bindControl {control}" -- specifies a control that should be included in the bind request sent by this tool before performing any search operations.
• "-J {control}" or "--control {control}" -- specifies a control that should be included in the search request(s) sent by this tool.

In addition, after the above named arguments are provided, a set of one or more unnamed trailing arguments must be given. The first argument should be the string representation of the filter to use for the search. If there are any additional trailing arguments, then they will be interpreted as the attributes to return in matching entries. If no attribute names are given, then the server should return all user attributes in matching entries.

Note that this class implements the SearchResultListener interface, which will be notified whenever a search result entry or reference is returned from the server. Whenever an entry is received, it will simply be printed displayed in LDIF.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LDAPSearch(java.io.OutputStream outStream, java.io.OutputStream errStream) Creates a new instance of this tool.

Method Summary

Modifier and Type	Method and Description
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.
void	searchEntryReturned(SearchResultEntry entry) Indicates that the provided search result entry was returned from the associated search operation.
void	searchReferenceReturned(SearchResultReference reference) Indicates that the provided search result reference was returned from the associated search operation.

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

LDAPSearch

public LDAPSearch(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 search.

Specified by:

doToolProcessing in class CommandLineTool

Returns:

The result code for the processing that was performed.

searchEntryReturned

public void searchEntryReturned(SearchResultEntry entry)

Indicates that the provided search result entry was returned from the associated search operation.

Specified by:

searchEntryReturned in interface SearchResultListener

Parameters:

entry - The entry that was returned from the search.

searchReferenceReturned

public void searchReferenceReturned(SearchResultReference reference)

Indicates that the provided search result reference was returned from the associated search operation.

Specified by:

searchReferenceReturned in interface SearchResultListener

Parameters:

reference - The reference that was returned from the search.

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.