Package com.unboundid.ldap.sdk.unboundidds.monitors

Class ReplicationSummaryReplica

java.lang.Object
com.unboundid.ldap.sdk.unboundidds.monitors.ReplicationSummaryReplica
All Implemented Interfaces:
Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ReplicationSummaryReplica extends Object implements Serializable
This class provides a data structure that contains information about a replica contained in a replication summary monitor entry.
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:

  • Constructor Details

    • ReplicationSummaryReplica

      public ReplicationSummaryReplica(@NotNull String value)
      Creates a new replication summary replica object from the provided string representation.
      Parameters:
      value - The value string to be parsed as a replication summary replica object.

  • Method Details

    • getReplicaID

      @Nullable public String getReplicaID()
      Retrieves the replica ID for this replica.
      Returns:
      The replica ID for this replica, or null if that information is not available.

    • getLDAPServerAddress

      @Nullable public String getLDAPServerAddress()
      Retrieves the address used to communicate with this replica via LDAP.
      Returns:
      The address used to communicate with this replica via LDAP, or null if that information is not available.

    • getLDAPServerPort

      @Nullable public Long getLDAPServerPort()
      Retrieves the port number used to communicate with this replica via LDAP.
      Returns:
      The port number used to communicate with this replica via LDAP, or null if that information is not available.

    • getReplicationServerID

      @Nullable public String getReplicationServerID()
      Retrieves the replication server ID for the replication server to which this replica is connected.
      Returns:
      The replication server ID for the replication server to which this replica is connected, or null if that information is not available.

    • getGenerationID

      @Nullable public String getGenerationID()
      Retrieves the generation ID for this replica.
      Returns:
      The generation ID for this replica, or null if that information is not available.

    • getRecentUpdateRate

      @Nullable public Long getRecentUpdateRate()
      Retrieves the recent update rate for this replica in operations per second.
      Returns:
      The recent update rate for this replica in operations per second, or null if that information is not available.

    • getPeakUpdateRate

      @Nullable public Long getPeakUpdateRate()
      Retrieves the peak update rate for this replica in operations per second.
      Returns:
      The peak update rate for this replica in operations per second, or null if that information is not available.

    • getMissingChanges

      @Deprecated @Nullable public Long getMissingChanges()
      Deprecated.
      Use getReplicationBacklog() instead.
      Retrieves the replication backlog, represented as the number of missing changes, for this replica.
      Returns:
      The replication backlog, represented as the number of missing changes, for this replica , or null if that information is not available.

    • getReplicationBacklog

      @Nullable public Long getReplicationBacklog()
      Retrieves the replication backlog, represented as the number of missing changes, for this replica.
      Returns:
      The replication backlog, represented as the number of missing changes, for this replica , or null if that information is not available.

    • getOldestMissingChangeDate

      @Deprecated @Nullable public Date getOldestMissingChangeDate()
      Deprecated.
      Use getOldestBacklogChangeDate() instead.
      Retrieves the date of the oldest backlog change for this replica.
      Returns:
      The date of the oldest backlog change for this replica, or null if that information is not available or there are no backlog changes.

    • getOldestBacklogChangeDate

      @Nullable public Date getOldestBacklogChangeDate()
      Retrieves the date of the oldest backlog change for this replica.
      Returns:
      The date of the oldest backlog change for this replica, or null if that information is not available or there are no backlog changes.

    • toString

      @NotNull public String toString()
      Retrieves a string representation of this replication summary replica.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this replication summary replica.