com.ibm.wsspi.rasdiag
Class DiagnosticConfig
- java.lang.Object
com.ibm.wsspi.rasdiag.DiagnosticConfig
- public class DiagnosticConfig
- extends java.lang.Object
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:
Method Summary
Modifier and Type | Method and Description |
---|---|
|
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)
|
|
isAnythingEnabled()
determines if the StateCollectionSpec contains any collection specific to this Diagnostic
Provider
|
|
isEnabled(java.lang.String aTestDiag)
determines if a particular
diagnostic is enabled.
|
|
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
- 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
- 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
- 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
- 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