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

java.lang.Object
  extended by com.unboundid.ldap.sdk.unboundidds.logs.LogMessage
      extended by com.unboundid.ldap.sdk.unboundidds.logs.AccessLogMessage
          extended by 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

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
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.

See Also:
Serialized Form

Constructor Summary
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
 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(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(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

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

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

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

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

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

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

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

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

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

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.