Package com.unboundid.directory.sdk.common.types

Interface CompletedOperationContext

All Superinterfaces:

OperationContext

All Known Subinterfaces:

CompletedProxyOperationContext, CompletedSearchOperationContext

@NotExtensible
@ThreadSafety(level=INTERFACE_NOT_THREADSAFE)
public interface CompletedOperationContext
extends OperationContext

This interface defines a set of methods that may be used to obtain information about an operation for which processing has been completed.

Method Summary

Modifier and Type	Method	Description
long	getDequeueTime()	Retrieves the time that the operation was removed from the work queue, if available.
long	getEnqueueTime()	Retrieves the time that the operation was added to the work queue, if available.
java.util.Set<java.lang.String>	getMissingPrivilegeNames()	Retrieves the names of any privileges that were required during the course of processing the operation that the requester did not have.
java.util.Set<java.lang.String>	getPreAuthorizationUsedPrivilegeNames()	Retrieves the names of any privileges used before the assignment of an alternate authorization identity.
long	getProcessingEndTime()	Retrieves the time that the worker thread completed processing for the operation.
long	getProcessingStartTime()	Retrieves the time that the worker thread began processing the operation.
long	getProcessingTimeMillis()	Retrieves the length of time in milliseconds that the worker thread spent processing the operation.
long	getProcessingTimeNanos()	Retrieves the length of time in nanoseconds that the worker thread spent processing the operation.
long	getQueueWaitTimeMillis()	Retrieves the length of time in milliseconds that the operation was held in the work queue before being picked up for processing by a worker thread.
GenericResult	getResult()	Retrieves information about the result of the operation processing.
java.util.Set<java.lang.String>	getUsedPrivilegeNames(boolean includePreAuthorizationPrivileges)	Retrieves the names of the privileges used in the course of processing the 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, setAttachment, toString

Method Detail

getEnqueueTime

long getEnqueueTime()

Retrieves the time that the operation was added to the work queue, if available. The value returned will be an offset in milliseconds since 12:00 a.m. on January 1, 1970.

Returns:

The time that the operation was added to the work queue, or -1 if the enqueue time is not available.

getDequeueTime

long getDequeueTime()

Retrieves the time that the operation was removed from the work queue, if available. The value returned will be an offset in milliseconds since 12:00 a.m. on January 1, 1970.

Returns:

The time that the operation was removed form the work queue, or -1 if the dequeue time is not available.

getQueueWaitTimeMillis

long getQueueWaitTimeMillis()

Retrieves the length of time in milliseconds that the operation was held in the work queue before being picked up for processing by a worker thread.

Returns:

The length of time in milliseconds that the operation was held in the work queue, or -1 if the queue wait time is not available.

getProcessingStartTime

long getProcessingStartTime()

Retrieves the time that the worker thread began processing the operation. The value returned will be an offset in milliseconds since 12:00 a.m. on January 1, 1970.

Returns:

The time that the worker thread began processing the operation.

getProcessingEndTime

long getProcessingEndTime()

Retrieves the time that the worker thread completed processing for the operation. The value returned will be an offset in milliseconds since 12:00 a.m. on January 1, 1970.

Returns:

The time that the worker thread completed processing for the operation.

getProcessingTimeMillis

long getProcessingTimeMillis()

Retrieves the length of time in milliseconds that the worker thread spent processing the operation.

Returns:

The length of time in milliseconds that the worker thread spent processing the operation.

getProcessingTimeNanos

long getProcessingTimeNanos()

Retrieves the length of time in nanoseconds that the worker thread spent processing the operation.

Returns:

The length of time in nanoseconds that the worker thread spent processing the operation.

getResult

GenericResult getResult()

Retrieves information about the result of the operation processing.

Returns:

Information about the result of the operation processing.

getUsedPrivilegeNames

java.util.Set<java.lang.String> getUsedPrivilegeNames(boolean includePreAuthorizationPrivileges)

Retrieves the names of the privileges used in the course of processing 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:

includePreAuthorizationPrivileges - Indicates whether the returned set of privileges should include any privileges used before the assignment of an alternate authorization identity.

Returns:

The names of the privileges used in the course of processing the operation, or an empty set if no privileges were used.

getPreAuthorizationUsedPrivilegeNames

java.util.Set<java.lang.String> getPreAuthorizationUsedPrivilegeNames()

Retrieves the names of any privileges used before the assignment of an alternate authorization identity. If no alternate authorization identity was used, then this set will be empty. If an alternate authorization identity was used, then it should include at least the proxied-auth privilege, but may include other privileges that had been used before the assignment of that alternate authorization identity.

The set of defined privileges may be found in the privilege-list.html and privilege-list.csv files in the server docs directory.

Returns:

The names of any privileges used before the assignment of an alternate authorization identity, or an set if no alternate authorization identity was used.

getMissingPrivilegeNames

java.util.Set<java.lang.String> getMissingPrivilegeNames()

Retrieves the names of any privileges that were required during the course of processing the operation that the requester did not have. The set of defined privileges may be found in the privilege-list.html and privilege-list.csv files in the server docs directory.

Returns:

The names of any privileges that were required during the course of processing the operation that the requester did not have, or an empty set if the requester was not missing any required privileges.