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

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.DeleteRequestAccessLogMessage
                      extended by com.unboundid.ldap.sdk.unboundidds.logs.DeleteResultAccessLogMessage
All Implemented Interfaces:
MinimalOperationResultAccessLogMessage, OperationResultAccessLogMessage, java.io.Serializable
Direct Known Subclasses:
DeleteAssuranceCompletedAccessLogMessage

@NotExtensible
@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public class DeleteResultAccessLogMessage
extends DeleteRequestAccessLogMessage
implements OperationResultAccessLogMessage

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 a delete operation processed by the Directory Server.

See Also:
Serialized Form

Constructor Summary
DeleteResultAccessLogMessage(LogMessage m)
          Creates a new delete result access log message from the provided log message.
DeleteResultAccessLogMessage(java.lang.String s)
          Creates a new delete 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 getAlternateAuthorizationDN()
          Retrieves the alternate authorization DN for the operation.
 AssuredReplicationLocalLevel getAssuredReplicationLocalLevel()
          Retrieves the local level that will be used for assured replication processing, if available.
 AssuredReplicationRemoteLevel getAssuredReplicationRemoteLevel()
          Retrieves the remote level that will be used for assured replication processing, if available.
 java.lang.Long getAssuredReplicationTimeoutMillis()
          Retrieves the maximum length of time in milliseconds that the server will delay the response to the client while waiting for the replication assurance requirement to be satisfied.
 java.lang.Boolean getChangeToSoftDeletedEntry()
          Indicates whether the delete operation targeted a soft-deleted entry.
 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.Long getIntermediateResponsesReturned()
          Retrieves the number of intermediate response messages returned in the course of processing 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.lang.String getReplicationChangeID()
          Retrieves the replication change ID for the operation, if available.
 java.util.List<java.lang.String> getResponseControlOIDs()
          Retrieves the OIDs of any response controls contained in the log message.
 java.lang.Boolean getResponseDelayedByAssurance()
          Indicates whether the operation response to the client will be delayed until replication assurance has been satisfied or the timeout has occurred.
 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 getSoftDeletedEntryDN()
          Retrieves the DN of the soft-deleted entry that was created as a result of this operation, if it was a soft delete rather than a normal hard delete.
 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.DeleteRequestAccessLogMessage
getDN, 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

DeleteResultAccessLogMessage

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

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

DeleteResultAccessLogMessage

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

Parameters:
m - The log message to be parsed as a delete 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.

getIntermediateResponsesReturned

public java.lang.Long getIntermediateResponsesReturned()
Retrieves the number of intermediate response messages returned in the course of processing the operation.

Specified by:
getIntermediateResponsesReturned in interface OperationResultAccessLogMessage
Returns:
The number of intermediate response messages returned to the client in the course of processing the operation, or null 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.

Specified by:
getResponseControlOIDs in interface OperationResultAccessLogMessage
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.

Specified by:
getServersAccessed in interface OperationResultAccessLogMessage
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.

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

getAlternateAuthorizationDN

public java.lang.String getAlternateAuthorizationDN()
Retrieves the alternate authorization DN for the operation.

Returns:
The alternate authorization DN for the operation, or null if it is not included in the log message.

getReplicationChangeID

public java.lang.String getReplicationChangeID()
Retrieves the replication change ID for the operation, if available.

Returns:
The replication change ID for the operation, or null if it is not included in the log message.

getSoftDeletedEntryDN

public java.lang.String getSoftDeletedEntryDN()
Retrieves the DN of the soft-deleted entry that was created as a result of this operation, if it was a soft delete rather than a normal hard delete.

Returns:
The DN of the soft-deleted entry that was created as a result of this operation, or null if it is not included in the log message (e.g., because the operation was a hard delete rather than a soft delete).

getChangeToSoftDeletedEntry

public java.lang.Boolean getChangeToSoftDeletedEntry()
Indicates whether the delete operation targeted a soft-deleted entry.

Returns:
true if the delete operation was known to target a soft-deleted entry, false if it was known to target a non-soft-deleted entry, or null if it is not included in the log message (and likely did not target a soft-deleted entry).

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.

getAssuredReplicationLocalLevel

public AssuredReplicationLocalLevel getAssuredReplicationLocalLevel()
Retrieves the local level that will be used for assured replication processing, if available.

Returns:
The local level that will be used for assured replication processing, or null if this is not included in the log message (e.g., because assured replication will not be performed for the operation).

getAssuredReplicationRemoteLevel

public AssuredReplicationRemoteLevel getAssuredReplicationRemoteLevel()
Retrieves the remote level that will be used for assured replication processing, if available.

Returns:
The remote level that will be used for assured replication processing, or null if this is not included in the log message (e.g., because assured replication will not be performed for the operation).

getAssuredReplicationTimeoutMillis

public java.lang.Long getAssuredReplicationTimeoutMillis()
Retrieves the maximum length of time in milliseconds that the server will delay the response to the client while waiting for the replication assurance requirement to be satisfied.

Returns:
The maximum length of time in milliseconds that the server will delay the response to the client while waiting for the replication assurance requirement to be satisfied, or null if this is not included in the log message (e.g., because assured replication will not be performed for the operation).

getResponseDelayedByAssurance

public java.lang.Boolean getResponseDelayedByAssurance()
Indicates whether the operation response to the client will be delayed until replication assurance has been satisfied or the timeout has occurred.

Returns:
true if the operation response to the client will be delayed until replication assurance has been satisfied, false if the response will not be delayed by assurance processing, or null if this was not included in the log message (e.g., because assured replication will not be performed for the operation)

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.