com.unboundid.ldap.sdk.unboundidds.logs
Class AbandonResultAccessLogMessage

java.lang.Object
  extended by com.unboundid.ldap.sdk.unboundidds.logs.LogMessage
      extended by com.unboundid.ldap.sdk.unboundidds.logs.AccessLogMessage
          extended by com.unboundid.ldap.sdk.unboundidds.logs.OperationAccessLogMessage
              extended by com.unboundid.ldap.sdk.unboundidds.logs.OperationRequestAccessLogMessage
                  extended by com.unboundid.ldap.sdk.unboundidds.logs.AbandonRequestAccessLogMessage
                      extended by com.unboundid.ldap.sdk.unboundidds.logs.AbandonResultAccessLogMessage
All Implemented Interfaces:
MinimalOperationResultAccessLogMessage, java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class AbandonResultAccessLogMessage
extends AbandonRequestAccessLogMessage
implements MinimalOperationResultAccessLogMessage

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about the result of an abandon operation processed by the Directory Server.

See Also:
Serialized Form

Constructor Summary
AbandonResultAccessLogMessage(LogMessage m)
          Creates a new abandon result access log message from the provided log message.
AbandonResultAccessLogMessage(java.lang.String s)
          Creates a new abandon result access log message from the provided message string.
 
Method Summary
 java.lang.String getAdditionalInformation()
          Retrieves a message with additional information about the result of the operation.
 java.lang.String getDiagnosticMessage()
          Retrieves the diagnostic message for the operation.
 java.lang.String getIntermediateClientResult()
          Retrieves the content of the intermediate client result for the operation.
 java.lang.String getMatchedDN()
          Retrieves the matched DN for the operation.
 AccessLogMessageType getMessageType()
          Retrieves the message type for this access log message.
 java.util.List<java.lang.String> getMissingPrivileges()
          Retrieves the names of any privileges that would have been required for processing the operation but that the requester did not have.
 java.util.List<java.lang.String> getPreAuthorizationUsedPrivileges()
          Retrieves the names of any privileges used during the course of processing the operation before an alternate authorization identity was assigned.
 java.lang.Double getProcessingTimeMillis()
          Retrieves the length of time in milliseconds required to process the operation.
 java.lang.Double getQueueTimeMillis()
          Retrieves the length of time in milliseconds the operation was required to wait on the work queue.
 java.util.List<java.lang.String> getReferralURLs()
          Retrieves the list of referral URLs for the operation.
 java.util.List<java.lang.String> getResponseControlOIDs()
          Retrieves the OIDs of any response controls contained in the log message.
 ResultCode getResultCode()
          Retrieves the result code for the operation.
 java.util.List<java.lang.String> getServersAccessed()
          Retrieves a list of the additional servers that were accessed in the course of processing the operation.
 java.lang.String getTargetHost()
          Retrieves the address of the backend server to which the request has been forwarded.
 java.lang.Integer getTargetPort()
          Retrieves the port of the backend server to which the request has been forwarded.
 java.lang.String getTargetProtocol()
          Retrieves the protocol used to forward the request to the backend server.
 java.lang.Boolean getUncachedDataAccessed()
          Indicates whether the server accessed any uncached data in the course of processing the operation.
 java.util.List<java.lang.String> getUsedPrivileges()
          Retrieves the names of any privileges used during the course of processing the operation.
 
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.AbandonRequestAccessLogMessage
getMessageIDToAbandon, getOperationType
 
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.OperationRequestAccessLogMessage
getIntermediateClientRequest, getOperationPurpose, getRequestControlOIDs, getRequesterDN, getRequesterIPAddress, usingAdminSessionWorkerThread
 
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.OperationAccessLogMessage
getMessageID, getOperationID, getOrigin
 
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.AccessLogMessage
getConnectionID, getInstanceName, getProductName, getStartupID, parse
 
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.LogMessage
getNamedValue, getNamedValueAsBoolean, getNamedValueAsDouble, getNamedValueAsInteger, getNamedValueAsLong, getNamedValues, getTimestamp, getUnnamedValues, hasUnnamedValue, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AbandonResultAccessLogMessage

public AbandonResultAccessLogMessage(java.lang.String s)
                              throws LogException
Creates a new abandon result access log message from the provided message string.

Parameters:
s - The string to be parsed as an abandon result access log message.
Throws:
LogException - If the provided string cannot be parsed as a valid log message.

AbandonResultAccessLogMessage

public AbandonResultAccessLogMessage(LogMessage m)
Creates a new abandon result access log message from the provided log message.

Parameters:
m - The log message to be parsed as an abandon result access log message.
Method Detail

getResultCode

public ResultCode getResultCode()
Retrieves the result code for the operation.

Specified by:
getResultCode in interface MinimalOperationResultAccessLogMessage
Returns:
The result code for the operation, or null if it is not included in the log message.

