ReplicaMonitorEntry (UnboundID LDAP SDK for Java 6.0.11)

java.lang.Object
- com.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry
- - com.unboundid.ldap.sdk.unboundidds.monitors.ReplicaMonitorEntry

All Implemented Interfaces:

java.io.Serializable
```
@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class ReplicaMonitorEntry
extends MonitorEntry
```
This class defines a monitor entry that provides information about the state of a replica, including the base DN, replica ID, and generation ID, as well as information about its communication with the replication server

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.

The server should present a replica monitor entry for each replicated base DN. They can be retrieved using the 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.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

ReplicaMonitorEntry(Entry entry)
Creates a new replica monitor entry from the provided entry.

Constructors
Constructor and Description
`ReplicaMonitorEntry(Entry entry)` Creates a new replica monitor entry from the provided entry.

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`getBaseDN()` Retrieves the base DN for this replica.
`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`	`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.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`	`getReceivedUpdates()` Retrieves the number of updates that this replica has received from the replication server.
`java.lang.String`	`getReplicaID()` Retrieves the replica ID for this replica.
`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`	`getSentUpdates()` Retrieves the number of updates that this replica has sent to the replication server.
`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`	`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.

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry
addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, decode, getBoolean, getDate, getDN, getDouble, getEntry, getInteger, getLong, getMonitorClass, getMonitorName, getString, getStrings, toString, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ReplicaMonitorEntry
```
public ReplicaMonitorEntry(@NotNull
                   Entry entry)
```
    Creates a new replica monitor entry from the provided entry.
    
    Parameters:
    entry - The entry to be parsed as a replica monitor entry. It must not be null.
- Method Detail
  - getBaseDN
```
@Nullable
public java.lang.String getBaseDN()
```
    Retrieves the base DN for this replica.
    
    Returns:
    The base DN for this replica, or null if it was not included in the monitor entry.
  - getReplicaID
```
@Nullable
public java.lang.String getReplicaID()
```
    Retrieves the replica ID for this replica.
    
    Returns:
    The replica ID for this replica, or null if it was not included in the monitor entry.
  - getGenerationID
```
@Nullable
public java.lang.String getGenerationID()
```
    Retrieves the generation ID for this replica.
    
    Returns:
    The generation ID for this replica, or null if it was not included in the monitor entry.
  - getReplicationServerAddress
```
@Nullable
public java.lang.String getReplicationServerAddress()
```
    Retrieves the address of the replication server to which this replica is connected.
    
    Returns:
    The address of the replication server to which this replica is connected, or null if it was not included in the monitor entry.
  - getReplicationServerPort
```
@Nullable
public java.lang.Long getReplicationServerPort()
```
    Retrieves the port number of the replication server to which this replica is connected.
    
    Returns:
    The port number of the replication server to which this replica is connected, or null if it was not included in the monitor entry.
  - useSSL
```
@Nullable
public java.lang.Boolean useSSL()
```
    Indicates whether this replica uses SSL when communicating with the replication server.
    
    Returns:
    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.
  - getLostConnections
```
@Nullable
public java.lang.Long getLostConnections()
```
    Retrieves the number of times this replica has lost the connection to a replication server.
    
    Returns:
    The number of times this replica has lost the connection to a replication server, or null if it was not included in the monitor entry.
  - getReceivedUpdates
```
@Nullable
public java.lang.Long getReceivedUpdates()
```
    Retrieves the number of updates that this replica has received from the replication server.
    
    Returns:
    The number of updates that this replica has received from the replication server, or null if it was not included in the monitor entry.
  - getSentUpdates
```
@Nullable
public java.lang.Long getSentUpdates()
```
    Retrieves the number of updates that this replica has sent to the replication server.
    
    Returns:
    The number of updates that this replica has sent to the replication server, or null if it was not included in the monitor entry.
  - getPendingUpdates
```
@Nullable
public 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.
    
    Returns:
    The number of updates that are currently in progress in the Directory Server and have not yet been sent to the replication server, or null if it was not included in the monitor entry.
  - getTotalUpdatesReplayed
