Package org.ldaptive

Class ModifyDnOperation

java.lang.Object

org.ldaptive.AbstractOperation<ModifyDnRequest,ModifyDnResponse>

org.ldaptive.ModifyDnOperation

All Implemented Interfaces:

Operation<ModifyDnRequest,ModifyDnResponse>

public class ModifyDnOperation
extends AbstractOperation<ModifyDnRequest,ModifyDnResponse>

Executes an ldap modify DN operation.

Nested Class Summary

Nested Classes

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

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

AbstractOperation.AbstractBuilder<B,T extends AbstractOperation>

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static ModifyDnOperation.Builder	builder()	Creates a builder for this class.
static ModifyDnOperation	copy(ModifyDnOperation operation)	Returns a new modify dn operation with the same properties as the supplied operation.
static ModifyDnOperation	copy(ModifyDnOperation operation, boolean deep)	Returns a new modify dn operation with the same properties as the supplied operation.
static ModifyDnResponse	execute(ConnectionFactory factory, ModifyDnRequest request)	Executes a modify DN request.
ModifyDnResponse	execute(ModifyDnRequest request)	Executes a modify DN request.
static OperationHandle<ModifyDnRequest,ModifyDnResponse>	send(ConnectionFactory factory, ModifyDnRequest request)	Sends a modify DN request.
OperationHandle<ModifyDnRequest,ModifyDnResponse>	send(ModifyDnRequest request)	Sends a modify DN 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 Details

ModifyDnOperation

public ModifyDnOperation()

Default constructor.

ModifyDnOperation

public ModifyDnOperation(ConnectionFactory factory)

Creates a new modify DN operation.

Parameters:

factory - connection factory

Method Details

send

public OperationHandle<ModifyDnRequest,ModifyDnResponse> send(ModifyDnRequest request)
                                                       throws LdapException

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

Parameters:

request - modify DN request

Returns:

operation handle

Throws:

LdapException - if the connection cannot be opened

send

public static OperationHandle<ModifyDnRequest,ModifyDnResponse> send(ConnectionFactory factory,
 ModifyDnRequest request)
                                                              throws LdapException

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

Parameters:

factory - connection factory

request - modify DN request

Returns:

operation handle

Throws:

LdapException - if the connection cannot be opened

execute

public ModifyDnResponse execute(ModifyDnRequest request)
                         throws LdapException

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

Parameters:

request - modify DN request

Returns:

modify DN result

Throws:

LdapException - if the connection cannot be opened

execute

public static ModifyDnResponse execute(ConnectionFactory factory,
 ModifyDnRequest request)
                                throws LdapException

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

Parameters:

factory - connection factory

request - modify dn request

Returns:

modify dn result

Throws:

LdapException - if the connection cannot be opened

copy

public static ModifyDnOperation copy(ModifyDnOperation operation)

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

Parameters:

operation - to copy

Returns:

copy of the supplied modify dn operation

copy

public static ModifyDnOperation copy(ModifyDnOperation operation,
 boolean deep)

Returns a new modify dn 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 dn operation

builder

public static ModifyDnOperation.Builder builder()

Creates a builder for this class.

Returns:

new builder