com.unboundid.ldap.sdk.examples

Class LDAPModify

java.lang.Object

com.unboundid.util.CommandLineTool

com.unboundid.util.LDAPCommandLineTool

com.unboundid.ldap.sdk.examples.LDAPModify

All Implemented Interfaces:

java.io.Serializable

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

This class provides a simple tool that can be used to perform add, delete, modify, and modify DN operations against an LDAP directory server. The changes to apply can be read either from standard input or from an LDIF file.

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)
• LDIF Processing (from the com.unboundid.ldif package)

The behavior of this utility is controlled by command line arguments. Supported arguments include those allowed by the LDAPCommandLineTool class, as well as the following additional arguments:

• "-f {path}" or "--ldifFile {path}" -- specifies the path to the LDIF file containing the changes to apply. If this is not provided, then changes will be read from standard input.
• "-a" or "--defaultAdd" -- indicates that any LDIF records encountered that do not include a changetype should be treated as add change records. If this is not provided, then such records will be rejected.
• "-c" or "--continueOnError" -- indicates that processing should continue if an error occurs while processing an earlier change. If this is not provided, then the command will exit on the first error that occurs.
• "--bindControl {control}" -- specifies a control that should be included in the bind request sent by this tool before performing any update operations.

See Also:

LDAPModify, Serialized Form

Constructor Summary

Constructors

