Interface RASILogger
-
- All Superinterfaces:
- RASIMaskChangeGenerator, RASIObject, java.io.Serializable
- All Known Subinterfaces:
- RASIMessageLogger, RASITraceLogger
- All Known Implementing Classes:
- RASLogger, RASMessageLogger, RASTraceLogger, WsJrasMessageLogger, WsJrasTraceLogger
Deprecated.As of WAS 6.0, recommend using java.util.logging
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 theaddMessageEventClass
andaddTraceEventClass
methods to register theRASIEvent
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.- See Also:
RASIMessageLogger
,RASITraceLogger
-
-
Method Summary
Methods Modifier and Type Method and Description void
addHandler(RASIHandler handler)
Deprecated.Registers a RAS handler with this logger.void
fireRASEvent(RASIEvent event)
Deprecated.Sends aRASIEvent
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.-
Methods inherited from interface com.ibm.ras.RASIMaskChangeGenerator
addMaskChangeListener, addMessageEventClass, addTraceEventClass, fireMaskChangedEvent, getMaskChangeListeners, getMessageEventClasses, getMessageMask, getTraceEventClasses, getTraceMask, removeMaskChangeListener, removeMessageEventClass, removeTraceEventClass, setMessageMask, setTraceMask
-
Methods inherited from interface com.ibm.ras.RASIObject
getDescription, getGroup, getName, setDescription, setName
-
-
-
-
Method Detail
-
getConfig
java.util.Hashtable getConfig()
Deprecated.Gets the configuration of this object.- Specified by:
getConfig
in interfaceRASIMaskChangeGenerator
- Specified by:
getConfig
in interfaceRASIObject
- Returns:
- A
Hashtable
containing the configuration. This object inserts the following key/value pairs into the configuration:- isLogging
true
if the logger is logging data; otherwise,false
.- isSync
true
if the logger is logging synchronously; otherwise,false
.- server
- The server.
- client
- The client.
- handlerNames
- The names of the handlers attached to this logger.
All values are
Strings
. The parent and extensions of this object may add additional keys.
-
setConfig
void setConfig(java.util.Hashtable ht)
Deprecated.Sets the configuration of this object. This method is used by aRASManager
to initialize a RAS object. It should not be necessary for an application to use this method.- Specified by:
setConfig
in interfaceRASIMaskChangeGenerator
- Specified by:
setConfig
in interfaceRASIObject
- Parameters:
ht
- AHashtable
containing the configuration. This object searches for the following keys:- isLogging
true
if the logger is logging data; otherwise,false
.- isSync
true
if the logger is logging synchronously; otherwise,false
.- server
- The server.
- client
- The client.
- handlerNames
- The names of the handlers attached to this logger.
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.
-
getClient
java.lang.String getClient()
Deprecated.Gets the name of the client which is associated with this logger.- Returns:
- The client name, or an empty string ("") if the client has not been set.
-
setClient
void setClient(java.lang.String name)
Deprecated.Sets the name of the client which is associated with this logger. If the name isnull
, the current name is not changed.- Parameters:
name
- The client name.
-
getServer
java.lang.String getServer()
Deprecated.Gets the name of the server which is associated with this logger.- Returns:
- The server name, or an empty string ("") if the server has not been set.
-
setServer
void setServer(java.lang.String name)
Deprecated.Sets the name of the server which is associated with this logger. If the name isnull
, the current name is not changed.- Parameters:
name
- The server name.
-
addHandler
void addHandler(RASIHandler handler)
Deprecated.Registers a RAS handler with this logger. More than one handler may be associated with a logger to direct the RAS data to multiple destinations. If the handler isnull
or is already registered, this method does nothing.- Parameters:
handler
- A RAS handler.
-
removeHandler
void removeHandler(RASIHandler handler)
Deprecated.Removes a RAS handler from this logger. If the handler isnull
or is not registered, this method does nothing.- Parameters:
handler
- A RAS handler.
-
getHandlers
java.util.Enumeration getHandlers()
Deprecated.Gets all of the handlers associated with this logger.- Returns:
- An
Enumeration
of handlers. If no handlers are registered, theEnumeration
is empty.
-
isSynchronous
boolean isSynchronous()
Deprecated.Determines if synchronous logging is in effect. When logging synchronously, the logger will wait for the handlers to write a log entry before returning to the caller. Otherwise, the log entry is passed to the handler and the logger returns.- Returns:
true
for synchronous logging andfalse
otherwise.
-
setSynchronous
void setSynchronous(boolean flag)
Deprecated.Sets a flag that tells the logger whether to log data synchronously. When logging synchronously, the logger will wait for the handlers to write a log entry before returning to the caller. Otherwise, the log entry is passed to the handler and the logger returns.- Parameters:
flag
- Aboolean
settrue
for synchronous logging andfalse
otherwise.
-
isLogging
boolean isLogging()
Deprecated.Determines if a logger is logging data ("on") or not ("off").- Returns:
true
when the logger is "on" andfalse
otherwise.
-
setLogging
void setLogging(boolean flag)
Deprecated.Sets a flag that indicates whether the logger is logging data ("on") or not ("off").- Parameters:
flag
-true
when the logger is "on" andfalse
otherwise.
-
isLoggable
boolean isLoggable(long type)
Deprecated.Determines if a log entry will be processed by the logger and any of the handlers. Wrapping a message or trace call with this method can improve performance. Log entries that will not be processed need not even be built. For example:if (isLoggable(RASITraceEvent.TYPE_PUBLIC) trace(RASITraceEvent.TYPE_PUBLIC...);
- Parameters:
type
- The type of the log entry. The set of possible values is defined by theRASIMessageEvent
orRASITraceEvent
TYPE_XXXX
constants.- Returns:
true
if the logger is enabled and at least one handler will process the log entry;false
, otherwise.
-
-