Package org.ldaptive
Class AbstractOperation<Q extends Request,S extends Result>
java.lang.Object
org.ldaptive.AbstractOperation<Q,S>
- Type Parameters:
Q
- type of requestS
- type of result
- All Implemented Interfaces:
Operation<Q,
S>
- Direct Known Subclasses:
AddOperation
,BindOperation
,CompareOperation
,DeleteOperation
,ExtendedOperation
,ModifyDnOperation
,ModifyOperation
,SearchOperation
public abstract class AbstractOperation<Q extends Request,S extends Result>
extends Object
implements Operation<Q,S>
Base class for operations.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected static class
Base class for operation builders. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate ConnectionFactory
Connection factory.private ResponseControlHandler[]
Functions to handle response controls.private ExceptionHandler
Function to handle exceptions.private IntermediateResponseHandler[]
Functions to handle intermediate responses.private ReferralHandler[]
Functions to handle referrals.private RequestHandler<Q>[]
Functions to handle requests.private ResultHandler[]
Functions to handle response results.private ResultPredicate
Function to test results.private UnsolicitedNotificationHandler[]
Functions to handle unsolicited notifications. -
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.AbstractOperation
(ConnectionFactory factory) Creates a new abstract operation. -
Method Summary
Modifier and TypeMethodDescriptionprotected OperationHandle<Q,
S> configureHandle
(OperationHandle<Q, S> handle) Adds configured functions to the supplied handle.protected Q
configureRequest
(Q request) Applies any configured request handlers to the supplied request.RequestHandler<Q>[]
void
setConnectionFactory
(ConnectionFactory factory) void
setControlHandlers
(ResponseControlHandler... handlers) void
setExceptionHandler
(ExceptionHandler handler) void
void
setReferralHandlers
(ReferralHandler... handlers) void
setRequestHandlers
(RequestHandler<Q>... handlers) void
setResultHandlers
(ResultHandler... handlers) void
setThrowCondition
(ResultPredicate function) void
toString()
-
Field Details
-
connectionFactory
Connection factory. -
requestHandlers
Functions to handle requests. -
resultHandlers
Functions to handle response results. -
controlHandlers
Functions to handle response controls. -
referralHandlers
Functions to handle referrals. -
intermediateResponseHandlers
Functions to handle intermediate responses. -
exceptionHandler
Function to handle exceptions. -
throwCondition
Function to test results. -
unsolicitedNotificationHandlers
Functions to handle unsolicited notifications.
-
-
Constructor Details
-
AbstractOperation
public AbstractOperation()Default constructor. -
AbstractOperation
Creates a new abstract operation.- Parameters:
factory
- connection factory
-
-
Method Details
-
getConnectionFactory
-
setConnectionFactory
-
getRequestHandlers
-
setRequestHandlers
-
getResultHandlers
-
setResultHandlers
-
getControlHandlers
-
setControlHandlers
-
getReferralHandlers
-
setReferralHandlers
-
getIntermediateResponseHandlers
-
setIntermediateResponseHandlers
-
getExceptionHandler
-
setExceptionHandler
-
getThrowCondition
-
setThrowCondition
-
getUnsolicitedNotificationHandlers
-
setUnsolicitedNotificationHandlers
-
configureRequest
Applies any configured request handlers to the supplied request. Returns the supplied request unaltered if no request handlers are configured.- Parameters:
request
- to configure- Returns:
- configured request
-
configureHandle
Adds configured functions to the supplied handle.- Parameters:
handle
- to configure- Returns:
- configured handle
-
toString
-