com.unboundid.ldap.sdk.unboundidds.monitors

Class ExtendedOperationResultCodeInfo

java.lang.Object

com.unboundid.ldap.sdk.unboundidds.monitors.ExtendedOperationResultCodeInfo

All Implemented Interfaces:

java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class ExtendedOperationResultCodeInfo
extends java.lang.Object
implements java.io.Serializable

This class provides a data structure that provides information about the result codes associated with various types of extended 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

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	getExtendedRequestNamesByOID() Retrieves a map with the human-readable names for each type of extended request, indexed by request OID, if available.
java.lang.Long	getFailedCount() Retrieves the number of extended operations of all types that resulted in failure, if available.
java.util.Map<java.lang.String,java.lang.Long>	getFailedCountsByOID() Retrieves the number of extended operations of each type that resulted in failure, indexed by extended request OID, if available.
java.lang.Double	getFailedPercent() Retrieves the percent of extended operations of all types that resulted in failure, if available.
java.util.Map<java.lang.String,java.lang.Double>	getFailedPercentsByOID() Retrieves the percent of extended operations of each type that resulted in failure, indexed by extended request OID, if available.
java.util.Map<java.lang.String,java.util.Map<java.lang.Integer,ResultCodeInfo>>	getResultCodeInfoMap() Retrieves a map with information about the result codes that have been returned for extended operations of each type, indexed first by extended request OID, and then by the result code's integer value.
java.lang.Long	getTotalCount() Retrieves the total number of extended operations of all types that have been processed, if available.
java.util.Map<java.lang.String,java.lang.Long>	getTotalCountsByOID() Retrieves the number of extended operations of each type that have been processed, indexed by extended request OID, if available.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getTotalCount

@Nullable
public java.lang.Long getTotalCount()

Retrieves the total number of extended operations of all types that have been processed, if available.

Returns:

The total number of extended operations of all types that have been processed, or null if this information was not in the monitor entry.

getTotalCountsByOID

@NotNull
public java.util.Map<java.lang.String,java.lang.Long> getTotalCountsByOID()

Retrieves the number of extended operations of each type that have been processed, indexed by extended request OID, if available.

Returns:

The number of extended operations of each type that have been processed, or an empty map if this information was not in the monitor entry.

getFailedCount

@Nullable
public java.lang.Long getFailedCount()

Retrieves the number of extended operations of all types that resulted in failure, if available.

Returns:

The number of extended operations of all types that resulted in failure, or null if this information was not in the monitor entry.

getFailedCountsByOID

@NotNull
public java.util.Map<java.lang.String,java.lang.Long> getFailedCountsByOID()

Retrieves the number of extended operations of each type that resulted in failure, indexed by extended request OID, if available.

Returns:

The number of extended operations of each type that resulted in failure, or an empty map if this information was not in the monitor entry.

getFailedPercent

@Nullable
public java.lang.Double getFailedPercent()

Retrieves the percent of extended operations of all types that resulted in failure, if available.

Returns:

The percent of extended operations of all types that resulted in failure, or null if this information was not in the monitor entry.

getFailedPercentsByOID

@NotNull
public java.util.Map<java.lang.String,java.lang.Double> getFailedPercentsByOID()

Retrieves the percent of extended operations of each type that resulted in failure, indexed by extended request OID, if available.

Returns:

The percent of extended operations of each type that resulted in failure, or an empty map if this information was not in the monitor entry.

getResultCodeInfoMap

@NotNull
public java.util.Map<java.lang.String,java.util.Map<java.lang.Integer,ResultCodeInfo>> getResultCodeInfoMap()

Retrieves a map with information about the result codes that have been returned for extended operations of each type, indexed first by extended request OID, and then by the result code's integer value.

Returns:

A map with information about the result codes that have been returned for extended operations of each type, or an empty map if this information was not in the monitor entry.

getExtendedRequestNamesByOID

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

Retrieves a map with the human-readable names for each type of extended request, indexed by request OID, if available.

Returns:

A map with the human-readable names for each type of extended request, or an empty map if this information was not in the monitor entry.