public interface RASILogger extends RASIMaskChangeGenerator
RASILogger defines the methods which are common to
objects that wish to create RAS message and trace data. This interface
is intended to be extended to include methods specific to the creation
of message or trace data and should not be implemented directly.
An object which implements this interface may also wish to
implement RASIMaskChangeListener.
Note: Classes which implement RASILogger
should, in their constructors, call the
addMessageEventClass and
addTraceEventClass methods to register the
RASIEvent classes which the logger uses.
This will allow a graphical program to query the logger
to determine the supported RAS events. The events, in turn, can be
queried to determine their set of supported event types.
RASIMessageLogger,
RASITraceLogger| Modifier and Type | Method and Description |
|---|---|
void |
addHandler(RASIHandler handler)
Deprecated.
Registers a RAS handler with this logger.
|
void |
fireRASEvent(RASIEvent event)
Deprecated.
Sends a
RASIEvent to all handlers which will process
the event. |
java.lang.String |
getClient()
Deprecated.
Gets the name of the client which is associated with this logger.
|
java.util.Hashtable |
getConfig()
Deprecated.
Gets the configuration of this object.
|
java.util.Enumeration |
getHandlers()
Deprecated.
Gets all of the handlers associated with this logger.
|
java.lang.String |
getServer()
Deprecated.
Gets the name of the server which is associated with this logger.
|
boolean |
isLoggable(long type)
Deprecated.
Determines if a log entry will be processed by the logger and any of
the handlers.
|
boolean |
isLogging()
Deprecated.
Determines if a logger is logging data ("on") or not ("off").
|
boolean |
isSynchronous()
Deprecated.
Determines if synchronous logging is in effect.
|
void |
removeHandler(RASIHandler handler)
Deprecated.
Removes a RAS handler from this logger.
|
void |
setClient(java.lang.String name)
Deprecated.
Sets the name of the client which is associated with this logger.
|
void |
setConfig(java.util.Hashtable ht)
Deprecated.
Sets the configuration of this object.
|
void |
setLogging(boolean flag)
Deprecated.
Sets a flag that indicates whether the logger is logging data ("on")
or not ("off").
|
void |
setServer(java.lang.String name)
Deprecated.
Sets the name of the server which is associated with this logger.
|
void |
setSynchronous(boolean flag)
Deprecated.
Sets a flag that tells the logger whether to log data synchronously.
|
addMaskChangeListener, addMessageEventClass, addTraceEventClass, fireMaskChangedEvent, getMaskChangeListeners, getMessageEventClasses, getMessageMask, getTraceEventClasses, getTraceMask, removeMaskChangeListener, removeMessageEventClass, removeTraceEventClass, setMessageMask, setTraceMaskgetDescription, getGroup, getName, setDescription, setNamejava.util.Hashtable getConfig()
getConfig in interface RASIMaskChangeGeneratorgetConfig in interface RASIObjectHashtable containing the configuration.
This object inserts the following key/value pairs into the
configuration:
true if the logger is logging data;
otherwise, false.
true if the logger is logging synchronously;
otherwise, false.
All values are Strings.
The parent and extensions of this object may add additional keys.
void setConfig(java.util.Hashtable ht)
RASManager to initialize a RAS object.
It should not be necessary for an application to use this method.setConfig in interface RASIMaskChangeGeneratorsetConfig in interface RASIObjectht - A Hashtable containing the configuration.
This object searches for the following keys:
true if the logger is logging data;
otherwise, false.
true if the logger is logging synchronously;
otherwise, false.
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.
java.lang.String getClient()
void setClient(java.lang.String name)
null, the current name is not changed.name - The client name.java.lang.String getServer()
void setServer(java.lang.String name)
null, the current name is not changed.name - The server name.void addHandler(RASIHandler handler)
null or is already
registered, this method does nothing.handler - A RAS handler.void removeHandler(RASIHandler handler)
null or is not registered, this method does nothing.handler - A RAS handler.java.util.Enumeration getHandlers()
Enumeration of handlers. If no handlers
are registered, the Enumeration is empty.boolean isSynchronous()
true for synchronous logging and
false otherwise.void setSynchronous(boolean flag)
flag - A boolean set true for
synchronous logging and false otherwise.boolean isLogging()
true when the logger is "on" and
false otherwise.void setLogging(boolean flag)
flag - true when the logger is "on" and false
otherwise.boolean isLoggable(long type)
if (isLoggable(RASITraceEvent.TYPE_PUBLIC) trace(RASITraceEvent.TYPE_PUBLIC...);
type - The type of the log entry. The set of possible values is
defined by the RASIMessageEvent or
RASITraceEvent TYPE_XXXX
constants.true if the logger is enabled and at least one
handler will process the log entry; false,
otherwise.