getDiagnosticMessage

public java.lang.String getDiagnosticMessage()
Retrieves the diagnostic message for the operation.

Specified by:
getDiagnosticMessage in interface MinimalOperationResultAccessLogMessage
Returns:
The diagnostic message for the operation, or null if it is not included in the log message.

getAdditionalInformation

public java.lang.String getAdditionalInformation()
Retrieves a message with additional information about the result of the operation.

Specified by:
getAdditionalInformation in interface MinimalOperationResultAccessLogMessage
Returns:
A message with additional information about the result of the operation, or null if it is not included in the log message.

getMatchedDN

public java.lang.String getMatchedDN()
Retrieves the matched DN for the operation.

Specified by:
getMatchedDN in interface MinimalOperationResultAccessLogMessage
Returns:
The matched DN for the operation, or null if it is not included in the log message.

getReferralURLs

public java.util.List<java.lang.String> getReferralURLs()
Retrieves the list of referral URLs for the operation.

Specified by:
getReferralURLs in interface MinimalOperationResultAccessLogMessage
Returns:
The list of referral URLs for the operation, or an empty list if it is not included in the log message.

getProcessingTimeMillis

public java.lang.Double getProcessingTimeMillis()
Retrieves the length of time in milliseconds required to process the operation.

Specified by:
getProcessingTimeMillis in interface MinimalOperationResultAccessLogMessage
Returns:
The length of time in milliseconds required to process the operation, or null if it is not included in the log message.

getQueueTimeMillis

public java.lang.Double getQueueTimeMillis()
Retrieves the length of time in milliseconds the operation was required to wait on the work queue.

Specified by:
getQueueTimeMillis in interface MinimalOperationResultAccessLogMessage
Returns:
The length of time in milliseconds the operation was required to wait on the work queue, or null if it is not included in the log message.

getResponseControlOIDs

public java.util.List<java.lang.String> getResponseControlOIDs()
Retrieves the OIDs of any response controls contained in the log message.

Returns:
The OIDs of any response controls contained in the log message, or an empty list if it is not included in the log message.

getServersAccessed

public java.util.List<java.lang.String> getServersAccessed()
Retrieves a list of the additional servers that were accessed in the course of processing the operation. For example, if the access log message is from a Directory Proxy Server instance, then this may contain a list of the backend servers used to process the operation.

Returns:
A list of the additional servers that were accessed in the course of processing the operation, or an empty list if it is not included in the log message.

getUncachedDataAccessed

public java.lang.Boolean getUncachedDataAccessed()
Indicates whether the server accessed any uncached data in the course of processing the operation.

Returns:
true if the server was known to access uncached data in the course of processing the operation, false if the server was known not to access uncached data, or null if it is not included in the log message (and the server likely did not access uncached data).

getIntermediateClientResult

public java.lang.String getIntermediateClientResult()
Retrieves the content of the intermediate client result for the operation.

Returns:
The content of the intermediate client result for the operation, or null if it is not included in the log message.

getTargetHost

public java.lang.String getTargetHost()
Retrieves the address of the backend server to which the request has been forwarded.

Returns:
The address of the backend server to which the request has been forwarded, or null if it is not included in the log message.

getTargetPort

public java.lang.Integer getTargetPort()
Retrieves the port of the backend server to which the request has been forwarded.

Returns:
The port of the backend server to which the request has been forwarded, or null if it is not included in the log message.

getTargetProtocol

public java.lang.String getTargetProtocol()
Retrieves the protocol used to forward the request to the backend server.

Returns:
The protocol used to forward the request to the backend server, or null if it is not included in the log message.

getUsedPrivileges

public java.util.List<java.lang.String> getUsedPrivileges()
Retrieves the names of any privileges used during the course of processing the operation.

Returns:
The names of any privileges used during the course of processing the operation, or an empty list if no privileges were used or this is not included in the log message.

getPreAuthorizationUsedPrivileges

public java.util.List<java.lang.String> getPreAuthorizationUsedPrivileges()
Retrieves the names of any privileges used during the course of processing the operation before an alternate authorization identity was assigned.

Returns:
The names of any privileges used during the course of processing the operation before an alternate authorization identity was assigned, or an empty list if no privileges were used or this is not included in the log message.

getMissingPrivileges

public java.util.List<java.lang.String> getMissingPrivileges()
Retrieves the names of any privileges that would have been required for processing the operation but that the requester did not have.

Returns:
The names of any privileges that would have been required for processing the operation but that the requester did not have, or an empty list if there were no missing privileges or this is not included in the log message.

getMessageType

public AccessLogMessageType getMessageType()
Retrieves the message type for this access log message.

Overrides:
getMessageType in class OperationRequestAccessLogMessage
Returns:
The message type for this access log message.