com.unboundid.ldap.sdk.unboundidds.monitors

Class ResultCodeMonitorEntry

java.lang.Object

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

com.unboundid.ldap.sdk.unboundidds.monitors.ResultCodeMonitorEntry

All Implemented Interfaces:

java.io.Serializable

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

This class defines a monitor entry that provides information about the result codes returned from various types of operations.

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
ResultCodeMonitorEntry(Entry entry) Creates a new result code monitor entry from the provided entry.

Method Summary

Modifier and Type	Method and Description
OperationResultCodeInfo	getAddOperationResultCodeInfo() Retrieves result code information for add operations.
OperationResultCodeInfo	getAllOperationsResultCodeInfo() Retrieves result code information that encompasses all types of operations.
OperationResultCodeInfo	getBindOperationResultCodeInfo() Retrieves result code information for bind operations.
OperationResultCodeInfo	getCompareOperationResultCodeInfo() Retrieves result code information for compare operations.
OperationResultCodeInfo	getDeleteOperationResultCodeInfo() Retrieves result code information for delete operations.
ExtendedOperationResultCodeInfo	getExtendedOperationResultCodeInfo() Retrieves result code information for extended operations.
OperationResultCodeInfo	getModifyDNOperationResultCodeInfo() Retrieves result code information for modify DN operations.
OperationResultCodeInfo	getModifyOperationResultCodeInfo() Retrieves result code information for modify operations.
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.
OperationResultCodeInfo	getSearchOperationResultCodeInfo() Retrieves result code information for search operations.

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

ResultCodeMonitorEntry

public ResultCodeMonitorEntry(@NotNull
                              Entry entry)

Creates a new result code monitor entry from the provided entry.

Parameters:

entry - The entry to be parsed as a result code monitor entry. It must not be null.

Method Detail

getAllOperationsResultCodeInfo

@NotNull
public OperationResultCodeInfo getAllOperationsResultCodeInfo()

Retrieves result code information that encompasses all types of operations.

Returns:

Result code information that encompasses all types of operations.

getAddOperationResultCodeInfo

@NotNull
public OperationResultCodeInfo getAddOperationResultCodeInfo()

Retrieves result code information for add operations.

Returns:

Result code information for add operations.

getBindOperationResultCodeInfo

@NotNull
public OperationResultCodeInfo getBindOperationResultCodeInfo()

Retrieves result code information for bind operations.

Returns:

Result code information for bind operations.

getCompareOperationResultCodeInfo

@NotNull
public OperationResultCodeInfo getCompareOperationResultCodeInfo()

Retrieves result code information for compare operations.

Returns:

Result code information for compare operations.

getDeleteOperationResultCodeInfo

@NotNull
public OperationResultCodeInfo getDeleteOperationResultCodeInfo()

Retrieves result code information for delete operations.

Returns:

Result code information for delete operations.

getExtendedOperationResultCodeInfo

@NotNull
public ExtendedOperationResultCodeInfo getExtendedOperationResultCodeInfo()

Retrieves result code information for extended operations.

Returns:

Result code information for extended operations.

getModifyOperationResultCodeInfo

@NotNull
public OperationResultCodeInfo getModifyOperationResultCodeInfo()

Retrieves result code information for modify operations.

Returns:

Result code information for modify operations.

getModifyDNOperationResultCodeInfo

@NotNull
public OperationResultCodeInfo getModifyDNOperationResultCodeInfo()

Retrieves result code information for modify DN operations.

Returns:

Result code information for modify DN operations.

getSearchOperationResultCodeInfo

@NotNull
public OperationResultCodeInfo getSearchOperationResultCodeInfo()

Retrieves result code information for search operations.

Returns:

Result code information for search operations.

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.