com.ibm.ras.mgr
Class RASGroup
- java.lang.Object
-
- com.ibm.ras.RASObject
-
- com.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
public class RASGroup extends RASObject implements java.lang.Cloneable, RASConstants
RASGrouporganizes 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 theRASManager. 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:
RASIMessageLoggerconfigurationsRASITraceLoggerconfigurationsRASIHandlerconfigurationsRASIFormatterconfigurations
- 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
Constructors Constructor and Description RASGroup(java.lang.String name)Deprecated.Creates aRASGroup.RASGroup(java.lang.String name, java.lang.String desc)Deprecated.Creates aRASGroup.
-
Method Summary
Methods Modifier and Type Method and Description voidaddFormatterConfig(RASConfig cfg)Deprecated.Adds a formatter configuration to this group.voidaddHandlerConfig(RASConfig cfg)Deprecated.Adds a handler configuration to this group.voidaddMessageLoggerConfig(RASConfig cfg)Deprecated.Adds a message logger configuration to this group.voidaddTraceLoggerConfig(RASConfig cfg)Deprecated.Adds a trace logger configuration to this group.java.lang.Objectclone()Deprecated.Creates a newRASGroup.RASConfiggetFormatterConfig(java.lang.String name)Deprecated.Gets a formatter configuration from this group.java.util.HashtablegetFormatterConfigs()Deprecated.Gets all of the formatter configurations associated with this group.RASConfiggetHandlerConfig(java.lang.String name)Deprecated.Gets a handler configuration from this group.java.util.HashtablegetHandlerConfigs()Deprecated.Gets all of the handler configurations associated with this group.RASConfiggetMessageLoggerConfig(java.lang.String name)Deprecated.Gets a message logger configuration from this group.java.util.HashtablegetMessageLoggerConfigs()Deprecated.Gets all of the message Logger configurations associated with this group.RASConfiggetTraceLoggerConfig(java.lang.String name)Deprecated.Gets a trace logger configuration from this group.java.util.HashtablegetTraceLoggerConfigs()Deprecated.Gets all of the trace logger configurations associated with this group.booleanisModified()Deprecated.Determines if the group has been modified.voidremoveFormatterConfig(java.lang.String name)Deprecated.Removes a formatter configuration from this group.voidremoveHandlerConfig(java.lang.String name)Deprecated.Removes a handler configuration from this group.voidremoveMessageLoggerConfig(java.lang.String name)Deprecated.Removes a message logger configuration from this group.voidremoveTraceLoggerConfig(java.lang.String name)Deprecated.Removes a trace logger configuration from this group.voidsetModified(boolean flag)Deprecated.Sets a flag that indicates that the contents of this group has been modified.java.lang.StringtoString()Deprecated.Returns aStringrepresentation of this object.protected voidupdateActiveObjects(RASGroup oldGroup, RASManager mgr)Deprecated.Scans an "old"RASGroupfor 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
-
-
-
-
Constructor Detail
-
RASGroup
public RASGroup(java.lang.String name)
Deprecated.Creates aRASGroup. 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)Deprecated.Creates aRASGroup.- Parameters:
name- The name of this object.desc- The description of this object.
-
-
Method Detail
-
clone
public java.lang.Object clone()
Deprecated.Creates a newRASGroup.
-
addMessageLoggerConfig
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- ARASConfigcontaining the logger configuration.
-
removeMessageLoggerConfig
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
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
nullif the named configuration does not exist.
-
getMessageLoggerConfigs
public java.util.Hashtable getMessageLoggerConfigs()
Deprecated.Gets all of the message Logger configurations associated with this group.- Returns:
- A
HashtableofRASConfigobjects.
-
addTraceLoggerConfig
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- ARASConfigcontaining the logger configuration.
-
removeTraceLoggerConfig
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
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
nullif the named configuration does not exist.
-
getTraceLoggerConfigs
public java.util.Hashtable getTraceLoggerConfigs()
Deprecated.Gets all of the trace logger configurations associated with this group.- Returns:
- A
HashtableofRASConfigobjects.
-
addHandlerConfig
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- ARASConfigcontaining the handler configuration.
-
removeHandlerConfig
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
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
nullif the named configuration does not exist.
-
getHandlerConfigs
public java.util.Hashtable getHandlerConfigs()
Deprecated.Gets all of the handler configurations associated with this group.- Returns:
- A
HashtableofRASConfigobjects.
-
addFormatterConfig
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- ARASConfigcontaining the formatter configuration.
-
removeFormatterConfig
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
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
nullif the named configuration does not exist.
-
getFormatterConfigs
public java.util.Hashtable getFormatterConfigs()
Deprecated.Gets all of the formatter configurations associated with this group.- Returns:
- A
HashtableofRASConfigobjects.
-
updateActiveObjects
protected void updateActiveObjects(RASGroup oldGroup, RASManager mgr)
Deprecated.Scans an "old"RASGroupfor 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 isnull.- Parameters:
oldgroup- TheRASGroupto be scanned for instantiated objects.mgr- TheRASManager.
-
setModified
public void setModified(boolean flag)
Deprecated.Sets a flag that indicates that the contents of this group has been modified.- Parameters:
flag-truewhen the group has been modified andfalseotherwise.
-
isModified
public boolean isModified()
Deprecated.Determines if the group has been modified.- Returns:
truewhen the group has been modified andfalseotherwise.
-
toString
public java.lang.String toString()
Deprecated.Returns aStringrepresentation of this object.- Overrides:
toStringin classjava.lang.Object- Returns:
- A representation of this object.
-
-