org.opends.server.tools
Class LDAPModify

java.lang.Object
  org.opends.server.tools.LDAPModify

public class LDAPModify
extends java.lang.Object

This class provides a tool that can be used to issue modify requests to the Directory Server.

Constructor Summary

LDAPModify(java.lang.String fileName, java.util.concurrent.atomic.AtomicInteger nextMessageID, java.io.PrintStream out, java.io.PrintStream err)
Constructor for the LDAPModify object.

Method Summary

static void	main(java.lang.String[] args) The main method for LDAPModify tool.
static int	mainModify(java.lang.String[] args) Parses the provided command-line arguments and uses that information to run the ldapmodify tool.
static int	mainModify(java.lang.String[] args, boolean initializeServer, java.io.OutputStream outStream, java.io.OutputStream errStream) Parses the provided command-line arguments and uses that information to run the ldapmodify tool.
void	readAndExecute(LDAPConnection connection, java.lang.String fileNameValue, LDAPModifyOptions modifyOptions) Read the specified change records from the given input stream (file or stdin) and execute the given modify request.

Methods inherited from class java.lang.Object

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

Constructor Detail

LDAPModify

public LDAPModify(java.lang.String fileName,
                  java.util.concurrent.atomic.AtomicInteger nextMessageID,
                  java.io.PrintStream out,
                  java.io.PrintStream err)

Constructor for the LDAPModify object.

Parameters:

fileName - The name of the file containing the LDIF data to use for the modifications.

nextMessageID - The message ID counter to use for requests.

out - The print stream to use for standard output.

err - The print stream to use for standard error.

Method Detail

readAndExecute

public void readAndExecute(LDAPConnection connection,
                           java.lang.String fileNameValue,
                           LDAPModifyOptions modifyOptions)
                    throws java.io.IOException,
                           LDAPException

Read the specified change records from the given input stream (file or stdin) and execute the given modify request.

Parameters:

connection - The connection to use for this modify request.

fileNameValue - Name of the file from which to read. If null, input will be read from System.in.

modifyOptions - The constraints for the modify request.

Throws:

java.io.IOException - If a problem occurs while attempting to communicate with the Directory Server.

LDAPException - If the Directory Server returns an error response.

main

public static void main(java.lang.String[] args)

The main method for LDAPModify tool.

Parameters:

args - The command-line arguments provided to this program.

mainModify

public static int mainModify(java.lang.String[] args)

Parses the provided command-line arguments and uses that information to run the ldapmodify tool.

Parameters:

args - The command-line arguments provided to this program.

Returns:

The error code.

mainModify

public static int mainModify(java.lang.String[] args,
                             boolean initializeServer,
                             java.io.OutputStream outStream,
                             java.io.OutputStream errStream)

Parses the provided command-line arguments and uses that information to run the ldapmodify tool.

Parameters:

args - The command-line arguments provided to this program.

initializeServer - Indicates whether to initialize the server.

outStream - The output stream to use for standard output, or null if standard output is not needed.

errStream - The output stream to use for standard error, or null if standard error is not needed.

Returns:

The error code.