com.unboundid.ldap.sdk.unboundidds.monitors

Class ReplicationServerMonitorEntry

java.lang.Object

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

com.unboundid.ldap.sdk.unboundidds.monitors.ReplicationServerMonitorEntry

All Implemented Interfaces:

java.io.Serializable

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

This class defines a monitor entry that provides information about the state of a replication server, including the base DNs for replicated content, the generation ID for each of those base DNs, the replication server ID, and the port number on which the replication server is listening.

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 at most one replication server monitor entry. It can be retrieved using the MonitorManager.getReplicationServerMonitorEntry(com.unboundid.ldap.sdk.LDAPConnection) method. This entry provides specific methods for accessing information about the replication server. 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
ReplicationServerMonitorEntry(Entry entry) Creates a new replication server monitor entry from the provided entry.

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getBaseDNs() Retrieves the base DNs for replicated content managed by this replication server.
java.lang.String	getGenerationID(DN baseDN) Retrieves the generation ID for the specified base DN.
java.lang.String	getGenerationID(java.lang.String baseDN) Retrieves the generation ID for the specified base DN.
java.util.Map<DN,java.lang.String>	getGenerationIDs() Retrieves a map of generation IDs for the available base DNs.
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.String	getReplicationServerID() Retrieves the server ID for the replication server.
java.lang.Long	getReplicationServerPort() Retrieves the port number for the replication server.
java.lang.Boolean	sslEncryptionAvailable() Indicates whether the replication server provides support for SSL encryption.

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

ReplicationServerMonitorEntry

public ReplicationServerMonitorEntry(@NotNull
                                     Entry entry)

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

Parameters:

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

Method Detail

getBaseDNs

@NotNull
public java.util.List<java.lang.String> getBaseDNs()

Retrieves the base DNs for replicated content managed by this replication server.

Returns:

The base DNs for replicated content managed by this replication server, or an empty list if it was not included in the monitor entry.

getGenerationIDs

@NotNull
public java.util.Map<DN,java.lang.String> getGenerationIDs()

Retrieves a map of generation IDs for the available base DNs.

Returns:

A map of generation IDs for the available base DNs, or an empty map if it was not included in the monitor entry.

getGenerationID

@Nullable
public java.lang.String getGenerationID(@NotNull
                                                  java.lang.String baseDN)

Retrieves the generation ID for the specified base DN.

Parameters:

baseDN - The base DN for which to retrieve the generation ID.

Returns:

The generation ID for the specified base DN, or null if there no generation ID is available for the provided base DN, or the provided base DN is not a valid DN.

getGenerationID

@Nullable
public java.lang.String getGenerationID(@NotNull
                                                  DN baseDN)

Retrieves the generation ID for the specified base DN.

Parameters:

baseDN - The base DN for which to retrieve the generation ID.

Returns:

The generation ID for the specified base DN, or null if there no generation ID is available for the provided base DN.

getReplicationServerID

@Nullable
public java.lang.String getReplicationServerID()

Retrieves the server ID for the replication server.

Returns:

The server ID for the replication server, or null if it was not included in the monitor entry.

getReplicationServerPort

@Nullable
public java.lang.Long getReplicationServerPort()

Retrieves the port number for the replication server.

Returns:

The port number for the replication server, or null if it was not included in the monitor entry.

sslEncryptionAvailable

@Nullable
public java.lang.Boolean sslEncryptionAvailable()

Indicates whether the replication server provides support for SSL encryption.

Returns:

true if the replication server supports SSL encryption, false if it does not, or null if that information 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.