DiagnosticService MBean

Partial ObjectName:
WebSphere:*,type=DiagnosticService


MBean DiagnosticService

Diagnostic Service XML. Front end to Diagnostic Providers.


Operation Summary

java.lang.StringgetDiagnosticProviderNameById(java.lang.String DPid)
           Return a Diagnostic Provider Name by the String version of DPid.
java.lang.String[]queryDPNames(java.lang.String aDPNameRegExp)
           Return a list of Diagnostic Provider Names matching a regular expression.
javax.management.ObjectName[]queryDPids(java.lang.String aDPNameRegExp)
           Return a list of ObjectNames for DPIDs matching a regular expression DPName.
java.lang.String[]getRegisteredConfig(java.lang.String DPName)
           Get registered configuration ids.
java.lang.String[]getRegisteredConfigById(java.lang.String DPid)
           Get registered configuration ids by DPID.
java.lang.String[]getRegisteredState(java.lang.String DPName)
           Get registered state ids.
java.lang.String[]getRegisteredStateById(java.lang.String DPid)
           Get registered state ids by DPID.
java.lang.String[]getRegisteredSelfDiagnostics(java.lang.String DPName)
           Get registered selfDiagnostics ids.
java.lang.String[]getRegisteredSelfDiagnosticsById(java.lang.String DPid)
           Get registered selfDiagnostics ids by DPID.
DiagnosticEvent[]configDump(java.lang.String DPName, java.lang.String AttributeId, boolean registeredOnly)
           Dump Component Configuration.
DiagnosticEvent[]configDumpById(java.lang.String DPid, java.lang.String AttributeId, boolean registeredOnly)
           Dump Component Configuration by DPid.
java.lang.String[]configDumpFormatted(java.lang.String DPName, java.lang.String AttributeId, boolean registeredOnly, java.util.Locale aLocale)
           Dump Component Configuration with Formatting.
java.lang.String[]configDumpFormattedById(java.lang.String DPid, java.lang.String AttributeId, boolean registeredOnly, java.util.Locale aLocale)
           Dump Component Configuration by DPid with Formatting.
DiagnosticEvent[]stateDump(java.lang.String DPName, java.lang.String AttributeId, boolean registeredOnly)
           Dump State Information.
DiagnosticEvent[]stateDumpById(java.lang.String DPid, java.lang.String AttributeId, boolean registeredOnly)
           Dump State Information by DPid.
java.lang.String[]stateDumpFormatted(java.lang.String DPName, java.lang.String AttributeId, boolean registeredOnly, java.util.Locale aLocale)
           Dump State Information with Formatting.
java.lang.String[]stateDumpFormattedById(java.lang.String DPid, java.lang.String AttributeId, boolean registeredOnly, java.util.Locale aLocale)
           Dump State Information by DPid with Formatting.
DiagnosticEvent[]selfDiagnostic(java.lang.String DPName, java.lang.String TestId, boolean registeredOnly)
           Run SelfDiagnostic Tests.
DiagnosticEvent[]selfDiagnosticById(java.lang.String DPid, java.lang.String TestId, boolean registeredOnly)
           Run SelfDiagnostic Tests by DPid.
java.lang.String[]selfDiagnosticFormatted(java.lang.String DPName, java.lang.String TestId, boolean registeredOnly, java.util.Locale aLocale)
           Run SelfDiagnostic Tests with Formatting.
java.lang.String[]selfDiagnosticFormattedById(java.lang.String DPid, java.lang.String TestId, boolean registeredOnly, java.util.Locale aLocale)
           Run SelfDiagnostic Tests by DPid with Formatting.
voidsetStateCollectionSpec(java.lang.String StateCollectionSpec)
           Set the system-wide State Collection Spec.
java.lang.StringgetStateCollectionSpec()
           Get the system-wide State Collection Spec.
voidrefreshRegistrations()
           Clear DiagnosticProvider cache, query again, and refresh the cache.
java.lang.String[]listRegistrations()
           Get the list of Diagnostic Providers registered in the cache.
java.lang.String[]localize(java.lang.String DPName, java.lang.String[] msgKeys, java.util.Locale locale)
           localize messages for console display
