com.unboundid.ldap.sdk.unboundidds.logs.v2.text

Class TextFormattedEntryRebalancingResultAccessLogMessage

java.lang.Object

com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedLogMessage

com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedAccessLogMessage

com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedEntryRebalancingRequestAccessLogMessage

com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedEntryRebalancingResultAccessLogMessage

All Implemented Interfaces:

AccessLogMessage, EntryRebalancingRequestAccessLogMessage, EntryRebalancingResultAccessLogMessage, LogMessage, java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class TextFormattedEntryRebalancingResultAccessLogMessage
extends TextFormattedEntryRebalancingRequestAccessLogMessage
implements EntryRebalancingResultAccessLogMessage

This class provides a data structure that holds information about a text-formatted entry rebalancing result access log message.

NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedLogMessage

NO_FIELD_NAME

Constructor Summary

Constructors

Constructor and Description
TextFormattedEntryRebalancingResultAccessLogMessage(java.lang.String logMessageString) Creates a new text-formatted entry rebalancing request access log message from the provided message string.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAdminActionMessage() 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	getSourceServerAltered() Indicates whether data in the source server was altered as a result of processing for this entry-rebalancing operation.
java.lang.Boolean	getTargetServerAltered() 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.v2.text.TextFormattedEntryRebalancingRequestAccessLogMessage

getRebalancingOperationID, getSizeLimit, getSourceBackendServer, getSourceBackendSetName, getSubtreeBaseDN, getTargetBackendServer, getTargetBackendSetName, getTriggeredByConnectionID, getTriggeredByOperationID

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedAccessLogMessage

getConnectionID, getInstanceName, getProductName, getStartupID, getThreadID

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedLogMessage

getBoolean, getDouble, getFields, getGeneralizedTime, getInteger, getLong, getRFC3339Timestamp, getString, getTimestamp, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.EntryRebalancingRequestAccessLogMessage

getRebalancingOperationID, getSizeLimit, getSourceBackendServer, getSourceBackendSetName, getSubtreeBaseDN, getTargetBackendServer, getTargetBackendSetName, getTriggeredByConnectionID, getTriggeredByOperationID

Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.AccessLogMessage

getConnectionID, getInstanceName, getProductName, getStartupID, getThreadID

Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.LogMessage

getBoolean, getDouble, getFields, getGeneralizedTime, getInteger, getLong, getRFC3339Timestamp, getString, getTimestamp, toString

Constructor Detail

TextFormattedEntryRebalancingResultAccessLogMessage

public TextFormattedEntryRebalancingResultAccessLogMessage(@NotNull
                                                           java.lang.String logMessageString)
                                                    throws LogException

Creates a new text-formatted entry rebalancing request access log message from the provided message string.

Parameters:

logMessageString - The string representation of this log message. It must not be null.

Throws:

LogException - If the provided string cannot be parsed as a valid log message.

Method Detail

getMessageType

@NotNull
public AccessLogMessageType getMessageType()

Retrieves the message type for this access log message.

Specified by:

getMessageType in interface AccessLogMessage

Overrides:

getMessageType in class TextFormattedEntryRebalancingRequestAccessLogMessage

Returns:

The message type for this access log message.

getResultCode

@Nullable
public ResultCode getResultCode()

Retrieves the result code for the entry-rebalancing operation.

Specified by:

getResultCode in interface EntryRebalancingResultAccessLogMessage

Returns:

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

getErrorMessage

@Nullable
public java.lang.String getErrorMessage()

Retrieves a message with information about any errors that were encountered during processing.

Specified by:

getErrorMessage in interface EntryRebalancingResultAccessLogMessage

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.

getAdminActionMessage

@Nullable
public java.lang.String getAdminActionMessage()

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.

Specified by:

getAdminActionMessage in interface EntryRebalancingResultAccessLogMessage

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.

getSourceServerAltered

@Nullable
public java.lang.Boolean getSourceServerAltered()

Indicates whether data in the source server was altered as a result of processing for this entry-rebalancing operation.

Specified by:

getSourceServerAltered in interface EntryRebalancingResultAccessLogMessage

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.

getTargetServerAltered

@Nullable
public java.lang.Boolean getTargetServerAltered()

Indicates whether data in the target server was altered as a result of processing for this entry-rebalancing operation.

Specified by:

getTargetServerAltered in interface EntryRebalancingResultAccessLogMessage

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

@Nullable
public java.lang.Integer getEntriesReadFromSource()

Retrieves the number of entries that were read from the source server.

Specified by:

getEntriesReadFromSource in interface EntryRebalancingResultAccessLogMessage

Returns:

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

getEntriesAddedToTarget

@Nullable
public java.lang.Integer getEntriesAddedToTarget()

Retrieves the number of entries that were added to the target server.

Specified by:

getEntriesAddedToTarget in interface EntryRebalancingResultAccessLogMessage

Returns:

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

getEntriesDeletedFromSource

@Nullable
public java.lang.Integer getEntriesDeletedFromSource()

Retrieves the number of entries that were deleted from the source server.

Specified by:

getEntriesDeletedFromSource in interface EntryRebalancingResultAccessLogMessage

Returns:

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