Constructor and Description
LDAPModify(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.
boolean	defaultsToInteractiveMode() Indicates whether this tool defaults to launching in interactive mode if the tool is invoked without any command-line arguments.
protected boolean	defaultToPromptForBindPassword() Indicates whether this tool should default to interactively prompting for the bind password if a password is required but no argument was provided to indicate how to get the password.
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.
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.
protected boolean	includeAlternateLongIdentifiers() Indicates whether the LDAP-specific arguments should include alternate versions of all long identifiers that consist of multiple words so that they are available in both camelCase and dash-separated versions.
protected boolean	logToolInvocationByDefault() Indicates whether to log messages about the launch and completion of this tool into the invocation log of Ping Identity server products that may include it.
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.
boolean	supportsInteractiveMode() Indicates whether this tool should provide support for an interactive mode, in which the tool offers a mode in which the arguments can be provided in a text-driven menu rather than requiring them to be given on the command line.
protected boolean	supportsOutputFile() Indicates whether this tool should provide arguments for redirecting output to a file.
boolean	supportsPropertiesFile() Indicates whether this tool supports the use of a properties file for specifying default values for arguments that aren't specified on the command line.
protected boolean	supportsSSLDebugging() Indicates whether this tool should provide a command-line argument that allows for low-level SSL debugging.

Methods inherited from class com.unboundid.util.LDAPCommandLineTool

addToolArguments, anyLDAPArgumentsProvided, createBindRequest, createServerSet, createSSLUtil, createSSLUtil, doExtendedArgumentValidation, doExtendedNonLDAPArgumentValidation, getConnection, getConnectionOptions, getConnectionOptionsWithRequestedSettings, getConnectionPool, getConnectionPool, getSuppressedShortIdentifiers, getUnauthenticatedConnection, supportsAuthentication, supportsMultipleServers, supportsSASLHelp

Methods inherited from class com.unboundid.util.CommandLineTool

addEnableSSLDebuggingArgument, createArgumentParser, doShutdownHookProcessing, err, getAdditionalDescriptionParagraphs, getErr, getMaxTrailingArguments, getMinTrailingArguments, getOriginalErr, getOriginalOut, getOut, getPasswordFileReader, getToolCompletionMessage, getTrailingArgumentsPlaceholder, out, registerShutdownHook, requestToolArgumentsInteractively, runTool, wrapErr, wrapOut

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LDAPModify

public LDAPModify(@Nullable
                  java.io.OutputStream outStream,
                  @Nullable
                  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(@NotNull
                        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

@NotNull
public static ResultCode main(@NotNull
                                       java.lang.String[] args,
                                       @Nullable
                                       java.io.OutputStream outStream,
                                       @Nullable
                                       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

@NotNull
public java.lang.String getToolName()

Retrieves the name for this tool.

Specified by:

getToolName in class CommandLineTool

Returns:

The name for this tool.

getToolDescription

@NotNull
public java.lang.String getToolDescription()

Retrieves the description for this tool.

Specified by:

getToolDescription in class CommandLineTool

Returns:

The description for this tool.

getToolVersion

@NotNull
public java.lang.String getToolVersion()

Retrieves the version string for this tool.

Overrides:

getToolVersion in class CommandLineTool

Returns:

The version string for this tool.

supportsInteractiveMode

public boolean supportsInteractiveMode()

Indicates whether this tool should provide support for an interactive mode, in which the tool offers a mode in which the arguments can be provided in a text-driven menu rather than requiring them to be given on the command line. If interactive mode is supported, it may be invoked using the "--interactive" argument. Alternately, if interactive mode is supported and defaultsToInteractiveMode() returns true, then interactive mode may be invoked by simply launching the tool without any arguments.

Overrides:

supportsInteractiveMode in class CommandLineTool

Returns:

true if this tool supports interactive mode, or false if not.

defaultsToInteractiveMode

public boolean defaultsToInteractiveMode()

Indicates whether this tool defaults to launching in interactive mode if the tool is invoked without any command-line arguments. This will only be used if supportsInteractiveMode() returns true.

Overrides:

defaultsToInteractiveMode in class CommandLineTool

Returns:

true if this tool defaults to using interactive mode if launched without any command-line arguments, or false if not.

supportsOutputFile

protected boolean supportsOutputFile()

Indicates whether this tool should provide arguments for redirecting output to a file. If this method returns true, then the tool will offer an "--outputFile" argument that will specify the path to a file to which all standard output and standard error content will be written, and it will also offer a "--teeToStandardOut" argument that can only be used if the "--outputFile" argument is present and will cause all output to be written to both the specified output file and to standard output.

Overrides:

supportsOutputFile in class CommandLineTool

Returns:

true if this tool should provide arguments for redirecting output to a file, or false if not.

defaultToPromptForBindPassword

protected boolean defaultToPromptForBindPassword()

Indicates whether this tool should default to interactively prompting for the bind password if a password is required but no argument was provided to indicate how to get the password.

Overrides:

defaultToPromptForBindPassword in class LDAPCommandLineTool

Returns:

true if this tool should default to interactively prompting for the bind password, or false if not.

supportsPropertiesFile

public boolean supportsPropertiesFile()

Indicates whether this tool supports the use of a properties file for specifying default values for arguments that aren't specified on the command line.

Overrides:

supportsPropertiesFile in class CommandLineTool

Returns:

true if this tool supports the use of a properties file for specifying default values for arguments that aren't specified on the command line, or false if not.

includeAlternateLongIdentifiers

protected boolean includeAlternateLongIdentifiers()

Indicates whether the LDAP-specific arguments should include alternate versions of all long identifiers that consist of multiple words so that they are available in both camelCase and dash-separated versions.

Overrides:

includeAlternateLongIdentifiers in class LDAPCommandLineTool

Returns:

true if this tool should provide multiple versions of long identifiers for LDAP-specific arguments, or false if not.

supportsSSLDebugging

protected boolean supportsSSLDebugging()

Indicates whether this tool should provide a command-line argument that allows for low-level SSL debugging. If this returns true, then an "--enableSSLDebugging}" argument will be added that sets the "javax.net.debug" system property to "all" before attempting any communication.

Overrides:

supportsSSLDebugging in class LDAPCommandLineTool

Returns:

true if this tool should offer an "--enableSSLDebugging" argument, or false if not.

logToolInvocationByDefault

protected boolean logToolInvocationByDefault()

Indicates whether to log messages about the launch and completion of this tool into the invocation log of Ping Identity server products that may include it. This method is not needed for tools that are not expected to be part of the Ping Identity server products suite. Further, this value may be overridden by settings in the server's tool-invocation-logging.properties file.

This method should generally return true for tools that may alter the server configuration, data, or other state information, and false for tools that do not make any changes.

Overrides:

logToolInvocationByDefault in class CommandLineTool

Returns:

true if Ping Identity server products should include messages about the launch and completion of this tool in tool invocation log files by default, or false if not.

addNonLDAPArguments

public void addNonLDAPArguments(@NotNull
                                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

@NotNull
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

@NotNull
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 operations.

Specified by:

doToolProcessing in class CommandLineTool

Returns:

The result code for the processing that was performed.

getExampleUsages

@NotNull
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.