com.ibm.wsspi.rasdiag

Interface DiagnosticProvider


  1. 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

Modifier and Type Field and Description
  1. static
  2. java.lang.String
DIAGNOSTIC_PROVIDER_CONFIG_CURRENT
Prefix for AtributeIds in ConfigDumps if the value is the current value (not necessarily startup)
  1. static
  2. java.lang.String
DIAGNOSTIC_PROVIDER_CONFIG_STARTUP
Prefix for AtributeIds in ConfigDumps if the value is the value from server startup
  1. static
  2. java.lang.String
DIAGNOSTIC_PROVIDER_KEY
Used by components in creating the Properties that go into ObjectName naming of their MBeans.
  1. static
  2. java.lang.String
DIAGNOSTIC_PROVIDER_REGISTRATION
Type for the notification to send when a DiagnosticProvider registers
  1. static
  2. java.lang.String
DIAGNOSTIC_PROVIDER_VALUE
Property value for ObjectName creation to distinguish an MBean as a DiagnosticProvider

Method Summary

Modifier and Type Method and Description
  1. DiagnosticEvent[]
configDump(java.lang.String aAttributeId,boolean aRegisteredOnly)
dumps the configuration information for a portion of this DiagnosticProvider
  1. java.lang.String
getDiagnosticProviderId()
returns the ID of the DiagnosticProvider
  1. java.lang.String
getDiagnosticProviderName()
returns the name of the DiagnosticProvider
  1. DiagnosticProviderInfo
getRegisteredDiagnostics()
gets the registered Diagnostics for a DiagnosticProvider.
  1. 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
  1. DiagnosticEvent[]
selfDiagnostic(java.lang.String aTestId,boolean aRegisteredOnly)
runs selfDiagnostic tests associated with some subset of the DiagnosticProvider
  1. DiagnosticEvent[]
stateDump(java.lang.String aAttributeId,boolean aRegisteredOnly)
dumps the state information for a portion of this DiagnosticProvider

Field Detail

DIAGNOSTIC_PROVIDER_KEY

  1. static final java.lang.String DIAGNOSTIC_PROVIDER_KEY
Used by components in creating the Properties that go into ObjectName naming of their MBeans. This distinguishes the MBean as a DiagnosticProvider. DIAGNOSTIC_PROVIDER_KEY is the Property name
See Also:

DIAGNOSTIC_PROVIDER_VALUE

  1. static final java.lang.String DIAGNOSTIC_PROVIDER_VALUE
Property value for ObjectName creation to distinguish an MBean as a DiagnosticProvider
See Also:

DIAGNOSTIC_PROVIDER_REGISTRATION

  1. static final java.lang.String DIAGNOSTIC_PROVIDER_REGISTRATION
Type for the notification to send when a DiagnosticProvider registers
See Also:

DIAGNOSTIC_PROVIDER_CONFIG_STARTUP

  1. static final java.lang.String DIAGNOSTIC_PROVIDER_CONFIG_STARTUP
Prefix for AtributeIds in ConfigDumps if the value is the value from server startup
See Also:

DIAGNOSTIC_PROVIDER_CONFIG_CURRENT

  1. static final java.lang.String DIAGNOSTIC_PROVIDER_CONFIG_CURRENT
Prefix for AtributeIds in ConfigDumps if the value is the current value (not necessarily startup)
See Also:

Method Detail

getDiagnosticProviderName

  1. java.lang.String getDiagnosticProviderName( )
returns the name of the DiagnosticProvider
Returns:
DiagnosticProvider Name

getDiagnosticProviderId

  1. java.lang.String getDiagnosticProviderId( )
returns the ID of the DiagnosticProvider
Returns:
DiagnosticProvider Id (DPid)

getRegisteredDiagnostics

  1. DiagnosticProviderInfo getRegisteredDiagnostics( )
gets the registered Diagnostics for a DiagnosticProvider. This returns a structure which includes the diagnostics for all 3 types
  • Configuration
  • State information
  • Self Diagnostics
Returns:
DiagnosticProviderInfo object with all of the information

configDump

  1. DiagnosticEvent[] configDump(java.lang.String aAttributeId,
  2. boolean aRegisteredOnly)
dumps the configuration information for a portion of this DiagnosticProvider
Parameters:
aAttributeId - is a spec that is a way to list multiple config / state / diagnostic self test names in a single string. It can contain wildcards
aRegisteredOnly - 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.
Returns:
the entire payload for the operation

stateDump

  1. DiagnosticEvent[] stateDump(java.lang.String aAttributeId,
  2. boolean aRegisteredOnly)
dumps the state information for a portion of this DiagnosticProvider
Parameters:
aAttributeId - Specifically registered sub-set upon which this operation is to work
aRegisteredOnly - 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.
Returns:
the entire payload for the operation

selfDiagnostic

  1. DiagnosticEvent[] selfDiagnostic( java.lang.String aTestId,
  2. boolean aRegisteredOnly)
runs selfDiagnostic tests associated with some subset of the DiagnosticProvider
Parameters:
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
Returns:
containing the entire payload for each associated test

localize

  1. java.lang.String[] localize(java.lang.String[] aKeys,
  2. java.util.Locale aLocale)
localizes an array of strings to a specified locale for consumption potentially on other locales
Parameters:
aKeys - list of keys which will be localized
aLocale - locale to use in localizing messages
Returns:
list of localized messages