```
@Nullable
public java.lang.Long getTotalUpdatesReplayed()
```
    Retrieves the total number of updates that have been replayed in this replica.
    
    Returns:
    The total number of updates that have been replayed in this replica, or null if it was not included in the monitor entry.
  - getUpdatesSuccessfullyReplayed
```
@Nullable
public java.lang.Long getUpdatesSuccessfullyReplayed()
```
    Retrieves the number of updates that have been successfully replayed in this replica without conflicts.
    
    Returns:
    The number of updates that have been successfully replayed in this replica without conflicts, or null if it was not included in the monitor entry.
  - getUpdatesReplayedAfterModifyConflict
```
@Nullable
public java.lang.Long getUpdatesReplayedAfterModifyConflict()
```
    Retrieves the number of updates that have been replayed in this replica after automatically resolving a modify conflict.
    
    Returns:
    The number of updates that have been replayed in this replica after automatically resolving a modify conflict, or null if it was not included in the monitor entry.
  - getUpdatesReplayedAfterNamingConflict
```
@Nullable
public java.lang.Long getUpdatesReplayedAfterNamingConflict()
```
    Retrieves the number of updates that have been replayed in this replica after automatically resolving a naming conflict.
    
    Returns:
    The number of updates that have been replayed in this replica after automatically resolving a naming conflict, or null if it was not included in the monitor entry.
  - getUnresolvedNamingConflicts
```
@Nullable
public 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.
    
    Returns:
    The number of updates that could not be replayed as a result of a naming conflict that could not be automatically resolved, or null if it was not included in the monitor entry.
  - getCurrentReceiveWindowSize
```
@Nullable
public java.lang.Long getCurrentReceiveWindowSize()
```
    Retrieves the current receive window size for this replica.
    
    Returns:
    The current receive window size for this replica, or null if it was not included in the monitor entry.
  - getCurrentSendWindowSize
```
@Nullable
public java.lang.Long getCurrentSendWindowSize()
```
    Retrieves the current send window size for this replica.
    
    Returns:
    The current send window size for this replica, or null if it was not included in the monitor entry.
  - getMaximumReceiveWindowSize
```
@Nullable
public java.lang.Long getMaximumReceiveWindowSize()
```
    Retrieves the maximum receive window size for this replica.
    
    Returns:
    The maximum receive window size for this replica, or null if it was not included in the monitor entry.
  - getMaximumSendWindowSize
```
@Nullable
public java.lang.Long getMaximumSendWindowSize()
```
    Retrieves the maximum send window size for this replica.
    
    Returns:
    The maximum send window size for this replica, or null if it was not included in the monitor entry.
  - getMonitorDisplayName
```
@NotNull
public java.lang.String getMonitorDisplayName()
```
    Retrieves a human-readable display name for this monitor entry.
    
    Overrides:
    
    getMonitorDisplayName in class MonitorEntry
    
    Returns:
    A human-readable display name for this monitor entry.
  - getMonitorDescription
```
@NotNull
public java.lang.String getMonitorDescription()
```
    Retrieves a human-readable description name for this monitor entry.
    
    Overrides:
    
    getMonitorDescription in class MonitorEntry
    
    Returns:
    A human-readable description name for this monitor entry.
  - getMonitorAttributes
```
@NotNull
public 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.
    
    Overrides:
    
    getMonitorAttributes in class MonitorEntry
    
    Returns:
    The set of parsed monitor attributes for this monitor entry.

Class ReplicaMonitorEntry

Constructor Summary

Method Summary

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry

Methods inherited from class java.lang.Object

Constructor Detail

ReplicaMonitorEntry

Method Detail

getBaseDN

getReplicaID

getGenerationID

getReplicationServerAddress

getReplicationServerPort

useSSL

getLostConnections

getReceivedUpdates

getSentUpdates

getPendingUpdates

getTotalUpdatesReplayed

getUpdatesSuccessfullyReplayed

getUpdatesReplayedAfterModifyConflict

getUpdatesReplayedAfterNamingConflict

getUnresolvedNamingConflicts

getCurrentReceiveWindowSize

getCurrentSendWindowSize

getMaximumReceiveWindowSize

getMaximumSendWindowSize

getMonitorDisplayName

getMonitorDescription

getMonitorAttributes