com.ibm.ras.mgr
Class RASGroup

java.lang.Object
  |
  +--com.ibm.ras.RASObject
        |
        +--com.ibm.ras.mgr.RASGroup
Direct Known Subclasses:
RASBaseGroup

public class RASGroup
extends RASObject

RASGroup organizes the configuration data for a related set of RAS objects (loggers, handlers and formatters). An application will typically group all of its RAS objects in a RAS group, or set of RAS groups, to distinguish them from other RAS objects controlled by the RASManager. Data grouped in this manner can be used by a graphical program to display RAS information application-by-application.

A RAS group contains collections of the following items:

See Also:
RASManager

Constructor Summary
RASGroup(java.lang.String name)
          Creates a RASGroup.
RASGroup(java.lang.String name, java.lang.String desc)
          Creates a RASGroup.
 
Method Summary
 void addFormatterConfig(RASConfig cfg)
          Adds a formatter configuration to this group.
 void addHandlerConfig(RASConfig cfg)
          Adds a handler configuration to this group.
 void addMessageLoggerConfig(RASConfig cfg)
          Adds a message logger configuration to this group.
 void addTraceLoggerConfig(RASConfig cfg)
          Adds a trace logger configuration to this group.
 RASConfig getFormatterConfig(java.lang.String name)
          Gets a formatter configuration from this group.
 java.util.Hashtable getFormatterConfigs()
          Gets all of the formatter configurations associated with this group.
 RASConfig getHandlerConfig(java.lang.String name)
          Gets a handler configuration from this group.
 java.util.Hashtable getHandlerConfigs()
          Gets all of the handler configurations associated with this group.
 RASConfig getMessageLoggerConfig(java.lang.String name)
          Gets a message Logger configuration from this group.
 java.util.Hashtable getMessageLoggerConfigs()
          Gets all of the message Logger configurations associated with this group.
 RASConfig getTraceLoggerConfig(java.lang.String name)
          Gets a trace logger configuration from this group.
 java.util.Hashtable getTraceLoggerConfigs()
          Gets all of the trace logger configurations associated with this group.
 void removeFormatterConfig(java.lang.String name)
          Removes a formatter configuration from this group.
 void removeHandlerConfig(java.lang.String name)
          Removes a handler configuration from this group.
 void removeMessageLoggerConfig(java.lang.String name)
          Removes a message logger configuration from this group.
 void removeTraceLoggerConfig(java.lang.String name)
          Removes a trace logger configuration from this group.
 
Methods inherited from class com.ibm.ras.RASObject
getConfig, getDescription, getName, setConfig, setDescription, setName
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RASGroup

public RASGroup(java.lang.String name)
Creates a RASGroup. The description of this object is an empty string.
Parameters:
name - The name of this object.

RASGroup

public RASGroup(java.lang.String name,
                java.lang.String desc)
Creates a RASGroup.
Parameters:
name - The name of this object.
desc - The description of this object.
Method Detail

addMessageLoggerConfig

public void addMessageLoggerConfig(RASConfig cfg)
Adds a message logger configuration to this group. If the logger configuration does not contain a name, the configuration is not added. If a configuration with the same name is already a member of this group, it is replaced.
Parameters:
cfg - A RASConfig containing the logger configuration.

removeMessageLoggerConfig

public void removeMessageLoggerConfig(java.lang.String name)
Removes a message logger configuration from this group. If the named configuration does not exist, this method does nothing.
Parameters:
name - The name of the logger configuration.

getMessageLoggerConfig

public RASConfig getMessageLoggerConfig(java.lang.String name)
Gets a message Logger configuration from this group.
Parameters:
name - The name of the logger configuration.
Returns:
The message logger configuration, or null if the named configuration does not exist.

getMessageLoggerConfigs

public java.util.Hashtable getMessageLoggerConfigs()
Gets all of the message Logger configurations associated with this group.
Returns:
A Hashtable of RASConfig objects.

addTraceLoggerConfig

public void addTraceLoggerConfig(RASConfig cfg)
Adds a trace logger configuration to this group. If the logger configuration does not contain a name, the configuration is not added. If a configuration with the same name is already a member of this group, it is replaced.
Parameters:
cfg - A RASConfig containing the logger configuration.

removeTraceLoggerConfig

public void removeTraceLoggerConfig(java.lang.String name)
Removes a trace logger configuration from this group. If the named configuration does not exist, this method does nothing.
Parameters:
name - The name of the logger configuration.

getTraceLoggerConfig

public RASConfig getTraceLoggerConfig(java.lang.String name)
Gets a trace logger configuration from this group.
Parameters:
name - The name of the logger configuration.
Returns:
The logger configuration, or null if the named configuration does not exist.

getTraceLoggerConfigs

public java.util.Hashtable getTraceLoggerConfigs()
Gets all of the trace logger configurations associated with this group.
Returns:
A Hashtable of RASConfig objects.

addHandlerConfig

public void addHandlerConfig(RASConfig cfg)
Adds a handler configuration to this group. If the handler configuration does not contain a name, the configuration is not added. If a configuration with the same name is already a member of this group, it is replaced.
Parameters:
cfg - A RASConfig containing the handler configuration.

removeHandlerConfig

public void removeHandlerConfig(java.lang.String name)
Removes a handler configuration from this group. If the named configuration does not exist, this method does nothing.
Parameters:
name - The name of the handler configuration.

getHandlerConfig

public RASConfig getHandlerConfig(java.lang.String name)
Gets a handler configuration from this group.
Parameters:
name - The name of the handler configuration.
Returns:
The handler configuration, or null if the named configuration does not exist.

getHandlerConfigs

public java.util.Hashtable getHandlerConfigs()
Gets all of the handler configurations associated with this group.
Returns:
A Hashtable of RASConfig objects.

addFormatterConfig

public void addFormatterConfig(RASConfig cfg)
Adds a formatter configuration to this group. If the formatter configuration does not contain a name, the configuration is not added. If a configuration with the same name is already a member of this group, it is replaced.
Parameters:
cfg - A RASConfig containing the formatter configuration.

removeFormatterConfig

public void removeFormatterConfig(java.lang.String name)
Removes a formatter configuration from this group. If the named configuration does not exist, this method does nothing.
Parameters:
name - The name of the formatter configuration.

getFormatterConfig

public RASConfig getFormatterConfig(java.lang.String name)
Gets a formatter configuration from this group.
Parameters:
name - The name of the formatter configuration.
Returns:
The formatter configuration, or null if the named configuration does not exist.

getFormatterConfigs

public java.util.Hashtable getFormatterConfigs()
Gets all of the formatter configurations associated with this group.
Returns:
A Hashtable of RASConfig objects.