java.lang.String[]localizeById(java.lang.String DPid, java.lang.String[] msgKeys, java.util.Locale locale)
           localize messages for console display

Notification Summary

DiagnosticProvider.registration
           Registration of a Diagnostic Provider into a servant

Operation Detail

getDiagnosticProviderNameById

public java.lang.String getDiagnosticProviderNameById(java.lang.String DPid)

     Return a Diagnostic Provider Name by the String version of DPid.

Parameters:

     DPid - Diagnostic Provider ID (String version of JMX ObjectName).

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


queryDPNames

public java.lang.String[] queryDPNames(java.lang.String aDPNameRegExp)

     Return a list of Diagnostic Provider Names matching a regular expression.

Parameters:

     aDPNameRegExp - Regular expression Diagnostic Provider Name.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


queryDPids

public javax.management.ObjectName[] queryDPids(java.lang.String aDPNameRegExp)

     Return a list of ObjectNames for DPIDs matching a regular expression DPName.

Parameters:

     aDPNameRegExp - Regular expression Diagnostic Provider Name.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getRegisteredConfig

public java.lang.String[] getRegisteredConfig(java.lang.String DPName)

     Get registered configuration ids.

Parameters:

     DPName - Diagnostic Provider Name

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getRegisteredConfigById

public java.lang.String[] getRegisteredConfigById(java.lang.String DPid)

     Get registered configuration ids by DPID.

Parameters:

     DPid - Diagnostic Provider ID

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getRegisteredState

public java.lang.String[] getRegisteredState(java.lang.String DPName)

     Get registered state ids.

Parameters:

     DPName - Diagnostic Provider Name

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getRegisteredStateById

public java.lang.String[] getRegisteredStateById(java.lang.String DPid)

     Get registered state ids by DPID.

Parameters:

     DPid - Diagnostic Provider ID

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getRegisteredSelfDiagnostics

public java.lang.String[] getRegisteredSelfDiagnostics(java.lang.String DPName)

     Get registered selfDiagnostics ids.

Parameters:

     DPName - Diagnostic Provider Name

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getRegisteredSelfDiagnosticsById

public java.lang.String[] getRegisteredSelfDiagnosticsById(java.lang.String DPid)

     Get registered selfDiagnostics ids by DPID.

Parameters:

     DPid - Diagnostic Provider ID

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


configDump

public DiagnosticEvent[] configDump(java.lang.String DPName, java.lang.String AttributeId, boolean registeredOnly)

     Dump Component Configuration.

Parameters:

     DPName - Diagnostic Provider Name
     AttributeId - Attribute Identification within Component
     registeredOnly - Return all data, or just that registered with tooling.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


configDumpById

public DiagnosticEvent[] configDumpById(java.lang.String DPid, java.lang.String AttributeId, boolean registeredOnly)

     Dump Component Configuration by DPid.

Parameters:

     DPid - Diagnostic Provider ID
     AttributeId - Attribute Identification within Component
     registeredOnly - Return all data, or just that registered with tooling.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


configDumpFormatted

public java.lang.String[] configDumpFormatted(java.lang.String DPName, java.lang.String AttributeId, boolean registeredOnly, java.util.Locale aLocale)

     Dump Component Configuration with Formatting.

Parameters:

     DPName - Diagnostic Provider Name
     AttributeId - Attribute Identification within Component
     registeredOnly - Return all data, or just that registered with tooling.
     aLocale - Locale for localizable text in the output.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


configDumpFormattedById

public java.lang.String[] configDumpFormattedById(java.lang.String DPid, java.lang.String AttributeId, boolean registeredOnly, java.util.Locale aLocale)

     Dump Component Configuration by DPid with Formatting.

Parameters:

     DPid - Diagnostic Provider ID
     AttributeId - Attribute Identification within Component
     registeredOnly - Return all data, or just that registered with tooling.
     aLocale - Locale for localizable text in the output.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


stateDump

public DiagnosticEvent[] stateDump(java.lang.String DPName, java.lang.String AttributeId, boolean registeredOnly)

     Dump State Information.

Parameters:

     DPName - Diagnostic Provider Name
     AttributeId - Attribute Identification within Component
     registeredOnly - Return all data, or just that registered with tooling.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


stateDumpById

