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

java.lang.Object
  extended by com.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry
      extended by com.unboundid.ldap.sdk.unboundidds.monitors.ResultCodeMonitorEntry
All Implemented Interfaces:
java.io.Serializable

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

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
This class defines a monitor entry that provides information about the result codes returned from various types of operations.

See Also:
Serialized Form

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

public OperationResultCodeInfo getAllOperationsResultCodeInfo()
Retrieves result code information that encompasses all types of operations.

Returns:
Result code information that encompasses all types of operations.

getAddOperationResultCodeInfo

public OperationResultCodeInfo getAddOperationResultCodeInfo()
Retrieves result code information for add operations.

Returns:
Result code information for add operations.

getBindOperationResultCodeInfo

public OperationResultCodeInfo getBindOperationResultCodeInfo()
Retrieves result code information for bind operations.

Returns:
Result code information for bind operations.

getCompareOperationResultCodeInfo

public OperationResultCodeInfo getCompareOperationResultCodeInfo()
Retrieves result code information for compare operations.

Returns:
Result code information for compare operations.

getDeleteOperationResultCodeInfo

public OperationResultCodeInfo getDeleteOperationResultCodeInfo()
Retrieves result code information for delete operations.

Returns:
Result code information for delete operations.

getExtendedOperationResultCodeInfo

public ExtendedOperationResultCodeInfo getExtendedOperationResultCodeInfo()
Retrieves result code information for extended operations.

Returns:
Result code information for extended operations.

getModifyOperationResultCodeInfo

public OperationResultCodeInfo getModifyOperationResultCodeInfo()
Retrieves result code information for modify operations.

Returns:
Result code information for modify operations.

getModifyDNOperationResultCodeInfo

public OperationResultCodeInfo getModifyDNOperationResultCodeInfo()
Retrieves result code information for modify DN operations.

Returns:
Result code information for modify DN operations.

getSearchOperationResultCodeInfo

public OperationResultCodeInfo getSearchOperationResultCodeInfo()
Retrieves result code information for search operations.

Returns:
Result code information for search operations.

getMonitorDisplayName

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

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

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.