com.ibm.ras

Class RASMaskChangeGenerator

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

Deprecated. As of WAS 6.0, recommend using java.util.logging
  1. public class RASMaskChangeGenerator
  2. extends RASObject
  3. implements RASIMaskChangeGenerator
RASMaskChangeGenerator implements the RASIMaskChangeGenerator interface. It is responsible for controlling the message and trace masks and for informing RASIMaskChangeListener that a change has occurred in the object's message or trace mask.

RASMaskChangeGenerator also provides methods that allow it to know which RASIEvent classes it can query to learn the event type values that might be used in its message or trace masks. This information can also be presented to a graphical program to display these event types to an end user.

This class provides common function to loggers and handlers and is not intended to be instantiated directly. The RASLogger and Handler classes extend this class.

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
RASMaskChangeGenerator()
Deprecated. Creates a RASMaskChangeGenerator.
RASMaskChangeGenerator(java.lang.String name)
Deprecated. Creates a RASMaskChangeGenerator.
RASMaskChangeGenerator(java.lang.String name,java.lang.String desc)
Deprecated. Creates a RASMaskChangeGenerator.

Method Summary

Modifier and Type Method and Description
  1. void
addMaskChangeListener(RASIMaskChangeListener listener)
Deprecated. Adds an object that wishes to be informed of changes in the message or trace mask configuration.
  1. void
addMessageEventClass(java.lang.String name)
Deprecated. Adds the name of a message event class which this object uses.
  1. void
addTraceEventClass(java.lang.String name)
Deprecated. Adds the name of a trace event class which this object uses.
  1. void
fireMaskChangedEvent(RASMaskChangeEvent mc)
Deprecated. Tells all RASIMaskChangeListeners that the message or trace mask has been changed.
  1. java.util.Hashtable
getConfig()
Deprecated. Gets the configuration of this object.
  1. java.util.Enumeration
getMaskChangeListeners()
Deprecated. Gets the set of objects that wish to be informed of changes in the message or trace mask configuration.
  1. java.util.Enumeration
getMessageEventClasses()
Deprecated. Gets the set of message event classes which this object uses.
  1. long
getMessageMask()
Deprecated. Gets the mask which defines the set of message types that will be processed.
  1. java.util.Enumeration
getTraceEventClasses()
Deprecated. Gets the set of trace event classes which this object uses.
  1. long
getTraceMask()
Deprecated. Gets the mask which defines the set of trace types that will be processed.
  1. protected
  2. void
init()
Deprecated. Initializes this object, setting default values.
  1. long
messageMaskLongValue(java.lang.String types)
Deprecated. Gets a composite message mask by asking each of the registered event classes to convert its known mask strings to a long value.
  1. java.lang.String
messageMaskToString(long types)
Deprecated. Gets a composite message mask by asking each of the registered event classes to convert its known mask to a string value.
  1. void
removeMaskChangeListener(RASIMaskChangeListener listener)
Deprecated. Removes an object from the list that wishes to be informed of changes in the message or trace mask configuration.
  1. void
removeMessageEventClass(java.lang.String name)
Deprecated. Removes the name of a message event class from the list of classes which this object uses.
  1. void
removeTraceEventClass(java.lang.String name)
Deprecated. Removes the name of a trace event class from the list of classes which this object uses.
  1. void
setConfig(java.util.Hashtable ht)
Deprecated. Sets the configuration of this object.
  1. void
setMessageMask(long mask)
Deprecated. Sets the mask which defines the set of message types that will be processed.
  1. void
setTraceMask(long mask)
Deprecated. Sets the mask which defines the set of trace types that will be processed.
  1. long
traceMaskLongValue(java.lang.String types)
Deprecated. Gets a composite trace mask by asking each of the registered event classes to convert its known mask strings to a long value.
  1. java.lang.String
traceMaskToString(long types)
Deprecated. Gets a composite trace mask by asking each of the registered event classes to convert its known mask to a string value.
Methods inherited from class com.ibm.ras.RASObject
clone, getDescription, getGroup, getName, setDescription, setName
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.ibm.ras.RASIObject
getDescription, getGroup, getName, setDescription, setName

Constructor Detail

RASMaskChangeGenerator

  1. public RASMaskChangeGenerator()
Deprecated.
Creates a RASMaskChangeGenerator. The name and description of this object are empty strings.

RASMaskChangeGenerator

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

RASMaskChangeGenerator

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

Method Detail

init

  1. protected void init()
Deprecated.
Initializes this object, setting default values.
Overrides:
init in class RASObject

getConfig

  1. public java.util.Hashtable getConfig( )
Deprecated.
Gets the configuration of this object.
Specified by:
Specified by:
getConfig in interface RASIObject
Overrides:
getConfig in class RASObject
Returns:
A Hashtable containing the configuration. This object inserts the following key/value pairs into the the configuration:

messageMask
The mask which selects the message types to be processed.
traceMask
The mask which selects the trace types to be processed.
messageEventClasses
A blank-delimited list of message event classes which this object uses.
traceEventClasses
A blank-delimited list of trace event classes which this object uses.

All values are Strings. The parent and extensions of this object may use additional keys.


setConfig

  1. public void setConfig(java.util.Hashtable ht)
Deprecated.
Sets the configuration of this object. This method is used by a RASManager to initialize a RAS object. It should not be necessary for an application to use this method.
Specified by:
Specified by:
setConfig in interface RASIObject
Overrides:
setConfig in class RASObject
Parameters:
ht - A Hashtable containing the configuration. This object searches for the following keys:

