com.unboundid.ldap.sdk.unboundidds.monitors

Class ResultCodeInfo

java.lang.Object

com.unboundid.ldap.sdk.unboundidds.monitors.ResultCodeInfo

All Implemented Interfaces:

java.io.Serializable

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

This class provides a data structure that encapsulates information about a result code included in the result code monitor entry.

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
double	getAverageResponseTimeMillis() The average response time, in milliseconds, for all operations of the associated type (or of all operations if the operation type is null) with this result code.
long	getCount() The total number of operations of the associated type (or of all operations if the operation type is null) with this result code.
java.lang.String	getName() Retrieves the name for this result code.
OperationType	getOperationType() Retrieves the type of operation with which the result code statistics are associated, if appropriate.
double	getPercent() The percent of operations of the associated type (or of all operations if the operation type is null) with this result code.
double	getTotalResponseTimeMillis() The sum of the response times, in milliseconds, for all operations of the associated type (or of all operations if the operation type is null) with this result code.
int	intValue() Retrieves the integer value for this result code.

Methods inherited from class java.lang.Object

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

Method Detail

intValue

public int intValue()

Retrieves the integer value for this result code.

Returns:

The integer value for this result code.

getName

@NotNull
public java.lang.String getName()

Retrieves the name for this result code.

Returns:

The name for this result code.

getOperationType

@Nullable
public OperationType getOperationType()

Retrieves the type of operation with which the result code statistics are associated, if appropriate.

Returns:

The type of operation with which the result code statistics are associated, or null if the statistics apply to all types of operations.

getCount

public long getCount()

The total number of operations of the associated type (or of all operations if the operation type is null) with this result code.

Returns:

The total number of operations of the associated type with this result code.

getPercent

public double getPercent()

The percent of operations of the associated type (or of all operations if the operation type is null) with this result code.

Returns:

The percent of operations of the associated type with this result code.

getTotalResponseTimeMillis

public double getTotalResponseTimeMillis()

The sum of the response times, in milliseconds, for all operations of the associated type (or of all operations if the operation type is null) with this result code.

Returns:

The sum of the response times, in milliseconds, for all operations of the associated type with this result code.

getAverageResponseTimeMillis

public double getAverageResponseTimeMillis()

The average response time, in milliseconds, for all operations of the associated type (or of all operations if the operation type is null) with this result code.

Returns:

The average response time, in milliseconds, for all operations of the associated type with this result code.