|
IBM WebSphere Application ServerTM Release 8 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DiagnosticProvider
Interface to be implemented by all components or sub-components who will use the current Serviceability infrastructure. It provides JMX accessible methods which enable clients (manual or automated) to extract configuration data, current state data, and even to run selfDiagnostic tests within the component.
Field Summary | |
---|---|
static java.lang.String |
DIAGNOSTIC_PROVIDER_CONFIG_CURRENT
Prefix for AtributeIds in ConfigDumps if the value is the current value (not necessarily startup) |
static java.lang.String |
DIAGNOSTIC_PROVIDER_CONFIG_STARTUP
Prefix for AtributeIds in ConfigDumps if the value is the value from server startup |
static java.lang.String |
DIAGNOSTIC_PROVIDER_KEY
Used by components in creating the Properties that go into ObjectName naming of their MBeans. |
static java.lang.String |
DIAGNOSTIC_PROVIDER_REGISTRATION
Type for the notification to send when a DiagnosticProvider registers |
static java.lang.String |
DIAGNOSTIC_PROVIDER_VALUE
Property value for ObjectName creation to distinguish an MBean as a DiagnosticProvider |
Method Summary | |
---|---|
DiagnosticEvent[] |
configDump(java.lang.String aAttributeId,
boolean aRegisteredOnly)
dumps the configuration information for a portion of this DiagnosticProvider |
java.lang.String |
getDiagnosticProviderId()
returns the ID of the DiagnosticProvider |
java.lang.String |
getDiagnosticProviderName()
returns the name of the DiagnosticProvider |
DiagnosticProviderInfo |
getRegisteredDiagnostics()
gets the registered Diagnostics for a DiagnosticProvider. |
java.lang.String[] |
localize(java.lang.String[] aKeys,
java.util.Locale aLocale)
localizes an array of strings to a specified locale for consumption potentially on other locales |
DiagnosticEvent[] |
selfDiagnostic(java.lang.String aTestId,
boolean aRegisteredOnly)
runs selfDiagnostic tests associated with some subset of the DiagnosticProvider |
DiagnosticEvent[] |
stateDump(java.lang.String aAttributeId,
boolean aRegisteredOnly)
dumps the state information for a portion of this DiagnosticProvider |
Field Detail |
---|
static final java.lang.String DIAGNOSTIC_PROVIDER_KEY
static final java.lang.String DIAGNOSTIC_PROVIDER_VALUE
static final java.lang.String DIAGNOSTIC_PROVIDER_REGISTRATION
static final java.lang.String DIAGNOSTIC_PROVIDER_CONFIG_STARTUP
static final java.lang.String DIAGNOSTIC_PROVIDER_CONFIG_CURRENT
Method Detail |
---|
java.lang.String getDiagnosticProviderName()
java.lang.String getDiagnosticProviderId()
DiagnosticProviderInfo getRegisteredDiagnostics()
DiagnosticEvent[] configDump(java.lang.String aAttributeId, boolean aRegisteredOnly)
aAttributeId
- is a spec that is a way to list multiple config / state / diagnostic
self test names in a single string. It can contain wildcardsaRegisteredOnly
- If true, produce only that output which has been registered and
which will be consistent from release to release. If false, all information may be put out.
DiagnosticEvent[] stateDump(java.lang.String aAttributeId, boolean aRegisteredOnly)
aAttributeId
- Specifically registered sub-set upon which this operation is to workaRegisteredOnly
- If true, produce only that output which has been registered and
which will be consistent from release to release. If false, all information may be put out.
DiagnosticEvent[] selfDiagnostic(java.lang.String aTestId, boolean aRegisteredOnly)
aTestId
- Specifically registered sub-set upon which this operation is to work (can be regular expression)aRegisteredOnly
- Report on only registered attributes, or allow registered and unregistered attributes
java.lang.String[] localize(java.lang.String[] aKeys, java.util.Locale aLocale)
aKeys
- list of keys which will be localizedaLocale
- locale to use in localizing messages
|
IBM WebSphere Application ServerTM Release 8 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |