Package org.ldaptive.extended
Class ExtendedOperation
java.lang.Object
org.ldaptive.AbstractOperation<ExtendedRequest,ExtendedResponse>
org.ldaptive.extended.ExtendedOperation
- All Implemented Interfaces:
Operation<ExtendedRequest,
ExtendedResponse>
Executes an ldap extended operation.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Extended operation builder.Nested classes/interfaces inherited from class org.ldaptive.AbstractOperation
AbstractOperation.AbstractBuilder<B,
T extends AbstractOperation> -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate ExtendedValueHandler[]
Function to handle extended response data. -
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.ExtendedOperation
(ConnectionFactory factory) Creates a new extended operation. -
Method Summary
Modifier and TypeMethodDescriptionstatic ExtendedOperation.Builder
builder()
Creates a builder for this class.protected ExtendedOperationHandle
Adds configured functions to the supplied handle.static ExtendedResponse
execute
(ConnectionFactory factory, ExtendedRequest request) Executes an extended request.execute
(ExtendedRequest request) Executes an extended request.static ExtendedOperationHandle
send
(ConnectionFactory factory, ExtendedRequest request) Sends an extended request.send
(ExtendedRequest request) Sends an extended request.void
setExtendedValueHandlers
(ExtendedValueHandler... handlers) toString()
Methods inherited from class org.ldaptive.AbstractOperation
configureHandle, configureRequest, getConnectionFactory, getControlHandlers, getExceptionHandler, getIntermediateResponseHandlers, getReferralHandlers, getRequestHandlers, getResultHandlers, getThrowCondition, getUnsolicitedNotificationHandlers, setConnectionFactory, setControlHandlers, setExceptionHandler, setIntermediateResponseHandlers, setReferralHandlers, setRequestHandlers, setResultHandlers, setThrowCondition, setUnsolicitedNotificationHandlers
-
Field Details
-
extendedValueHandlers
Function to handle extended response data.
-
-
Constructor Details
-
ExtendedOperation
public ExtendedOperation()Default constructor. -
ExtendedOperation
Creates a new extended operation.- Parameters:
factory
- connection factory
-
-
Method Details
-
getExtendedValueHandlers
-
setExtendedValueHandlers
-
send
Sends an extended request. SeeOperationHandle.send()
.- Parameters:
request
- extended request- Returns:
- operation handle
- Throws:
LdapException
- if the connection cannot be opened
-
send
public static ExtendedOperationHandle send(ConnectionFactory factory, ExtendedRequest request) throws LdapException Sends an extended request. SeeOperationHandle.send()
.- Parameters:
factory
- connection factoryrequest
- extended request- Returns:
- operation handle
- Throws:
LdapException
- if the connection cannot be opened
-
execute
Executes an extended request. SeeOperationHandle.execute()
.- Parameters:
request
- extended request- Returns:
- extended result
- Throws:
LdapException
- if the connection cannot be opened
-
execute
public static ExtendedResponse execute(ConnectionFactory factory, ExtendedRequest request) throws LdapException Executes an extended request. SeeOperationHandle.execute()
.- Parameters:
factory
- connection factoryrequest
- extended request- Returns:
- extended result
- Throws:
LdapException
- if the connection cannot be opened
-
configureHandle
Adds configured functions to the supplied handle.- Parameters:
handle
- to configure- Returns:
- configured handle
-
toString
- Overrides:
toString
in classAbstractOperation<ExtendedRequest,
ExtendedResponse>
-
builder
Creates a builder for this class.- Returns:
- new builder
-