public DiagnosticEvent[] stateDumpById(java.lang.String DPid, java.lang.String AttributeId, boolean registeredOnly)

     Dump State Information by DPid.

Parameters:

     DPid - Diagnostic Provider ID
     AttributeId - Attribute Identification within Component
     registeredOnly - Return all data, or just that registered with tooling.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


stateDumpFormatted

public java.lang.String[] stateDumpFormatted(java.lang.String DPName, java.lang.String AttributeId, boolean registeredOnly, java.util.Locale aLocale)

     Dump State Information with Formatting.

Parameters:

     DPName - Diagnostic Provider Name
     AttributeId - Attribute Identification within Component
     registeredOnly - Return all data, or just that registered with tooling.
     aLocale - Locale for localizable text in the output.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


stateDumpFormattedById

public java.lang.String[] stateDumpFormattedById(java.lang.String DPid, java.lang.String AttributeId, boolean registeredOnly, java.util.Locale aLocale)

     Dump State Information by DPid with Formatting.

Parameters:

     DPid - Diagnostic Provider ID
     AttributeId - Attribute Identification within Component
     registeredOnly - Return all data, or just that registered with tooling.
     aLocale - Locale for localizable text in the output.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


selfDiagnostic

public DiagnosticEvent[] selfDiagnostic(java.lang.String DPName, java.lang.String TestId, boolean registeredOnly)

     Run SelfDiagnostic Tests.

Parameters:

     DPName - Diagnostic Provider Name
     TestId - Test Identification within Component
     registeredOnly - Return all data, or just that registered with tooling.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


selfDiagnosticById

public DiagnosticEvent[] selfDiagnosticById(java.lang.String DPid, java.lang.String TestId, boolean registeredOnly)

     Run SelfDiagnostic Tests by DPid.

Parameters:

     DPid - Diagnostic Provider ID
     TestId - Test Identification within Component
     registeredOnly - Return all data, or just that registered with tooling.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


selfDiagnosticFormatted

public java.lang.String[] selfDiagnosticFormatted(java.lang.String DPName, java.lang.String TestId, boolean registeredOnly, java.util.Locale aLocale)

     Run SelfDiagnostic Tests with Formatting.

Parameters:

     DPName - Diagnostic Provider Name
     TestId - Test Identification within Component
     registeredOnly - Return all data, or just that registered with tooling.
     aLocale - Locale for localization

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


selfDiagnosticFormattedById

public java.lang.String[] selfDiagnosticFormattedById(java.lang.String DPid, java.lang.String TestId, boolean registeredOnly, java.util.Locale aLocale)

     Run SelfDiagnostic Tests by DPid with Formatting.

Parameters:

     DPid - Diagnostic Provider ID
     TestId - Test Identification within Component
     registeredOnly - Return all data, or just that registered with tooling.
     aLocale - Locale for localization

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


setStateCollectionSpec

public void setStateCollectionSpec(java.lang.String StateCollectionSpec)

     Set the system-wide State Collection Spec.

Parameters:

     StateCollectionSpec - String containing Enablement Spec for all components/sub-components including wildcards

Security Roles:

     administrator
     operator


getStateCollectionSpec

public java.lang.String getStateCollectionSpec()

     Get the system-wide State Collection Spec.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


refreshRegistrations

public void refreshRegistrations()

     Clear DiagnosticProvider cache, query again, and refresh the cache.

Security Roles:

     administrator
     operator


listRegistrations

public java.lang.String[] listRegistrations()

     Get the list of Diagnostic Providers registered in the cache.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


localize

public java.lang.String[] localize(java.lang.String DPName, java.lang.String[] msgKeys, java.util.Locale locale)

     localize messages for console display

Parameters:

     DPName - Diagnostic Provider Name
     msgKeys - Message Keys
     locale - Locale to use for output

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


localizeById

public java.lang.String[] localizeById(java.lang.String DPid, java.lang.String[] msgKeys, java.util.Locale locale)

     localize messages for console display

Parameters:

     DPid - Diagnostic Provider ID
     msgKeys - Message Keys
     locale - Locale to use for output

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


Notification Detail

DiagnosticProvider.registration

     Registration of a Diagnostic Provider into a servant

Severity:

5  (Warning)


Copyright IBM Corporation 2002, 2012