Package com.unboundid.ldap.sdk.unboundidds.monitors

Class ExtendedOperationResultCodeInfo

java.lang.Object
com.unboundid.ldap.sdk.unboundidds.monitors.ExtendedOperationResultCodeInfo
All Implemented Interfaces:
Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ExtendedOperationResultCodeInfo extends Object implements 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:

  • Method Details

    • getTotalCount

      @Nullable public 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 Map<String,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 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 Map<String,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 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 Map<String,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 Map<String,Map<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 Map<String,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.