Package org.ldaptive.transport
Class DefaultExtendedOperationHandle
java.lang.Object
org.ldaptive.transport.DefaultOperationHandle<ExtendedRequest,ExtendedResponse>
org.ldaptive.transport.DefaultExtendedOperationHandle
- All Implemented Interfaces:
ExtendedOperationHandle
,OperationHandle<ExtendedRequest,
ExtendedResponse>
public class DefaultExtendedOperationHandle
extends DefaultOperationHandle<ExtendedRequest,ExtendedResponse>
implements ExtendedOperationHandle
Handle that notifies on the components of an extended request.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate ExtendedValueHandler[]
Functions to handle extended response name and value.Fields inherited from class org.ldaptive.transport.DefaultOperationHandle
logger
-
Constructor Summary
ConstructorsConstructorDescriptionDefaultExtendedOperationHandle
(ExtendedRequest req, TransportConnection conn, Duration timeout) Creates a new extended operation handle. -
Method Summary
Modifier and TypeMethodDescriptionawait()
Waits for a result or reports a timeout exception.void
extended
(ExtendedResponse response) InvokesonExtended
.onComplete
(CompleteHandler function) Sets the function to execute when the operation completes.onControl
(ResponseControlHandler... function) Sets the functions to execute when a control is received.onException
(ExceptionHandler function) Sets the function to execute when an exception occurs.onExtended
(ExtendedValueHandler... function) Sets the function to execute when an extended response is received.onIntermediate
(IntermediateResponseHandler... function) Sets the functions to execute when an intermediate response is received.onReferral
(ReferralHandler... function) Sets the functions to execute when a referral is received.onResult
(ResultHandler... function) Sets the functions to execute when a result is received.onUnsolicitedNotification
(UnsolicitedNotificationHandler... function) Sets the functions to execute when an unsolicited notification is received.send()
Sends this request to the server.throwIf
(ResultPredicate function) Sets the function to determine whether an exception should be raised by a particular result.toString()
Methods inherited from class org.ldaptive.transport.DefaultOperationHandle
abandon, abandon, cancel, consumedMessage, control, exception, getMessageID, getOnComplete, getOnControl, getOnException, getOnIntermediate, getOnReferral, getOnResult, getOnUnsolicitedNotification, getReceivedTime, getRequest, getSentTime, getThrowCondition, hasConsumedMessage, initializeMessageFunctional, intermediate, messageID, referral, result, sent, unsolicitedNotification
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.ldaptive.extended.ExtendedOperationHandle
execute
Methods inherited from interface org.ldaptive.OperationHandle
abandon, cancel, getReceivedTime, getSentTime
-
Field Details
-
onExtended
Functions to handle extended response name and value.
-
-
Constructor Details
-
DefaultExtendedOperationHandle
public DefaultExtendedOperationHandle(ExtendedRequest req, TransportConnection conn, Duration timeout) Creates a new extended operation handle.- Parameters:
req
- search request to expect a response forconn
- the request will be executed ontimeout
- duration to wait for a response
-
-
Method Details
-
send
Description copied from interface:OperationHandle
Sends this request to the server.- Specified by:
send
in interfaceExtendedOperationHandle
- Specified by:
send
in interfaceOperationHandle<ExtendedRequest,
ExtendedResponse> - Overrides:
send
in classDefaultOperationHandle<ExtendedRequest,
ExtendedResponse> - Returns:
- this handle
-
await
Description copied from interface:OperationHandle
Waits for a result or reports a timeout exception.- Specified by:
await
in interfaceExtendedOperationHandle
- Specified by:
await
in interfaceOperationHandle<ExtendedRequest,
ExtendedResponse> - Overrides:
await
in classDefaultOperationHandle<ExtendedRequest,
ExtendedResponse> - Returns:
- result of the operation or empty if the operation is abandoned
- Throws:
LdapException
- if an error occurs executing the request
-
onResult
Description copied from interface:OperationHandle
Sets the functions to execute when a result is received.- Specified by:
onResult
in interfaceExtendedOperationHandle
- Specified by:
onResult
in interfaceOperationHandle<ExtendedRequest,
ExtendedResponse> - Overrides:
onResult
in classDefaultOperationHandle<ExtendedRequest,
ExtendedResponse> - Parameters:
function
- to execute on a result- Returns:
- this handle
-
onControl
Description copied from interface:OperationHandle
Sets the functions to execute when a control is received.- Specified by:
onControl
in interfaceExtendedOperationHandle
- Specified by:
onControl
in interfaceOperationHandle<ExtendedRequest,
ExtendedResponse> - Overrides:
onControl
in classDefaultOperationHandle<ExtendedRequest,
ExtendedResponse> - Parameters:
function
- to execute on a control- Returns:
- this handle
-
onReferral
Description copied from interface:OperationHandle
Sets the functions to execute when a referral is received.- Specified by:
onReferral
in interfaceExtendedOperationHandle
- Specified by:
onReferral
in interfaceOperationHandle<ExtendedRequest,
ExtendedResponse> - Overrides:
onReferral
in classDefaultOperationHandle<ExtendedRequest,
ExtendedResponse> - Parameters:
function
- to execute on a referral- Returns:
- this handle
-
onIntermediate
Description copied from interface:OperationHandle
Sets the functions to execute when an intermediate response is received.- Specified by:
onIntermediate
in interfaceExtendedOperationHandle
- Specified by:
onIntermediate
in interfaceOperationHandle<ExtendedRequest,
ExtendedResponse> - Overrides:
onIntermediate
in classDefaultOperationHandle<ExtendedRequest,
ExtendedResponse> - Parameters:
function
- to execute on an intermediate response- Returns:
- this handle
-
onUnsolicitedNotification
public DefaultExtendedOperationHandle onUnsolicitedNotification(UnsolicitedNotificationHandler... function) Description copied from interface:OperationHandle
Sets the functions to execute when an unsolicited notification is received.- Specified by:
onUnsolicitedNotification
in interfaceExtendedOperationHandle
- Specified by:
onUnsolicitedNotification
in interfaceOperationHandle<ExtendedRequest,
ExtendedResponse> - Overrides:
onUnsolicitedNotification
in classDefaultOperationHandle<ExtendedRequest,
ExtendedResponse> - Parameters:
function
- to execute on an unsolicited notification- Returns:
- this handle
-
onException
Description copied from interface:OperationHandle
Sets the function to execute when an exception occurs.- Specified by:
onException
in interfaceExtendedOperationHandle
- Specified by:
onException
in interfaceOperationHandle<ExtendedRequest,
ExtendedResponse> - Overrides:
onException
in classDefaultOperationHandle<ExtendedRequest,
ExtendedResponse> - Parameters:
function
- to execute when an exception occurs- Returns:
- this handle
-
throwIf
Description copied from interface:OperationHandle
Sets the function to determine whether an exception should be raised by a particular result.- Specified by:
throwIf
in interfaceExtendedOperationHandle
- Specified by:
throwIf
in interfaceOperationHandle<ExtendedRequest,
ExtendedResponse> - Overrides:
throwIf
in classDefaultOperationHandle<ExtendedRequest,
ExtendedResponse> - Parameters:
function
- to determine whether to throw an exception- Returns:
- this handle
-
onComplete
Description copied from interface:OperationHandle
Sets the function to execute when the operation completes.- Specified by:
onComplete
in interfaceExtendedOperationHandle
- Specified by:
onComplete
in interfaceOperationHandle<ExtendedRequest,
ExtendedResponse> - Overrides:
onComplete
in classDefaultOperationHandle<ExtendedRequest,
ExtendedResponse> - Parameters:
function
- to execute on completion- Returns:
- this handle
-
onExtended
Sets the function to execute when an extended response is received.- Specified by:
onExtended
in interfaceExtendedOperationHandle
- Parameters:
function
- to execute on an extended response- Returns:
- this handle
-
extended
InvokesonExtended
.- Parameters:
response
- extended response
-
toString
- Overrides:
toString
in classDefaultOperationHandle<ExtendedRequest,
ExtendedResponse>
-