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
,java.io.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(java.lang.String logMessageString)
Creates a new text-formatted entry rebalancing request access log message from the provided message string.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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
getTriggeredByConnectionID()
Retrieves the connection ID for the connection that performed an operation to trigger the entry rebalancing operation.java.lang.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 Detail
-
TextFormattedEntryRebalancingRequestAccessLogMessage
public TextFormattedEntryRebalancingRequestAccessLogMessage(@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 benull
.- 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 interfaceAccessLogMessage
- Returns:
- The message type for this access log message.
-
getRebalancingOperationID
@Nullable public final java.lang.Long getRebalancingOperationID()
Retrieves the unique identifier assigned to the entry rebalancing operation.- Specified by:
getRebalancingOperationID
in interfaceEntryRebalancingRequestAccessLogMessage
- 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 java.lang.Long getTriggeredByConnectionID()
Retrieves the connection ID for the connection that performed an operation to trigger the entry rebalancing operation.- Specified by:
getTriggeredByConnectionID
in interfaceEntryRebalancingRequestAccessLogMessage
- 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 java.lang.Long getTriggeredByOperationID()
Retrieves the operation ID for the operation that triggered the entry rebalancing operation.- Specified by:
getTriggeredByOperationID
in interfaceEntryRebalancingRequestAccessLogMessage
- 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.- Specified by:
getSubtreeBaseDN
in interfaceEntryRebalancingRequestAccessLogMessage
- 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.- Specified by:
getSizeLimit
in interfaceEntryRebalancingRequestAccessLogMessage
- 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.- Specified by:
getSourceBackendSetName
in interfaceEntryRebalancingRequestAccessLogMessage
- 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.- Specified by:
getSourceBackendServer
in interfaceEntryRebalancingRequestAccessLogMessage
- 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.- Specified by:
getTargetBackendSetName
in interfaceEntryRebalancingRequestAccessLogMessage
- 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.- Specified by:
getTargetBackendServer
in interfaceEntryRebalancingRequestAccessLogMessage
- 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.
-
-