|
|||||||||
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.LDAPSearch
@ThreadSafety(level=NOT_THREADSAFE) public final class LDAPSearch
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:
com.unboundid.util.args
package)com.unboundid.util
package)com.unboundid.ldap.sdk
package)LDAPCommandLineTool
class, as well as the following additional
arguments:
Constructor Summary | |
---|---|
LDAPSearch(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. |
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 |
---|
public LDAPSearch(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 int getMaxTrailingArguments()
getMaxTrailingArguments
in class CommandLineTool
public java.lang.String getTrailingArgumentsPlaceholder()
getTrailingArgumentsPlaceholder
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 java.util.List<Control> getBindControls()
getBindControls
in class LDAPCommandLineTool
null
or empty if no
controls should be included in the bind request.public ResultCode doToolProcessing()
doToolProcessing
in class CommandLineTool
public void searchEntryReturned(SearchResultEntry entry)
searchEntryReturned
in interface SearchResultListener
entry
- The entry that was returned from the search.public void searchReferenceReturned(SearchResultReference reference)
searchReferenceReturned
in interface SearchResultListener
reference
- The reference that was returned from the search.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 |