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

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.EntryRebalancingRequestAccessLogMessage
              extended by com.unboundid.ldap.sdk.unboundidds.logs.EntryRebalancingResultAccessLogMessage
All Implemented Interfaces:
java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class EntryRebalancingResultAccessLogMessage
extends EntryRebalancingRequestAccessLogMessage

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 a the result of an entry rebalancing operation.

See Also:
Serialized Form

Constructor Summary
EntryRebalancingResultAccessLogMessage(LogMessage m)
          Creates a new entry rebalancing result access log message from the provided log message.
EntryRebalancingResultAccessLogMessage(java.lang.String s)
          Creates a new entry rebalancing result access log message from the provided message string.
 
Method Summary
 java.lang.String getAdminActionRequired()
          Retrieves a message with information about any administrative action that may be required to bring the source and target servers back to a consistent state with regard to the migrated subtree.
 java.lang.Integer getEntriesAddedToTarget()
          Retrieves the number of entries that were added to the target server.
 java.lang.Integer getEntriesDeletedFromSource()
          Retrieves the number of entries that were deleted from the source server.
 java.lang.Integer getEntriesReadFromSource()
          Retrieves the number of entries that were read from the source server.
 java.lang.String getErrorMessage()
          Retrieves a message with information about any errors that were encountered during processing.
 AccessLogMessageType getMessageType()
          Retrieves the message type for this access log message.
 ResultCode getResultCode()
          Retrieves the result code for the entry-rebalancing operation.
 java.lang.Boolean sourceAltered()
          Indicates whether data in the source server was altered as a result of processing for this entry-rebalancing operation.
 java.lang.Boolean targetAltered()
          Indicates whether data in the target server was altered as a result of processing for this entry-rebalancing operation.
 
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.EntryRebalancingRequestAccessLogMessage
getRebalancingOperationID, getSizeLimit, getSourceBackendServer, getSourceBackendSetName, getSubtreeBaseDN, getTargetBackendServer, getTargetBackendSetName, getTriggeringConnectionID, getTriggeringOperationID
 
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

EntryRebalancingResultAccessLogMessage

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

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

EntryRebalancingResultAccessLogMessage

public EntryRebalancingResultAccessLogMessage(LogMessage m)
Creates a new entry rebalancing result access log message from the provided log message.

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

getResultCode

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

Returns:
The result code for the entry-rebalancing operation, or null if it is not included in the log message.

getErrorMessage

public java.lang.String getErrorMessage()
Retrieves a message with information about any errors that were encountered during processing.

Returns:
A message with information about any errors that were encountered during processing, or null if no errors were encountered or it is not included in the log message.

getAdminActionRequired

public java.lang.String getAdminActionRequired()
Retrieves a message with information about any administrative action that may be required to bring the source and target servers back to a consistent state with regard to the migrated subtree.

Returns:
A message with information about any administrative action that may be required to bring the source and target servers back to a consistent state with regard to the migrated subtree, or null if no administrative action is required or it is not included in the log message.

sourceAltered

public java.lang.Boolean sourceAltered()
Indicates whether data in the source server was altered as a result of processing for this entry-rebalancing operation.

Returns:
true if data in the source server was altered as a result of processing for this entry-rebalancing operation, false if no data in the source server was altered as a result of entry-rebalancing processing, or null if it is not included in the log message.

targetAltered

public java.lang.Boolean targetAltered()
Indicates whether data in the target server was altered as a result of processing for this entry-rebalancing operation.

Returns:
true if data in the target server was altered as a result of processing for this entry-rebalancing operation, false if no data in the target server was altered as a result of entry-rebalancing processing, or null if it is not included in the log message.

getEntriesReadFromSource

public java.lang.Integer getEntriesReadFromSource()
Retrieves the number of entries that were read from the source server.

Returns:
The number of entries that were read from the source server, or null if it is not included in the log message.

getEntriesAddedToTarget

public java.lang.Integer getEntriesAddedToTarget()
Retrieves the number of entries that were added to the target server.

Returns:
The number of entries that were added to the target server, or null if it is not included in the log message.

getEntriesDeletedFromSource

public java.lang.Integer getEntriesDeletedFromSource()
Retrieves the number of entries that were deleted from the source server.

Returns:
The number of entries that were deleted from the source server, or null if it is not included in the log message.

getMessageType

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

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