com.ibm.ras
Interface RASIMaskChangeGenerator

All Superinterfaces:

RASIObject, java.io.Serializable

All Known Subinterfaces:

RASIHandler, RASILogger, RASIMessageLogger, RASITraceLogger

All Known Implementing Classes:

RASMaskChangeGenerator

public interface RASIMaskChangeGenerator

extends RASIObject

RASIMaskChangeGenerator defines the methods that must be implemented to control the message and trace masks and to generate mask change events. These events notify the listener that the state of the object's message or trace mask has changed.

RASIMaskChangeGenerator 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 interface defines methods common to RASILoggers and RASIHandlers. It should not be necessary to implement this directly.

Method Summary

void	addMaskChangeListener(RASIMaskChangeListener listener) Adds an object that wishes to be informed of changes in the message or trace mask configuration.
void	addMessageEventClass(java.lang.String name) Adds the name of a message event class which this object uses.
void	addTraceEventClass(java.lang.String name) Adds the name of a trace event class which this object uses.
void	fireMaskChangedEvent(RASMaskChangeEvent mc) Tells all RASIMaskChangeListeners that the message or trace mask has been changed.
java.util.Hashtable	getConfig() Gets the configuration of this object.
java.util.Enumeration	getMaskChangeListeners() Gets the set of objects that wish to be informed of changes in the message or trace mask configuration.
java.util.Enumeration	getMessageEventClasses() Gets the set of message event classes which this object uses.
long	getMessageMask() Gets the mask which defines the set of message types that will be processed.
java.util.Enumeration	getTraceEventClasses() Gets the set of trace event classes which this object uses.
long	getTraceMask() Gets the mask which defines the set of trace types that will be processed.
void	removeMaskChangeListener(RASIMaskChangeListener listener) Removes an object from the list that wishes to be informed of changes in the message or trace mask configuration.
void	removeMessageEventClass(java.lang.String name) Removes the name of a message event class from the list of classes which this object uses.
void	removeTraceEventClass(java.lang.String name) Removes the name of a trace event class from the list of classes which this object uses.
void	setConfig(java.util.Hashtable ht) Sets the configuration of this object.
void	setMessageMask(long mask) Sets the mask which defines the set of message types that will be processed.
void	setTraceMask(long mask) Sets the mask which defines the set of trace types that will be processed.

Methods inherited from interface com.ibm.ras.RASIObject

getDescription, getGroup, getName, setDescription, setName

Method Detail

getConfig

public java.util.Hashtable getConfig()

Gets the configuration of this object.

Specified by:

getConfig in interface RASIObject

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. Extensions to this object may add additional keys.

setConfig

public void setConfig(java.util.Hashtable ht)

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:

setConfig in interface RASIObject

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. Extensions to this object may add additional keys.

getMessageMask

public long getMessageMask()

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.

Returns:

The message mask.

setMessageMask

public void setMessageMask(long mask)

Sets 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. The mask value is not validated against these types.

Parameters:

mask - The message mask.

getTraceMask

public long getTraceMask()

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.

Returns:

The trace mask.

setTraceMask

public void setTraceMask(long mask)

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.

Parameters:

mask - The trace mask.

addMaskChangeListener

public void addMaskChangeListener(RASIMaskChangeListener listener)

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.

Parameters:

listener - The mask change listener.

removeMaskChangeListener

public void removeMaskChangeListener(RASIMaskChangeListener listener)

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.

Parameters:

listener - The mask change listener.

getMaskChangeListeners

public java.util.Enumeration getMaskChangeListeners()

Gets the set of objects that wish to be informed of changes in the message or trace mask configuration.

Returns:

An Enumeration of mask change listeners. If no listeners are registered, the Enumeration is empty.

fireMaskChangedEvent

public void fireMaskChangedEvent(RASMaskChangeEvent mc)

Tells all RASIMaskChangeListeners that the message or trace mask has been changed.

Parameters:

mc - A mask change event, indicating what has changed.

addMessageEventClass

public void addMessageEventClass(java.lang.String name)

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.

Parameters:

name - The event class name.

removeMessageEventClass

public void removeMessageEventClass(java.lang.String name)

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.

Parameters:

name - The event class name.

getMessageEventClasses

public java.util.Enumeration getMessageEventClasses()

Gets the set of message event classes which this object uses.

Returns:

An Enumeration of RAS event class names. If no event classes are registered, the Enumeration is empty.

addTraceEventClass

public void addTraceEventClass(java.lang.String name)

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.

Parameters:

name - The event class name.

removeTraceEventClass

public void removeTraceEventClass(java.lang.String name)

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.

Parameters:

name - The event class name.

getTraceEventClasses

public java.util.Enumeration getTraceEventClasses()

Gets the set of trace event classes which this object uses.

Returns:

An Enumeration of RAS event class names. If no event classes are registered, the Enumeration is empty.