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

Class TextFormattedEntryRebalancingRequestAccessLogMessage

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

All Implemented Interfaces:

AccessLogMessage, EntryRebalancingRequestAccessLogMessage, LogMessage, Serializable

Direct Known Subclasses:

TextFormattedEntryRebalancingResultAccessLogMessage

@NotExtensible
@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public class TextFormattedEntryRebalancingRequestAccessLogMessage
extends TextFormattedAccessLogMessage
implements EntryRebalancingRequestAccessLogMessage

This class provides a data structure that holds information about a text-formatted entry rebalancing request 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	Description
TextFormattedEntryRebalancingRequestAccessLogMessage(String logMessageString)	Creates a new text-formatted entry rebalancing request access log message from the provided message string.

Method Summary

Modifier and Type	Method	Description
AccessLogMessageType	getMessageType()	Retrieves the message type for this access log message.
final Long	getRebalancingOperationID()	Retrieves the unique identifier assigned to the entry rebalancing operation.
final Integer	getSizeLimit()	Retrieves the maximum number of entries that may be contained in the subtree for it to be successfully migrated.
final String	getSourceBackendServer()	The address and port of the backend server from which the subtree will be migrated.
final String	getSourceBackendSetName()	Retrieves the name of the backend set containing the subtree to be migrated.
final String	getSubtreeBaseDN()	Retrieves the base DN of the subtree that will be migrated during the entry rebalancing operation.
final String	getTargetBackendServer()	Retrieves the address and port of the backend server to which the subtree will be migrated.
final String	getTargetBackendSetName()	Retrieves the name of the backend set to which the subtree will be migrated.
final Long	getTriggeredByConnectionID()	Retrieves the connection ID for the connection that performed an operation to trigger the entry rebalancing operation.
final Long	getTriggeredByOperationID()	Retrieves the operation ID for the operation that triggered the entry rebalancing operation.

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.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 Details

TextFormattedEntryRebalancingRequestAccessLogMessage

public TextFormattedEntryRebalancingRequestAccessLogMessage(@NotNull
 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 Details

getMessageType

@NotNull
public AccessLogMessageType getMessageType()

Retrieves the message type for this access log message.

Specified by:

getMessageType in interface AccessLogMessage

Returns:

The message type for this access log message.

getRebalancingOperationID

@Nullable
public final Long getRebalancingOperationID()

Retrieves the unique identifier assigned to the entry rebalancing operation.

Specified by:

getRebalancingOperationID in interface EntryRebalancingRequestAccessLogMessage

Returns:

The unique identifier assigned to the entry rebalancing operation, or null if it is not included in the log message.

getTriggeredByConnectionID

@Nullable
public final Long getTriggeredByConnectionID()

Retrieves the connection ID for the connection that performed an operation to trigger the entry rebalancing operation.

Specified by:

getTriggeredByConnectionID in interface EntryRebalancingRequestAccessLogMessage

Returns:

Retrieves the connection ID for the connection that performed an operation to trigger the entry rebalancing operation, or null if it is not included in the log message.

getTriggeredByOperationID

@Nullable
public final Long getTriggeredByOperationID()

Retrieves the operation ID for the operation that triggered the entry rebalancing operation.

Specified by:

getTriggeredByOperationID in interface EntryRebalancingRequestAccessLogMessage

Returns:

Retrieves the operation ID for the operation that triggered the entry rebalancing operation, or null if it is not included in the log message.

getSubtreeBaseDN

@Nullable
public final String getSubtreeBaseDN()

Retrieves the base DN of the subtree that will be migrated during the entry rebalancing operation.

Specified by:

getSubtreeBaseDN in interface EntryRebalancingRequestAccessLogMessage

Returns:

The base DN of the subtree that will be migrated during the entry rebalancing operation, or null if it is not included in the log message.

getSizeLimit

@Nullable
public final Integer getSizeLimit()

Retrieves the maximum number of entries that may be contained in the subtree for it to be successfully migrated.

Specified by:

getSizeLimit in interface EntryRebalancingRequestAccessLogMessage

Returns:

The maximum number of entries that may be contained in the subtree for it to be successfully migrated, or null if it is not included in the log message.

getSourceBackendSetName

@Nullable
public final String getSourceBackendSetName()

Retrieves the name of the backend set containing the subtree to be migrated.

Specified by:

getSourceBackendSetName in interface EntryRebalancingRequestAccessLogMessage

Returns:

The name of the backend set containing the subtree to be migrated, or null if it is not included in the log message.

getSourceBackendServer

@Nullable
public final String getSourceBackendServer()

The address and port of the backend server from which the subtree will be migrated.

Specified by:

getSourceBackendServer in interface EntryRebalancingRequestAccessLogMessage

Returns:

The address and port of the backend server from which the subtree will be migrated, or null if it is not included in the log message.

getTargetBackendSetName

@Nullable
public final String getTargetBackendSetName()

Retrieves the name of the backend set to which the subtree will be migrated.

Specified by:

getTargetBackendSetName in interface EntryRebalancingRequestAccessLogMessage

Returns:

The name of the backend set ot which the subtree will be migrated, or null if it is not included in the log message.

getTargetBackendServer

@Nullable
public final String getTargetBackendServer()

Retrieves the address and port of the backend server to which the subtree will be migrated.

Specified by:

getTargetBackendServer in interface EntryRebalancingRequestAccessLogMessage

Returns:

The address and port of the backend server to which the subtree will be migrated, or null if it is not included in the log message.