com.unboundid.ldap.sdk.unboundidds.logs

Class EntryRebalancingRequestAccessLogMessage

java.lang.Object

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

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

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

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

EntryRebalancingResultAccessLogMessage

@NotMutable
 @NotExtensible
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public class EntryRebalancingRequestAccessLogMessage
extends AccessLogMessage

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 beginning 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
EntryRebalancingRequestAccessLogMessage(LogMessage m) Creates a new entry rebalancing request access log message from the provided log message.
EntryRebalancingRequestAccessLogMessage(java.lang.String s) Creates a new entry rebalancing request access log message from the provided message string.

Method Summary

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

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

EntryRebalancingRequestAccessLogMessage

public EntryRebalancingRequestAccessLogMessage(@NotNull
                                               java.lang.String s)
                                        throws LogException

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

Parameters:

s - The string to be parsed as an entry rebalancing request access log message.

Throws:

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

EntryRebalancingRequestAccessLogMessage

public EntryRebalancingRequestAccessLogMessage(@NotNull
                                               LogMessage m)

Creates a new entry rebalancing request access log message from the provided log message.

Parameters:

m - The log message to be parsed as an entry rebalancing request access log message.

Method Detail

getRebalancingOperationID

@Nullable
public final java.lang.Long getRebalancingOperationID()

Retrieves the unique identifier assigned to the entry rebalancing operation.

Returns:

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

getTriggeringConnectionID

@Nullable
public final java.lang.Long getTriggeringConnectionID()

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

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.

getTriggeringOperationID

@Nullable
public final java.lang.Long getTriggeringOperationID()

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

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 java.lang.String getSubtreeBaseDN()

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

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 java.lang.Integer getSizeLimit()

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

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 java.lang.String getSourceBackendSetName()

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

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 java.lang.String getSourceBackendServer()

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

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 java.lang.String getTargetBackendSetName()

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

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 java.lang.String getTargetBackendServer()

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

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.

getMessageType

@NotNull
public AccessLogMessageType getMessageType()

Retrieves the message type for this access log message.

Specified by:

getMessageType in class AccessLogMessage

Returns:

The message type for this access log message.