com.unboundid.ldap.sdk.unboundidds.monitors

Class ReplicationSummaryReplica

java.lang.Object

com.unboundid.ldap.sdk.unboundidds.monitors.ReplicationSummaryReplica

All Implemented Interfaces:

java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class ReplicationSummaryReplica
extends java.lang.Object
implements java.io.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:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ReplicationSummaryReplica(java.lang.String value) Creates a new replication summary replica object from the provided string representation.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getGenerationID() Retrieves the generation ID for this replica.
java.lang.String	getLDAPServerAddress() Retrieves the address used to communicate with this replica via LDAP.
java.lang.Long	getLDAPServerPort() Retrieves the port number used to communicate with this replica via LDAP.
java.lang.Long	getMissingChanges() Deprecated. Use getReplicationBacklog() instead.
java.util.Date	getOldestBacklogChangeDate() Retrieves the date of the oldest backlog change for this replica.
java.util.Date	getOldestMissingChangeDate() Deprecated. Use getOldestBacklogChangeDate() instead.
java.lang.Long	getPeakUpdateRate() Retrieves the peak update rate for this replica in operations per second.
java.lang.Long	getRecentUpdateRate() Retrieves the recent update rate for this replica in operations per second.
java.lang.String	getReplicaID() Retrieves the replica ID for this replica.
java.lang.Long	getReplicationBacklog() Retrieves the replication backlog, represented as the number of missing changes, for this replica.
java.lang.String	getReplicationServerID() Retrieves the replication server ID for the replication server to which this replica is connected.
java.lang.String	toString() Retrieves a string representation of this replication summary replica.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ReplicationSummaryReplica

public ReplicationSummaryReplica(@NotNull
                                 java.lang.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 Detail

getReplicaID

@Nullable
public java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.util.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 java.util.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 java.lang.String toString()

Retrieves a string representation of this replication summary replica.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this replication summary replica.