Class Launcher
- java.lang.Object
-
- com.unboundid.ldap.sdk.unboundidds.Launcher
-
@ThreadSafety(level=COMPLETELY_THREADSAFE) public final class Launcher extends java.lang.Object
This class provides an entry point that may be used to launch other tools provided as part of the LDAP SDK. This is primarily a convenience for someone who just has the jar file and none of the scripts, since you can run "java -jar unboundid-ldapsdk.jar {tool-name} {tool-args}
" in order to invoke any of the example tools. Running just "java -jar unboundid-ldapsdk.jar
" will display version information about the LDAP SDK.
NOTE: This class, and other classes within the
com.unboundid.ldap.sdk.unboundidds
package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.
The tool names are case-insensitive. Supported tool names include:- authrate -- Launch the
AuthRate
tool. - base64 -- Launch the
Base64Tool
tool. - collect-support-data -- Launch the
CollectSupportData
tool. - compare-ldap-schemas -- Launch the
CompareLDAPSchemas
tool. - deliver-one-time-password -- Launch the
DeliverOneTimePassword
tool. - deliver-password-reset-token -- Launch the
DeliverPasswordResetToken
tool. - dump-dns -- Launch the
DumpDNs
tool. - generate-schema-from-source -- Launch the
GenerateSchemaFromSource
tool. - generate-source-from-schema -- Launch the
GenerateSourceFromSchema
tool. - generate-totp-shared-secret -- Launch the
GenerateTOTPSharedSecret
tool. - identify-references-to-missing-entries -- Launch the
IdentifyReferencesToMissingEntries
tool. - identify-unique-attribute-conflicts -- Launch the
IdentifyUniqueAttributeConflicts
tool. - indent-ldap-filter -- Launch the
IndentLDAPFilter
tool. - in-memory-directory-server -- Launch the
InMemoryDirectoryServerTool
tool. - ldapcompare -- Launch the
LDAPCompare
tool. - ldapdelete -- Launch the
LDAPDelete
tool. - ldapmodify -- Launch the
LDAPModify
tool. - ldappasswordmodify -- Launch the
LDAPPasswordModify
tool. - ldapsearch -- Launch the
LDAPSearch
tool. - ldap-debugger -- Launch the
LDAPDebugger
tool. - ldap-diff -- Launch the
LDAPDiff
tool. - ldap-result-code -- Launch the
LDAPResultCode
tool. - ldifmodify -- Launch the
LDIFModify
tool. - ldifsearch -- Launch the
LDIFSearch
tool. - ldif-diff -- Launch the
LDIFDiff
tool. - manage-account -- Launch the
ManageAccount
tool. - manage-certificates -- Launch the
ManageCertificates
tool. - modrate -- Launch the
ModRate
tool. - move-subtree -- Launch the
MoveSubtree
tool. - oid-lookup -- Launch the
OIDLookup
tool. - parallel-update -- Launch the
ParallelUpdate
tool. - register-yubikey-otp-device -- Launch the
RegisterYubiKeyOTPDevice
tool. - searchrate -- Launch the
SearchRate
tool. - search-and-mod-rate -- Launch the
SearchAndModRate
tool. - split-ldif -- Launch the
SplitLDIF
tool. - subtree-accessibility -- Launch the
SubtreeAccessibility
tool. - summarize-access-log -- Launch the
SummarizeAccessLog
tool. - test-ldap-sdk-performance -- Launch the
TLSCipherSuiteSelector
tool. - tls-cipher-suite-selector -- Launch the
TLSCipherSuiteSelector
tool. - transform-ldif -- Launch the
TransformLDIF
tool. - validate-ldap-schema -- Launch the
ValidateLDAPSchema
tool. - validate-ldif -- Launch the
ValidateLDIF
tool. - version -- Display version information for the LDAP SDK.
- authrate -- Launch the
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static java.util.List<java.lang.Class<? extends CommandLineTool>>
getToolClasses()
Retrieves a list of all of the classes that provide the implementations for all of the command-line tools included with the LDAP SDK.static CommandLineTool
getToolInstance(java.lang.Class<?> toolClass, java.io.OutputStream outStream, java.io.OutputStream errStream)
Retrieves an instance of the specified type of command-line tool with the given output and error streams.static ResultCode
main(java.io.OutputStream outStream, java.io.OutputStream errStream, java.lang.String... args)
Parses the command-line arguments and performs any appropriate processing for this program.static void
main(java.lang.String... args)
Parses the command-line arguments and performs any appropriate processing for this program.
-
-
-
Method Detail
-
main
public static void main(@NotNull java.lang.String... args)
Parses the command-line arguments and performs any appropriate processing for this program.- Parameters:
args
- The command-line arguments provided to this program.
-
main
@NotNull public static ResultCode main(@Nullable java.io.OutputStream outStream, @Nullable java.io.OutputStream errStream, @NotNull java.lang.String... args)
Parses the command-line arguments and performs any appropriate processing for this program.- Parameters:
outStream
- The output stream to which standard out should be written. It may benull
if output should be suppressed.errStream
- The output stream to which standard error should be written. It may benull
if error messages should be suppressed.args
- The command-line arguments provided to this program.- Returns:
- A result code with information about the status of processing.
-
getToolClasses
@NotNull public static java.util.List<java.lang.Class<? extends CommandLineTool>> getToolClasses()
Retrieves a list of all of the classes that provide the implementations for all of the command-line tools included with the LDAP SDK.- Returns:
- A list of all of the classes that provide the implementations for all of the command-line tools included with the LDAP SDK.
-
getToolInstance
@NotNull public static CommandLineTool getToolInstance(@NotNull java.lang.Class<?> toolClass, @Nullable java.io.OutputStream outStream, @Nullable java.io.OutputStream errStream) throws LDAPException
Retrieves an instance of the specified type of command-line tool with the given output and error streams. The tool class must provide a two-argument constructor in which the first argument is a possibly-null
OutputStream
to use for standard output, and the second argument is a possibly-null
OutputStream
to use for standard error.- Parameters:
toolClass
- The class that provides the implementation for the desired command-line tool.outStream
- The output stream to which standard out should be written. It may benull
if output should be suppressed.errStream
- The output stream to which standard error should be written. It may benull
if error messages should be suppressed.- Returns:
- An instance of the specified command-line tool.
- Throws:
LDAPException
- If a problem occurs while attempting to create an instance of the requested tool.
-
-