com.ibm.wsspi.rasdiag

Class DiagnosticConfig

  1. java.lang.Object
  2. extended bycom.ibm.wsspi.rasdiag.DiagnosticConfig

  1. public class DiagnosticConfig
  2. extends java.lang.Object
The DiagnosticConfig class is used to store DiagnosticProvider scoped StateCollectionSpec information. This information can include wild-cards and its purpose is to allow a DiagnosticProvider to enable specific tracing/debug type operations. The system-wide StateCollectionSpec comes in as a string which can look something like:

*=0;ConnectionManager:profile-datasource.*=1;WebContainer:transport.*=1

This is explained further in DiagnosticConfigHome. Classes that implement the AlertAgent interface may retrieve all necessary DiagnosticConfig objects and hold them. The DiagnosticConfigHome will still automatically update them as needed.

See Also:
DiagnosticConfigHome

Method Summary

Modifier and Type Method and Description
  1. boolean
deRegisterCallback(DiagnosticCollectionCallback aDiagnosticCollectionCallback)
deRegisters a class implementing the DiagnosticCollectionCallback interface, allows that class to be removed from the list (ie: if it were going to go out of service)
  1. boolean
isAnythingEnabled()
determines if the StateCollectionSpec contains any collection specific to this Diagnostic Provider
  1. boolean
isEnabled(java.lang.String aTestDiag)
determines if a particular diagnostic is enabled.
  1. void
registerCallback(DiagnosticCollectionCallback aDiagnosticCollectionCallback)
registers a class implementing the DiagnosticCollectionCallback interface to be notified on any changes to the StateCollectionSpec
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

registerCallback

  1. public void registerCallback(DiagnosticCollectionCallback aDiagnosticCollectionCallback)
registers a class implementing the DiagnosticCollectionCallback interface to be notified on any changes to the StateCollectionSpec
Parameters:
aDiagnosticCollectionCallback - object to be notified with data when the state collection spec changes

deRegisterCallback

  1. public boolean deRegisterCallback( DiagnosticCollectionCallback aDiagnosticCollectionCallback)
deRegisters a class implementing the DiagnosticCollectionCallback interface, allows that class to be removed from the list (ie: if it were going to go out of service)
Parameters:
aDiagnosticCollectionCallback - object to be removed from notification list

isEnabled

  1. public boolean isEnabled(java.lang.String aTestDiag)
determines if a particular diagnostic is enabled. This method is optimized for heavy usage.
Parameters:
aTestDiag - Diagnostic for which the DiagnosticProvider caller is requesting enablement information.
Returns:
true if the Diagnostic is enabled, and false if it is not

isAnythingEnabled

  1. public boolean isAnythingEnabled( )
determines if the StateCollectionSpec contains any collection specific to this Diagnostic Provider
Returns:
true if some collection is turned on for this Diagnostic Provider, otherwise return false indicating that no collection relevent to this Diagnostic Provider is on