messageMask
The mask which selects the message types to be processed.
traceMask
The mask which selects the trace types to be processed.
messageEventClasses
A blank-delimited list of message event classes which this object uses.
traceEventClasses
A blank-delimited list of trace event classes which this object uses.

All values are Strings. If a key is not found, an internal default for that element is set instead. The parent and extensions of this object may use additional keys.


getMessageMask

  1. public long getMessageMask()
Deprecated.
Gets the mask which defines the set of message types that will be processed. Possible values are defined by the logical OR of the RASIMessageEvent TYPE_XXXX constants.
Specified by:
Returns:
The message mask.

setMessageMask

  1. public void setMessageMask(long mask)
Deprecated.
Sets the mask which defines the set of message types that will be processed. Possible values are defined by the RASIMessageEvent TYPE_XXXX constants. The mask value is not validated against these types.
Specified by:
Parameters:
mask - The message mask.

getTraceMask

  1. public long getTraceMask()
Deprecated.
Gets the mask which defines the set of trace types that will be processed. Possible values are defined by the logical OR of the RASITraceEvent TYPE_XXXX constants.
Specified by:
Returns:
The trace mask.

setTraceMask

  1. public void setTraceMask(long mask)
Deprecated.
Sets the mask which defines the set of trace types that will be processed. Possible values are defined by the RASITraceEvent TYPE_XXXX constants. The mask value is not validated against these types.
Specified by:
Parameters:
mask - The trace mask.

addMaskChangeListener

  1. public void addMaskChangeListener( RASIMaskChangeListener listener)
Deprecated.
Adds an object that wishes to be informed of changes in the message or trace mask configuration. If the listener is null or is already registered, this method does nothing.
Specified by:
Parameters:
listener - The mask change listener.

removeMaskChangeListener

  1. public void removeMaskChangeListener( RASIMaskChangeListener listener)
Deprecated.
Removes an object from the list that wishes to be informed of changes in the message or trace mask configuration. If the listener is null or is not registered, this method does nothing.
Specified by:
Parameters:
listener - The mask change listener.

getMaskChangeListeners

  1. public java.util.Enumeration getMaskChangeListeners( )
Deprecated.
Gets the set of objects that wish to be informed of changes in the message or trace mask configuration.
Specified by:
Returns:
An Enumeration of mask change listeners. If no listeners are registered, the Enumeration is empty.

fireMaskChangedEvent

  1. public void fireMaskChangedEvent( RASMaskChangeEvent mc)
Deprecated.
Tells all RASIMaskChangeListeners that the message or trace mask has been changed.
Specified by:
Parameters:
mc - A mask change event, indicating what has changed.

addMessageEventClass

  1. public void addMessageEventClass( java.lang.String name)
Deprecated.
Adds the name of a message event class which this object uses. If the event class is null or is already registered, this method does nothing.
Specified by:
Parameters:
name - The event class name.

removeMessageEventClass

  1. public void removeMessageEventClass( java.lang.String name)
Deprecated.
Removes the name of a message event class from the list of classes which this object uses. If the event class is null or is not registered, this method does nothing.
Specified by:
Parameters:
name - The event class name.

getMessageEventClasses

  1. public java.util.Enumeration getMessageEventClasses( )
Deprecated.
Gets the set of message event classes which this object uses.
Specified by:
Returns:
An Enumeration of RAS event class names. If no event classes are registered, the Enumeration is empty.

addTraceEventClass

  1. public void addTraceEventClass( java.lang.String name)
Deprecated.
Adds the name of a trace event class which this object uses. If the event class is null or is already registered, this method does nothing.
Specified by:
Parameters:
name - The event class name.

removeTraceEventClass

  1. public void removeTraceEventClass( java.lang.String name)
Deprecated.
Removes the name of a trace event class from the list of classes which this object uses. If the event class is null or is not registered, this method does nothing.
Specified by:
Parameters:
name - The event class name.

getTraceEventClasses

  1. public java.util.Enumeration getTraceEventClasses( )
Deprecated.
Gets the set of trace event classes which this object uses.
Specified by:
Returns:
An Enumeration of RAS event class names. If no event classes are registered, the Enumeration is empty.

messageMaskLongValue

  1. public long messageMaskLongValue( java.lang.String types)
Deprecated.
Gets a composite message mask by asking each of the registered event classes to convert its known mask strings to a long value.
Parameters:
types - A blank-delimited list of event types.
Returns:
The mask value compiled from each registered event class.

messageMaskToString

  1. public java.lang.String messageMaskToString( long types)
Deprecated.
Gets a composite message mask by asking each of the registered event classes to convert its known mask to a string value.
Parameters:
types - A message or trace mask.
Returns:
The string corresponding to the event types.

traceMaskLongValue

  1. public long traceMaskLongValue( java.lang.String types)
Deprecated.
Gets a composite trace mask by asking each of the registered event classes to convert its known mask strings to a long value.
Parameters:
types - A blank-delimited list of event types.
Returns:
The mask value compiled from each registered event class.

traceMaskToString

  1. public java.lang.String traceMaskToString( long types)
Deprecated.
Gets a composite trace mask by asking each of the registered event classes to convert its known mask to a string value.
Parameters:
types - A message or trace mask.
Returns:
The string corresponding to the event types.