Package org.ldaptive
Class CompareOperation
- All Implemented Interfaces:
Operation<CompareRequest,CompareResponse>
Executes an ldap compare operation.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classCompare operation builder.Nested classes/interfaces inherited from class org.ldaptive.AbstractOperation
AbstractOperation.AbstractBuilder<B,T extends AbstractOperation> -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate CompareValueHandler[]Functions to handle the compare result. -
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.CompareOperation(ConnectionFactory factory) Creates a new compare operation. -
Method Summary
Modifier and TypeMethodDescriptionstatic CompareOperation.Builderbuilder()Creates a builder for this class.protected CompareOperationHandleAdds configured functions to the supplied handle.execute(CompareRequest request) Executes a compare request.static CompareResponseexecute(ConnectionFactory factory, CompareRequest request) Executes a compare request.send(CompareRequest request) Sends a compare request.static CompareOperationHandlesend(ConnectionFactory factory, CompareRequest request) Sends a compare request.voidsetCompareValueHandlers(CompareValueHandler... 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
-
compareValueHandlers
Functions to handle the compare result.
-
-
Constructor Details
-
CompareOperation
public CompareOperation()Default constructor. -
CompareOperation
Creates a new compare operation.- Parameters:
factory- connection factory
-
-
Method Details
-
getCompareValueHandlers
-
setCompareValueHandlers
-
send
Sends a compare request. SeeOperationHandle.send().- Parameters:
request- compare request- Returns:
- operation handle
- Throws:
LdapException- if the connection cannot be opened
-
send
public static CompareOperationHandle send(ConnectionFactory factory, CompareRequest request) throws LdapException Sends a compare request. SeeOperationHandle.send().- Parameters:
factory- connection factoryrequest- compare request- Returns:
- operation handle
- Throws:
LdapException- if the connection cannot be opened
-
execute
Executes a compare request. SeeOperationHandle.execute().- Parameters:
request- compare request- Returns:
- compare result
- Throws:
LdapException- if the connection cannot be opened
-
execute
public static CompareResponse execute(ConnectionFactory factory, CompareRequest request) throws LdapException Executes a compare request. SeeOperationHandle.execute().- Parameters:
factory- connection factoryrequest- compare request- Returns:
- compare 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:
toStringin classAbstractOperation<CompareRequest,CompareResponse>
-
builder
Creates a builder for this class.- Returns:
- new builder
-