com.unboundid.ldap.sdk.unboundidds.logs

Class EntryRebalancingResultAccessLogMessage

java.lang.Object

com.unboundid.ldap.sdk.unboundidds.logs.LogMessage

com.unboundid.ldap.sdk.unboundidds.logs.AccessLogMessage

com.unboundid.ldap.sdk.unboundidds.logs.EntryRebalancingRequestAccessLogMessage

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

All Implemented Interfaces:

java.io.Serializable

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

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.

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

Constructor Summary

Constructors

Constructor and Description
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

Modifier and Type	Method and Description
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(@NotNull
                                              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(@NotNull
                                              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

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

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

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

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

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

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

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

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

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