Interface ActiveOperationContext
-
- All Superinterfaces:
OperationContext
- All Known Subinterfaces:
ActiveSearchOperationContext
@NotExtensible @ThreadSafety(level=INTERFACE_NOT_THREADSAFE) public interface ActiveOperationContext extends OperationContext
This interface defines a set of methods that may be used to obtain information about an operation that is actively being processed and for which the final response has not yet been sent.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
hasPrivilege(java.lang.String privilegeName, boolean markUsed)
Indicates whether the requester has the specified privilege, optionally including it in the set of used privileges for the operation.void
requirePrivilege(java.lang.String privilegeName)
Ensures that the requester has the specified privilege.void
sendIntermediateResponse(IntermediateResponse r)
Attempts to send an intermediate response message to the client.void
setAttachment(java.lang.String name, java.lang.Object value)
Sets an attachment for the associated operation.-
Methods inherited from interface com.unboundid.directory.sdk.common.types.OperationContext
addCustomLogElement, addCustomLogElement, appendAdditionalLogMessage, deregisterOperationCompletedListener, getAttachment, getAuthorizationDN, getClientConnectionPolicyDN, getClientConnectionPolicyName, getClientContext, getConnectionID, getCustomLogElements, getInternalRootConnection, getInternalRootConnection, getInternalUserConnection, getInternalUserConnection, getMessageID, getOperationID, getOperationType, getRequest, getServerContext, isAdministrativeOperation, isInternalOperation, isReplicationOperation, isSecure, registerOperationCompletedListener, toString
-
-
-
-
Method Detail
-
sendIntermediateResponse
void sendIntermediateResponse(IntermediateResponse r) throws LDAPException
Attempts to send an intermediate response message to the client.- Parameters:
r
- The intermediate response to be sent. It must not benull
.- Throws:
LDAPException
- If a problem occurs while attempting to send the intermediate response message and processing on the associated operation should be aborted.
-
setAttachment
void setAttachment(java.lang.String name, java.lang.Object value)
Sets an attachment for the associated operation.- Specified by:
setAttachment
in interfaceOperationContext
- Parameters:
name
- The name of the attachment to set. It must not benull
.value
- The value to set for the attachment. It may benull
if any existing attachment with the specified name should be removed.
-
hasPrivilege
boolean hasPrivilege(java.lang.String privilegeName, boolean markUsed) throws LDAPException
Indicates whether the requester has the specified privilege, optionally including it in the set of used privileges for the operation. The set of defined privileges may be found in the privilege-list.html and privilege-list.csv files in the server docs directory.- Parameters:
privilegeName
- The name of the privilege for which to make the determination. It must not benull
.markUsed
- Indicates whether to include the specified privilege in the set of privileges that were used in the course of processing the operation. This is only applicable if the requester has the specified privilege.- Returns:
true
if the requester has the specified privilege, orfalse
if not.- Throws:
LDAPException
- If the specified privilege is not defined in the server, or if a problem is encountered while trying to make the determination.
-
requirePrivilege
void requirePrivilege(java.lang.String privilegeName) throws LDAPException
Ensures that the requester has the specified privilege. If the requester has the specified privilege, then the set of privileges used in the course of processing the operation will be updated to include the specified privilege. If the specifies privilege is defined in the server but the requested user does not have it, then it will be added to the set of missing privileges for the operation.
The set of defined privileges may be found in the privilege-list.html and privilege-list.csv files in the server docs directory.- Parameters:
privilegeName
- The name of the privilege to require. It must not benull
.- Throws:
LDAPException
- If the specified privilege is not defined in the server, if the requester does not have that privilege, or a problem is encountered while trying to make the determination.
-
-