com.ibm.wsspi.rasdiag

Class DiagnosticConfigHome

  • java.lang.Object
    • com.ibm.wsspi.rasdiag.DiagnosticConfigHome


  • public class DiagnosticConfigHome
    extends java.lang.Object
    The DiagnosticConfigHome class maintains the StateCollectionSpec for the DiagnosticProviders in separate DiagnosticConfig objects.

    Following are some samples of valid stateCollectionSpecs (note : separates DPName from AttributeId w/in that DPName and ; separates entries in the CollectionSpec)

    • a-b-c:d.*=1;a-b-c:d-e-f=0;a-b.*:q-r.*=1 (1 = on, 0 = off). If isEnabled("xxx") is driven on a DiagnosticConfig object, and multiple entries match "xxx", then the entry furthest to the right will be used). For example, in this StateCollectionSpec, if isEnabled("d-e-f") were called in the a.b.c DPName, it would return false. It matches d.* which is true (=1), but it also matches d-e-f which is false, and is further to the right.
    • a-b-c:d.*=1 (Each spec must contain at least an entire DiagnosticProvider name (regexp OK)

    This is a Singleton class, hence the getInstance() and private constructor

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      DiagnosticConfig getDiagnosticConfig(java.lang.String aDPName)
      gets a DiagnosticConfig object from the Home for a DPName
      static DiagnosticConfigHome getInstance()
      returns a reference to this object
      java.lang.String getStateCollectionSpec()
      returns the string format of the system-wide collection spec
      static void releaseDiagnosticConfig(java.lang.String aDPName)
      releases a DiagnosticConfig object and frees the resources.
      void setStateCollectionSpec(java.lang.String aStateCollectionSpec)
      takes the new string (created via Cfg extract or from an MBean), split it into its component parts, and drives the setStateCollectionSpec method on all DiagnosticConfig objects that there has been impacted.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • getInstance

        public static DiagnosticConfigHome getInstance()
        returns a reference to this object
        Returns:
        a reference to this singleton object
      • getStateCollectionSpec

        public java.lang.String getStateCollectionSpec()
        returns the string format of the system-wide collection spec
        Returns:
        the string version of the system wide CollectionSpec
      • setStateCollectionSpec

        public void setStateCollectionSpec(java.lang.String aStateCollectionSpec)
        takes the new string (created via Cfg extract or from an MBean), split it into its component parts, and drives the setStateCollectionSpec method on all DiagnosticConfig objects that there has been impacted.
        Parameters:
        aStateCollectionSpec - String containing system-wide StateCollectionSpec
      • getDiagnosticConfig

        public DiagnosticConfig getDiagnosticConfig(java.lang.String aDPName)
        gets a DiagnosticConfig object from the Home for a DPName
        Parameters:
        aDPName - DiagnosticProvider name
        Returns:
        DiagnosticConfig object associated with this DiagnosticProvider
      • releaseDiagnosticConfig

        public static void releaseDiagnosticConfig(java.lang.String aDPName)
        releases a DiagnosticConfig object and frees the resources. This is also handled implicitly from the DiagnosticProviderHelper.deregisterMBeanWithDiagnosticService method or the DiagnosticProviderRegistry.deregister method.
        Parameters:
        aDPName - DiagnosticProvider name
IBM WebSphere Application ServerTM
Release 9.0