com.unboundid.ldap.sdk.unboundidds.monitors

Class ReplicationSummaryMonitorEntry

java.lang.Object

com.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry

com.unboundid.ldap.sdk.unboundidds.monitors.ReplicationSummaryMonitorEntry

All Implemented Interfaces:

java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class ReplicationSummaryMonitorEntry
extends MonitorEntry

This class defines a monitor entry that provides summary information about a replicated data set within the Directory 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 will present a replication summary monitor entry for each base DN for which replication is enabled, and it will include information about each replica and replication server processing changes for that base DN. Replication summary monitor entries can be retrieved using the MonitorManager.getReplicationSummaryMonitorEntries(com.unboundid.ldap.sdk.LDAPConnection) method. The getBaseDN() method may be used to retrieve information about the replicated base DN, the getReplicationServers() method may be used to retrieve information about the replication servers for that base DN, and the getReplicas() method may be used to retrieve information about the replicas for that base DN. 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
ReplicationSummaryMonitorEntry(Entry entry) Creates a new replication summary monitor entry from the provided entry.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBaseDN() Retrieves the base DN for this replication summary monitor entry.
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.List<ReplicationSummaryReplica>	getReplicas() Retrieves a list of information about the replicas described in this replication server summary monitor entry.
java.util.List<ReplicationSummaryReplicationServer>	getReplicationServers() Retrieves a list of information about the replication servers described in this replication server summary monitor entry.

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

ReplicationSummaryMonitorEntry

public ReplicationSummaryMonitorEntry(@NotNull
                                      Entry entry)

Creates a new replication summary monitor entry from the provided entry.

Parameters:

entry - The entry to be parsed as a replication summary monitor entry. It must not be null.

Method Detail

getBaseDN

@Nullable
public java.lang.String getBaseDN()

Retrieves the base DN for this replication summary monitor entry.

Returns:

The base DN for this replication summary monitor entry, or null if it was not included in the monitor entry.

getReplicas

@NotNull
public java.util.List<ReplicationSummaryReplica> getReplicas()

Retrieves a list of information about the replicas described in this replication server summary monitor entry.

Returns:

A list of information about the replicas described in this replication server summary monitor entry, or an empty list if it was not included in the monitor entry.

getReplicationServers

@NotNull
public java.util.List<ReplicationSummaryReplicationServer> getReplicationServers()

Retrieves a list of information about the replication servers described in this replication server summary monitor entry.

Returns:

A list of information about the replication servers described in this replication server summary monitor entry, or an empty list 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.