com.unboundid.ldap.sdk.unboundidds.controls
Class AssuredReplicationServerResult

java.lang.Object
  extended by com.unboundid.ldap.sdk.unboundidds.controls.AssuredReplicationServerResult
All Implemented Interfaces:
java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class AssuredReplicationServerResult
extends java.lang.Object
implements java.io.Serializable

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 defines a data structure that provides information about the result of assured replication processing, either on a replication server (if that is all that is needed to satisfy the desired level of assurance) or on a directory server (if required by the desired level of assurance).

See Also:
Serialized Form

Constructor Summary
AssuredReplicationServerResult(AssuredReplicationServerResultCode resultCode, java.lang.Short replicationServerID, java.lang.Short replicaID)
          Creates a new assured replication server result with the provided information.
 
Method Summary
 java.lang.Short getReplicaID()
          Retrieves the replica ID for the directory server with which this server result is associated, if applicable.
 java.lang.Short getReplicationServerID()
          Retrieves the server ID for the replication server from which this server result was obtained, if available.
 AssuredReplicationServerResultCode getResultCode()
          Retrieves the result code that indicates the state of assurance processing for this server result.
 java.lang.String toString()
          Retrieves a string representation of this assured replication server result.
 void toString(java.lang.StringBuilder buffer)
          Appends a string representation of this assured replication server result to the provided buffer.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AssuredReplicationServerResult

public AssuredReplicationServerResult(AssuredReplicationServerResultCode resultCode,
                                      java.lang.Short replicationServerID,
                                      java.lang.Short replicaID)
Creates a new assured replication server result with the provided information.

Parameters:
resultCode - The result code that indicates the state of assurance processing for the associated replication server and/or directory server. It must not be null.
replicationServerID - The server ID of the replication server from which this server result was obtained. It may be null if no replication server ID is available for this result.
replicaID - The replica ID of the directory server with which this result is associated. It may be null if no replica ID is available for this result.
Method Detail

getResultCode

public AssuredReplicationServerResultCode getResultCode()
Retrieves the result code that indicates the state of assurance processing for this server result.

Returns:
The result code for this server result.

getReplicationServerID

public java.lang.Short getReplicationServerID()
Retrieves the server ID for the replication server from which this server result was obtained, if available.

Returns:
The server ID for the replication server from which this server result was obtained, or null if no replication server ID is available.

getReplicaID

public java.lang.Short getReplicaID()
Retrieves the replica ID for the directory server with which this server result is associated, if applicable.

Returns:
The replica ID for the directory server with which this server result is associated, or null if there is no associated directory server.

toString

public java.lang.String toString()
Retrieves a string representation of this assured replication server result.

Overrides:
toString in class java.lang.Object
Returns:
A string representation of this assured replication server result.

toString

public void toString(java.lang.StringBuilder buffer)
Appends a string representation of this assured replication server result to the provided buffer.

Parameters:
buffer - The buffer to which the information should be appended.