com.unboundid.directory.sdk.common.types
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

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

getAttachment, getAuthorizationDN, getClientContext, getConnectionID, getInternalRootConnection, getInternalRootConnection, getInternalUserConnection, getInternalUserConnection, getMessageID, getOperationID, getOperationType, getRequest, getServerContext, isInternalOperation, isReplicationOperation, isSecure, 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 be null.

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.

Parameters:

name - The name of the attachment to set. It must not be null.

value - The value to set for the attachment. It may be null if any existing attachment with the specified name should be removed.