Package org.ldaptive

Class DeleteOperation

java.lang.Object

org.ldaptive.AbstractOperation<DeleteRequest,DeleteResponse>

org.ldaptive.DeleteOperation

All Implemented Interfaces:

Operation<DeleteRequest,DeleteResponse>

public class DeleteOperation
extends AbstractOperation<DeleteRequest,DeleteResponse>

Executes an ldap delete operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DeleteOperation.Builder	Delete operation builder.

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

AbstractOperation.AbstractBuilder<B,T extends AbstractOperation>

Constructor Summary

Constructors

Constructor	Description
DeleteOperation()	Default constructor.
DeleteOperation(ConnectionFactory factory)	Creates a new delete operation.

Method Summary

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

DeleteOperation

public DeleteOperation()

Default constructor.

DeleteOperation

public DeleteOperation(ConnectionFactory factory)

Creates a new delete operation.

Parameters:

factory - connection factory

Method Detail

send

public OperationHandle<DeleteRequest,DeleteResponse> send(DeleteRequest request)
                                                         throws LdapException

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

Parameters:

request - delete request

Returns:

operation handle

Throws:

LdapException - if the connection cannot be opened

send

public static OperationHandle<DeleteRequest,DeleteResponse> send(ConnectionFactory factory,
                                                                       DeleteRequest request)
                                                                throws LdapException

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

Parameters:

factory - connection factory

request - delete request

Returns:

operation handle

Throws:

LdapException - if the connection cannot be opened

execute

public DeleteResponse execute(DeleteRequest request)
                       throws LdapException

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

Parameters:

request - delete request

Returns:

delete result

Throws:

LdapException - if the connection cannot be opened

execute

public static DeleteResponse execute(ConnectionFactory factory,
                                     DeleteRequest request)
                              throws LdapException

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

Parameters:

factory - connection factory

request - delete request

Returns:

delete result

Throws:

LdapException - if the connection cannot be opened

copy

public static DeleteOperation copy(DeleteOperation operation)

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

Parameters:

operation - to copy

Returns:

copy of the supplied delete operation

copy

public static DeleteOperation copy(DeleteOperation operation,
                                   boolean deep)

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

builder

public static DeleteOperation.Builder builder()

Creates a builder for this class.

Returns:

new builder