@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ReplicaMonitorEntry extends MonitorEntry
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.
MonitorManager.getReplicaMonitorEntries(com.unboundid.ldap.sdk.LDAPConnection)
method. These entries
provide specific methods for accessing information about the replica.
Alternately, this information may be accessed using the generic API. See the
MonitorManager
class documentation for an example that demonstrates
the use of the generic API for accessing monitor data.Constructor and Description |
---|
ReplicaMonitorEntry(Entry entry)
Creates a new replica monitor entry from the provided entry.
|
Modifier and Type | Method and Description |
---|---|
java.lang.Long |
getAgeOfOldestPendingUpdateMillis()
Retrieves the age, in milliseconds, of the oldest operation in the
pending changes queue.
|
java.lang.String |
getBaseDN()
Retrieves the base DN for this replica.
|
java.lang.Long |
getConflictEntryCount()
Retrieves the number of conflict entries that currently exist in the
associated backend.
|
java.lang.Long |
getCurrentReceiveWindowSize()
Retrieves the current receive window size for this replica.
|
java.lang.Long |
getCurrentSendWindowSize()
Retrieves the current send window size for this replica.
|
java.lang.String |
getGenerationID()
Retrieves the generation ID for this replica.
|
java.lang.Long |
getLastUpdateLatencyMillis()
Retrieves the latency, in milliseconds, of the last update that was
successfully replayed.
|
java.lang.Long |
getLostConnections()
Retrieves the number of times this replica has lost the connection to a
replication server.
|
java.lang.Long |
getMaximumReceiveWindowSize()
Retrieves the maximum receive window size for this replica.
|
java.lang.Long |
getMaximumSendWindowSize()
Retrieves the maximum send window size for this replica.
|
java.util.Map<java.lang.String,MonitorAttribute> |
getMonitorAttributes()
Retrieves the set of parsed monitor attributes for this monitor entry,
mapped from a unique identifier (in all lowercase characters) to the
corresponding monitor attribute.
|
java.lang.String |
getMonitorDescription()
Retrieves a human-readable description name for this monitor entry.
|
java.lang.String |
getMonitorDisplayName()
Retrieves a human-readable display name for this monitor entry.
|
java.util.Date |
getOldestBacklogChangeTime()
Retrieves the completion time for the oldest change that has been applied
in one or other replicas but has not yet been applied in the local server.
|
java.lang.Long |
getPendingChangesCurrentUncommittedSize()
Retrieves the number of changes in the pending changes queue that have not
yet been committed to the local database.
|
java.lang.Long |
getPendingChangesLargestSizeReached()
Retrieves the largest number of operations that have been in the pending
changes queue at any time.
|
java.lang.Long |
getPendingChangesMaxCapacity()
Retrieves the maximum number of operations that may be held in the
pending changes queue.
|
java.lang.Long |
getPendingChangesNumTimesAddedToFullQueue()
Retrieves the number of times that the server attempted to add a change to
the pending changes queue when it was already full.
|
java.lang.Long |
getPendingChangesNumTimesStallLogged()
Retrieves the number of times that the server has logged that an operation
in the pending changes queue has stalled.
|
java.lang.Long |
getPendingUpdates()
Retrieves the number of updates that are currently in progress in the
Directory Server and have not yet been sent to the replication server.
|
java.lang.Long |
getReceivedAcks()
Retrieves the number of acknowledgements that this replica has received
from other servers.
|
java.lang.Long |
getReceivedUpdates()
Retrieves the number of updates that this replica has received from the
replication server.
|
java.lang.Long |
getRecentAverageLatencyMillis()
Retrieves the average replication latency, in milliseconds, for operations
processed over a recent interval.
|
java.lang.Long |
getRecentMaximumLatencyMillis()
Retrieves the maximum replication latency, in milliseconds, for any
operation processed over a recent interval.
|
java.lang.Long |
getRecentMinimumLatencyMillis()
Retrieves the minimum replication latency, in milliseconds, for any
operation processed over a recent interval.
|
java.lang.Long |
getRecentNegativeLatencyUpdateCount()
Retrieves the number of negative replication latencies encountered over a
recent interval.
|
java.lang.Long |
getRecentSumLatencyMillis()
Retrieves the sum of latencies, in milliseconds, for operations processed
over a recent interval.
|
java.lang.Long |
getRecentUpdateCount()
Retrieves the number of operations processed over the recent interval used
for recent replication latency calculations.
|
java.lang.String |
getReplicaID()
Retrieves the replica ID for this replica.
|
java.lang.Long |
getReplicationAssuranceCompletedAbnormally()
Retrieves the number of changes that were processed with replication
assurance but could not be completed successfully within the assurance
constraints.
|
java.lang.Long |
getReplicationAssuranceCompletedNormally()
Retrieves the number of changes that were processed with replication
assurance and completed successfully within the assurance constraints.
|
java.lang.Long |
getReplicationAssuranceCompletedWithShutdown()
Retrieves the number of changes that were processed with replication
assurance but could not be completed successfully within the assurance
constraints because of a server shutdown.
|
java.lang.Long |
getReplicationAssuranceCompletedWithTimeout()
Retrieves the number of changes that were processed with replication
assurance but could not be completed successfully within the assurance
constraints because a timeout was encountered.
|
java.lang.Long |
getReplicationAssuranceSubmittedOperations()
Retrieves the number of changes that have begun processing with replication
assurance enabled.
|
java.lang.Long |
getReplicationBacklog()
Retrieves the number of changes that have been applied in one or more other
replicas but have not yet been applied in the local server.
|
java.lang.String |
getReplicationServerAddress()
Retrieves the address of the replication server to which this replica is
connected.
|
java.lang.Long |
getReplicationServerPort()
Retrieves the port number of the replication server to which this replica
is connected.
|
java.lang.Long |
getRequeueRetryAddFailedCount()
Retrieves the number of add operations that failed on their initial
attempt, were requeued, and failed again on a retry.
|
java.lang.Long |
getRequeueRetryAddSuccessCount()
Retrieves the number of add operations that failed on their initial
attempt, but that were requeued and succeeded on a retry.
|
java.lang.Long |
getRequeueRetryDeleteFailedCount()
Retrieves the number of delete operations that failed on their initial
attempt, were requeued, and failed again on a retry.
|
java.lang.Long |
getRequeueRetryDeleteSuccessCount()
Retrieves the number of delete operations that failed on their initial
attempt, but that were requeued and succeeded on a retry.
|
java.lang.Long |
getRequeueRetryModifyDNFailedCount()
Retrieves the number of modify DN operations that failed on their initial
attempt, were requeued, and failed again on a retry.
|
java.lang.Long |
getRequeueRetryModifyDNSuccessCount()
Retrieves the number of modify DN operations that failed on their initial
attempt, but that were requeued and succeeded on a retry.
|
java.lang.Long |
getRequeueRetryModifyFailedCount()
Retrieves the number of modify operations that failed on their initial
attempt, were requeued, and failed again on a retry.
|
java.lang.Long |
getRequeueRetryModifySuccessCount()
Retrieves the number of modify operations that failed on their initial
attempt, but that were requeued and succeeded on a retry.
|
java.lang.Long |
getRequeueRetryOpFailedCount()
Retrieves the number of operations of any type that failed on their initial
attempt, were requeued, and failed again on a retry.
|
java.lang.Long |
getRequeueRetryOpSuccessCount()
Retrieves the number of operations of any type that failed on their initial
attempt, but that were requeued and succeeded on a retry.
|
java.lang.Double |
getRequeueRetrySuccessAverageDurationMillis()
Retrieves the average length of time, in milliseconds, required to
successfully process operations on a retry attempt after the initial
failure.
|
java.lang.Double |
getRequeueRetrySuccessMaximumDurationMillis()
Retrieves the maximum length of time, in milliseconds, required to
successfully process an operation on a retry attempt after the initial
failure.
|
java.lang.Long |
getRequeueRetrySuccessTotalDurationMillis()
Retrieves the total length of time, in milliseconds, required to process
operations that succeeded on a retry attempt after an initial failure.
|
java.lang.Long |
getSentAcks()
Retrieves the number of acknowledgements that this replica has sent to
other servers.
|
java.lang.Long |
getSentUpdates()
Retrieves the number of updates that this replica has sent to the
replication server.
|
java.lang.Long |
getTotalAverageLatencyMillis()
Retrieves the average replication latency, in milliseconds, for operations
processed since the server was started.
|
java.lang.Long |
getTotalMaximumLatencyMillis()
Retrieves the maximum replication latency, in milliseconds, for any
operation processed since the server was started.
|
java.lang.Long |
getTotalMinimumLatencyMillis()
Retrieves the minimum replication latency, in milliseconds, for any
operation processed since the server was started.
|
java.lang.Long |
getTotalNegativeLatencyUpdateCount()
Retrieves the number of negative replication latencies encountered since
the server was started.
|
java.lang.Long |
getTotalSumLatencyMillis()
Retrieves the sum of latencies, in milliseconds, for operations processed
since the server was started.
|
java.lang.Long |
getTotalUpdateCount()
Retrieves the total number of replicated operations processed since the
server started.
|
java.lang.Long |
getTotalUpdatesReplayed()
Retrieves the total number of updates that have been replayed in this
replica.
|
java.lang.Long |
getUnresolvedNamingConflicts()
Retrieves the number of updates that could not be replayed as a result of a
naming conflict that could not be automatically resolved.
|
java.lang.Long |
getUpdateReplayFailures()
Retrieves the number of failures that have occurred while attempting to
replay changes.
|
java.lang.Long |
getUpdatesReplayedAfterModifyConflict()
Retrieves the number of updates that have been replayed in this replica
after automatically resolving a modify conflict.
|
java.lang.Long |
getUpdatesReplayedAfterNamingConflict()
Retrieves the number of updates that have been replayed in this replica
after automatically resolving a naming conflict.
|
java.lang.Long |
getUpdatesSuccessfullyReplayed()
Retrieves the number of updates that have been successfully replayed in
this replica without conflicts.
|
java.lang.Boolean |
useSSL()
Indicates whether this replica uses SSL when communicating with the
replication server.
|
addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, decode, getBoolean, getDate, getDN, getDouble, getEntry, getInteger, getLong, getMonitorClass, getMonitorName, getString, getStrings, toString, toString
public ReplicaMonitorEntry(@NotNull Entry entry)
entry
- The entry to be parsed as a replica monitor entry. It must
not be null
.@Nullable public java.lang.String getBaseDN()
null
if it was not
included in the monitor entry.@Nullable public java.lang.String getReplicaID()
null
if it was not
included in the monitor entry.@Nullable public java.lang.String getGenerationID()
null
if it was not
included in the monitor entry.@Nullable public java.lang.String getReplicationServerAddress()
null
if it was not included in the monitor
entry.@Nullable public java.lang.Long getReplicationServerPort()
null
if it was not included in the monitor
entry.@Nullable public java.lang.Boolean useSSL()
Boolean.TRUE
if this replica uses SSL when communicating
with the replication server, Boolean.FALSE
if it does not
use SSL, or null
if it was not included in the monitor
entry.@Nullable public java.lang.Long getLostConnections()
null
if it was not included in the
monitor entry.@Nullable public java.lang.Long getTotalUpdateCount()
null
if it was not included in the
monitor entry.@Nullable public java.lang.Long getReceivedUpdates()
null
if it was not included in the
monitor entry.@Nullable public java.lang.Long getSentUpdates()
null
if it was not included in the
monitor entry.@Nullable public java.lang.Long getReceivedAcks()
null
if it was not included in the
monitor entry.@Nullable public java.lang.Long getSentAcks()
null
if it was not included in the
monitor entry.@Nullable public java.lang.Long getPendingUpdates()
null
if it was not included in the monitor
entry.@Nullable public java.lang.Long getTotalUpdatesReplayed()
null
if it was not included in the monitor
entry.@Nullable public java.lang.Long getUpdatesSuccessfullyReplayed()
null
if it was not included
in the monitor entry.@Nullable public java.lang.Long getUpdateReplayFailures()
null
if it was not included in the
monitor entry.@Nullable public java.lang.Long getUpdatesReplayedAfterModifyConflict()
null
if it was not included in the monitor entry.@Nullable public java.lang.Long getUpdatesReplayedAfterNamingConflict()
null
if it was not included in the monitor entry.@Nullable public java.lang.Long getUnresolvedNamingConflicts()
null
if it was not included in the monitor entry.@Nullable public java.lang.Long getConflictEntryCount()
null
if it was not included in the
monitor entry.
The name of the attribute that contains the number of conflict entries
that currently exist in the associated backend.@Nullable public java.lang.Long getCurrentReceiveWindowSize()
null
if it was not included in the monitor entry.@Nullable public java.lang.Long getCurrentSendWindowSize()
null
if
it was not included in the monitor entry.@Nullable public java.lang.Long getMaximumReceiveWindowSize()
null
if it was not included in the monitor entry.@Nullable public java.lang.Long getMaximumSendWindowSize()
null
if
it was not included in the monitor entry.@Nullable public java.lang.Long getReplicationBacklog()
null
if it was not included in the monitor entry.@Nullable public java.util.Date getOldestBacklogChangeTime()
null
if it was not included in the
monitor entry.@Nullable public java.lang.Long getPendingChangesCurrentUncommittedSize()
null
if it
was not included in the monitor entry.@Nullable public java.lang.Long getAgeOfOldestPendingUpdateMillis()
null
if it was not included in the
monitor entry.@Nullable public java.lang.Long getPendingChangesMaxCapacity()
null
if it was not included in the
monitor entry.@Nullable public java.lang.Long getPendingChangesLargestSizeReached()
null
if it was not included
in the monitor entry.@Nullable public java.lang.Long getPendingChangesNumTimesAddedToFullQueue()
null
if it was not included in the monitor entry.@Nullable public java.lang.Long getPendingChangesNumTimesStallLogged()
null
if it
was not included in the monitor entry.@Nullable public java.lang.Long getLastUpdateLatencyMillis()
null
if it was not included in
the monitor entry.@Nullable public java.lang.Long getRecentAverageLatencyMillis()
null
if it was not
included in the monitor entry.@Nullable public java.lang.Long getRecentMaximumLatencyMillis()
null
if it
was not included in the monitor entry.@Nullable public java.lang.Long getRecentMinimumLatencyMillis()
null
if it
was not included in the monitor entry.@Nullable public java.lang.Long getRecentNegativeLatencyUpdateCount()
null
if it was not included in the
monitor entry.@Nullable public java.lang.Long getRecentSumLatencyMillis()
null
if it was not included in
the monitor entry.@Nullable public java.lang.Long getRecentUpdateCount()
null
if it was not included in the monitor entry.@Nullable public java.lang.Long getTotalAverageLatencyMillis()
null
if it was
not included in the monitor entry.@Nullable public java.lang.Long getTotalMaximumLatencyMillis()
null
if it was not included in the monitor entry.@Nullable public java.lang.Long getTotalMinimumLatencyMillis()
null
if it was not included in the monitor entry.@Nullable public java.lang.Long getTotalNegativeLatencyUpdateCount()
null
if it was not included in the
monitor entry.@Nullable public java.lang.Long getTotalSumLatencyMillis()
@Nullable public java.lang.Long getReplicationAssuranceSubmittedOperations()
null
if it was not included in the
monitor entry.@Nullable public java.lang.Long getReplicationAssuranceCompletedNormally()
null
if it was not included in the monitor
entry.@Nullable public java.lang.Long getReplicationAssuranceCompletedAbnormally()
null
if it was not included in
the monitor entry.@Nullable public java.lang.Long getReplicationAssuranceCompletedWithTimeout()
null
if it was not included in the monitor entry.@Nullable public java.lang.Long getReplicationAssuranceCompletedWithShutdown()
null
if it was not included in the monitor entry.@Nullable public java.lang.Long getRequeueRetryOpSuccessCount()
null
if it was not included in the monitor entry.@Nullable public java.lang.Long getRequeueRetryOpFailedCount()
null
if it was not included in the monitor entry.@Nullable public java.lang.Long getRequeueRetryAddSuccessCount()
null
if it was not included in the monitor entry.@Nullable public java.lang.Long getRequeueRetryAddFailedCount()
null
if it
was not included in the monitor entry.@Nullable public java.lang.Long getRequeueRetryDeleteSuccessCount()
null
if it was not included in the monitor entry.@Nullable public java.lang.Long getRequeueRetryDeleteFailedCount()
null
if it was not included in the monitor entry.@Nullable public java.lang.Long getRequeueRetryModifySuccessCount()
null
if it was not included in the monitor entry.@Nullable public java.lang.Long getRequeueRetryModifyFailedCount()
null
if it was not included in the monitor entry.@Nullable public java.lang.Long getRequeueRetryModifyDNSuccessCount()
null
if it was not included in the monitor entry.@Nullable public java.lang.Long getRequeueRetryModifyDNFailedCount()
null
if it was not included in the monitor entry.@Nullable public java.lang.Double getRequeueRetrySuccessAverageDurationMillis()
null
if it was not included in the
monitor entry.@Nullable public java.lang.Double getRequeueRetrySuccessMaximumDurationMillis()
null
if it was not included in the
monitor entry.@Nullable public java.lang.Long getRequeueRetrySuccessTotalDurationMillis()
null
if it was not included in the monitor
entry.@NotNull public java.lang.String getMonitorDisplayName()
getMonitorDisplayName
in class MonitorEntry
@NotNull public java.lang.String getMonitorDescription()
getMonitorDescription
in class MonitorEntry
@NotNull public java.util.Map<java.lang.String,MonitorAttribute> getMonitorAttributes()
getMonitorAttributes
in class MonitorEntry