com.ibm.ras.mgr

Class RASGroup

  1. java.lang.Object
  2. extended bycom.ibm.ras.RASObject
  3. extended bycom.ibm.ras.mgr.RASGroup
All implemented interfaces:
RASConstants, RASIObject, java.io.Serializable, java.lang.Cloneable
Direct known subclasses:
RASBaseGroup

Deprecated. As of WAS 6.0, recommend using java.util.logging
  1. public class RASGroup
  2. extends RASObject
  3. implements java.lang.Cloneable, RASConstants
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:
Serialized Form

Field Summary

Fields inherited from interface com.ibm.ras.RASConstants
KEY_CLASS_NAME, KEY_CLIENT, KEY_COMPONENT, KEY_DATE_FORMAT, KEY_DEFAULT_HANDLERS, KEY_DEFAULT_MESSAGE_HANDLERS, KEY_DEFAULT_TRACE_HANDLERS, KEY_DESCRIPTION, KEY_ENCODING, KEY_EXCEPTION, KEY_EXCEPTION_TRACE, KEY_FILE_NAME, KEY_FORMATTER_NAMES, KEY_GROUP, KEY_HANDLER_NAMES, KEY_HEX_DATA, KEY_IS_CIRCULAR, KEY_IS_LOGGING, KEY_IS_SYNC, KEY_LOGGER, KEY_LOGGING_CLASS, KEY_LOGGING_METHOD, KEY_MAX_FILE_SIZE, KEY_MAX_FILES, KEY_MAX_QUEUE_SIZE, KEY_MESSAGE_EVENT_CLASSES, KEY_MESSAGE_FILE, KEY_MESSAGE_MASK, KEY_NAME, KEY_ORGANIZATION, KEY_PRODUCT, KEY_RETRY_INTERVAL, KEY_SEPARATOR, KEY_SERVER, KEY_SOCKET_PORT, KEY_SOCKET_SERVER, KEY_SUPPRESSED_KEYS, KEY_THREAD_ID, KEY_TIME_FORMAT, KEY_TRACE_EVENT_CLASSES, KEY_TRACE_MASK, RAS_VERSION

Constructor Summary

Constructor and Description
RASGroup(java.lang.String name)
Deprecated. Creates a RASGroup.
RASGroup(java.lang.String name,java.lang.String desc)
Deprecated. Creates a RASGroup.

Method Summary

Modifier and Type Method and Description
  1. void
addFormatterConfig(RASConfig cfg)
Deprecated. Adds a formatter configuration to this group.
  1. void
addHandlerConfig(RASConfig cfg)
Deprecated. Adds a handler configuration to this group.
  1. void
addMessageLoggerConfig(RASConfig cfg)
Deprecated. Adds a message logger configuration to this group.
  1. void
addTraceLoggerConfig(RASConfig cfg)
Deprecated. Adds a trace logger configuration to this group.
  1. java.lang.Object
clone()
Deprecated. Creates a new RASGroup.
  1. RASConfig
getFormatterConfig(java.lang.String name)
Deprecated. Gets a formatter configuration from this group.
  1. java.util.Hashtable
getFormatterConfigs()
Deprecated. Gets all of the formatter configurations associated with this group.
  1. RASConfig
getHandlerConfig(java.lang.String name)
Deprecated. Gets a handler configuration from this group.
  1. java.util.Hashtable
getHandlerConfigs()
Deprecated. Gets all of the handler configurations associated with this group.
  1. RASConfig
getMessageLoggerConfig(java.lang.String name)
Deprecated. Gets a message logger configuration from this group.
  1. java.util.Hashtable
getMessageLoggerConfigs()
Deprecated. Gets all of the message Logger configurations associated with this group.
  1. RASConfig
getTraceLoggerConfig(java.lang.String name)
Deprecated. Gets a trace logger configuration from this group.
  1. java.util.Hashtable
getTraceLoggerConfigs()
Deprecated. Gets all of the trace logger configurations associated with this group.
  1. boolean
isModified()
Deprecated. Determines if the group has been modified.
  1. void
removeFormatterConfig(java.lang.String name)
Deprecated. Removes a formatter configuration from this group.
  1. void
removeHandlerConfig(java.lang.String name)
Deprecated. Removes a handler configuration from this group.
  1. void
removeMessageLoggerConfig(java.lang.String name)
Deprecated. Removes a message logger configuration from this group.
  1. void
removeTraceLoggerConfig(java.lang.String name)
Deprecated. Removes a trace logger configuration from this group.
  1. void
setModified(boolean flag)
Deprecated. Sets a flag that indicates that the contents of this group has been modified.
  1. java.lang.String
toString()
Deprecated. Returns a String representation of this object.
  1. protected
  2. void
updateActiveObjects(RASGroup oldGroup,RASManager mgr)
Deprecated. Scans an "old" RASGroup for RAS objects which have been instantiated and updates this group with this information.
Methods inherited from class com.ibm.ras.RASObject
getConfig, getDescription, getGroup, getName, init, setConfig, setDescription, setName
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RASGroup

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

RASGroup

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

Method Detail

clone

  1. public java.lang.Object clone()
Deprecated.
Creates a new RASGroup.
Overrides:
clone in class RASObject
Returns:
A copy of the current object.

addMessageLoggerConfig

  1. public void addMessageLoggerConfig( RASConfig cfg)
Deprecated.
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

  1. public void removeMessageLoggerConfig( java.lang.String name)
Deprecated.
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

  1. public RASConfig getMessageLoggerConfig( java.lang.String name)
Deprecated.
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

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

addTraceLoggerConfig

  1. public void addTraceLoggerConfig( RASConfig cfg)
Deprecated.
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

  1. public void removeTraceLoggerConfig( java.lang.String name)
Deprecated.
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

  1. public RASConfig getTraceLoggerConfig( java.lang.String name)
Deprecated.
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

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

addHandlerConfig

  1. public void addHandlerConfig(RASConfig cfg)
Deprecated.
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

  1. public void removeHandlerConfig( java.lang.String name)
Deprecated.
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

  1. public RASConfig getHandlerConfig( java.lang.String name)
Deprecated.
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

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

addFormatterConfig

  1. public void addFormatterConfig( RASConfig cfg)
Deprecated.
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

  1. public void removeFormatterConfig( java.lang.String name)
Deprecated.
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

  1. public RASConfig getFormatterConfig( java.lang.String name)
Deprecated.
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

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

updateActiveObjects

  1. protected void updateActiveObjects( RASGroup oldGroup,
  2. RASManager mgr)
Deprecated.
Scans an "old" RASGroup for RAS objects which have been instantiated and updates this group with this information. This method should be called if a RAS configuration is refreshed from a data store, so that the active-object data is not lost. This method does nothing if the "old" group is null.
mgr - The RASManager.

setModified

  1. public void setModified(boolean flag)
Deprecated.
Sets a flag that indicates that the contents of this group has been modified.
Parameters:
flag - true when the group has been modified and false otherwise.

isModified

  1. public boolean isModified()
Deprecated.
Determines if the group has been modified.
Returns:
true when the group has been modified and false otherwise.

toString

  1. public java.lang.String toString( )
Deprecated.
Returns a String representation of this object.
Overrides:
toString in class java.lang.Object
Returns:
A representation of this object.