Package org.ldaptive

Class ModifyOperation

java.lang.Object

org.ldaptive.AbstractOperation<ModifyRequest,ModifyResponse>

org.ldaptive.ModifyOperation

All Implemented Interfaces:

Operation<ModifyRequest,ModifyResponse>

public class ModifyOperation
extends AbstractOperation<ModifyRequest,ModifyResponse>

Executes an ldap modify operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ModifyOperation.Builder	Modify operation builder.

Nested classes/interfaces inherited from class org.ldaptive.AbstractOperation

AbstractOperation.AbstractBuilder<B,T extends AbstractOperation>

Constructor Summary

Constructors

Constructor	Description
ModifyOperation()	Default constructor.
ModifyOperation(ConnectionFactory factory)	Creates a new modify operation.

Method Summary

Modifier and Type	Method	Description
static ModifyOperation.Builder	builder()	Creates a builder for this class.
static ModifyOperation	copy(ModifyOperation operation)	Returns a new modify operation with the same properties as the supplied operation.
static ModifyOperation	copy(ModifyOperation operation, boolean deep)	Returns a new modify operation with the same properties as the supplied operation.
static ModifyResponse	execute(ConnectionFactory factory, ModifyRequest request)	Executes a modify request.
ModifyResponse	execute(ModifyRequest request)	Executes a modify request.
static OperationHandle<ModifyRequest,ModifyResponse>	send(ConnectionFactory factory, ModifyRequest request)	Sends a modify request.
OperationHandle<ModifyRequest,ModifyResponse>	send(ModifyRequest request)	Sends a modify request.

Methods inherited from class org.ldaptive.AbstractOperation

configureHandle, configureRequest, copy, getConnectionFactory, getControlHandlers, getExceptionHandler, getIntermediateResponseHandlers, getReferralHandlers, getReferralResultHandler, getRequestHandlers, getResultHandlers, getThrowCondition, getUnsolicitedNotificationHandlers, setConnectionFactory, setControlHandlers, setExceptionHandler, setIntermediateResponseHandlers, setReferralHandlers, setReferralResultHandler, setRequestHandlers, setResultHandlers, setThrowCondition, setUnsolicitedNotificationHandlers, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ModifyOperation

public ModifyOperation()

Default constructor.

ModifyOperation

public ModifyOperation(ConnectionFactory factory)

Creates a new modify operation.

Parameters:

factory - connection factory

Method Detail

send

public OperationHandle<ModifyRequest,ModifyResponse> send(ModifyRequest request)
                                                         throws LdapException

Sends a modify request. See OperationHandle.send().

Parameters:

request - modify request

Returns:

operation handle

Throws:

LdapException - if the connection cannot be opened

send

public static OperationHandle<ModifyRequest,ModifyResponse> send(ConnectionFactory factory,
                                                                       ModifyRequest request)
                                                                throws LdapException

Sends a modify request. See OperationHandle.send().

Parameters:

factory - connection factory

request - modify request

Returns:

operation handle

Throws:

LdapException - if the connection cannot be opened

execute

public ModifyResponse execute(ModifyRequest request)
                       throws LdapException

Executes a modify request. See OperationHandle.execute().

Parameters:

request - modify request

Returns:

modify result

Throws:

LdapException - if the connection cannot be opened

execute

public static ModifyResponse execute(ConnectionFactory factory,
                                     ModifyRequest request)
                              throws LdapException

Executes a modify request. See OperationHandle.execute().

Parameters:

factory - connection factory

request - modify request

Returns:

modify result

Throws:

LdapException - if the connection cannot be opened

copy

public static ModifyOperation copy(ModifyOperation operation)

Returns a new modify operation with the same properties as the supplied operation.

Parameters:

operation - to copy

Returns:

copy of the supplied modify operation

copy

public static ModifyOperation copy(ModifyOperation operation,
                                   boolean deep)

Returns a new modify operation with the same properties as the supplied operation.

Parameters:

operation - to copy

deep - whether to make a deep copy

Returns:

copy of the supplied modify operation

builder

public static ModifyOperation.Builder builder()

Creates a builder for this class.

Returns:

new builder