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

Interface EntryRebalancingResultAccessLogMessage

All Superinterfaces:

AccessLogMessage, EntryRebalancingRequestAccessLogMessage, LogMessage, java.io.Serializable

All Known Implementing Classes:

JSONEntryRebalancingResultAccessLogMessage, TextFormattedEntryRebalancingResultAccessLogMessage

@NotExtensible
 @ThreadSafety(level=INTERFACE_THREADSAFE)
public interface EntryRebalancingResultAccessLogMessage
extends EntryRebalancingRequestAccessLogMessage

This class provides a data structure that holds information about an 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.

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.
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 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, getMessageType, 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

Method Detail

getResultCode

@Nullable
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

@Nullable
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.

getAdminActionMessage

@Nullable
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.

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
java.lang.Boolean getSourceServerAltered()

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.

getTargetServerAltered

@Nullable
java.lang.Boolean getTargetServerAltered()

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

@Nullable
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

@Nullable
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

@Nullable
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.