|
IBM WebSphere Application ServerTM Release 8 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RASIMessageLogger
RASIMessageLogger
defines a set of methods that must be
implemented to create RAS messages. See RASMessageLogger
for
information on the usage of these methods.
RASILogger
Method Summary | |
---|---|
void |
addSuppressedKey(java.lang.String key)
Deprecated. Adds a message key to a set of keys which should not be logged. |
void |
exception(long type,
java.lang.Object obj,
java.lang.String methodName,
java.lang.Throwable exception)
Deprecated. Logs an Exception in a non-static method. |
void |
exception(long type,
java.lang.String className,
java.lang.String methodName,
java.lang.Throwable exception)
Deprecated. Logs an Exception in a static method. |
java.lang.String |
getComponent()
Deprecated. Gets the name of the component that is using this logger. |
java.util.Hashtable |
getConfig()
Deprecated. Gets the configuration of this object. |
java.lang.String |
getMessageFile()
Deprecated. Gets the message file associated with this logger. |
long |
getMessageMask()
Deprecated. Gets the mask which defines the set of message types that will be processed. |
java.lang.String |
getOrganization()
Deprecated. Gets the name of the organization which wrote the application that is using this logger. |
java.lang.String |
getProduct()
Deprecated. Gets the name of the product that is using this logger. |
java.util.Vector |
getSuppressedKeys()
Deprecated. Gets all of the suppressed message keys associated with this logger. |
void |
message(long type,
java.lang.Object obj,
java.lang.String methodName,
java.lang.String key)
Deprecated. Logs a message, by key, with no parameters. |
void |
message(long type,
java.lang.Object obj,
java.lang.String methodName,
java.lang.String key,
java.lang.Object parm1)
Deprecated. Logs a message, by key, with one parameter. |
void |
message(long type,
java.lang.Object obj,
java.lang.String methodName,
java.lang.String key,
java.lang.Object[] parms)
Deprecated. Logs a message, by key, with an array of parameters. |
void |
message(long type,
java.lang.Object obj,
java.lang.String methodName,
java.lang.String key,
java.lang.Object parm1,
java.lang.Object parm2)
Deprecated. Logs a message, by key, with two parameters. |
void |
message(long type,
java.lang.String className,
java.lang.String methodName,
java.lang.String key)
Deprecated. Logs a message, by key, with no parameters. |
void |
message(long type,
java.lang.String className,
java.lang.String methodName,
java.lang.String key,
java.lang.Object parm1)
Deprecated. Logs a message, by key, with one parameter. |
void |
message(long type,
java.lang.String className,
java.lang.String methodName,
java.lang.String key,
java.lang.Object[] parms)
Deprecated. Logs a message, by key, with an array of parameters. |
void |
message(long type,
java.lang.String className,
java.lang.String methodName,
java.lang.String key,
java.lang.Object parm1,
java.lang.Object parm2)
Deprecated. Logs a message, by key, with two parameters. |
void |
msg(long type,
java.lang.Object obj,
java.lang.String methodName,
java.lang.String key,
java.lang.String file)
Deprecated. Logs a message, by key and file, with no parameters. |
void |
msg(long type,
java.lang.Object obj,
java.lang.String methodName,
java.lang.String key,
java.lang.String file,
java.lang.Object parm1)
Deprecated. Logs a message, by key and file with one parameter. |
void |
msg(long type,
java.lang.Object obj,
java.lang.String methodName,
java.lang.String key,
java.lang.String file,
java.lang.Object[] parms)
Deprecated. Logs a message, by key and file, with an array of parameters. |
void |
msg(long type,
java.lang.Object obj,
java.lang.String methodName,
java.lang.String key,
java.lang.String file,
java.lang.Object parm1,
java.lang.Object parm2)
Deprecated. Logs a message, by key and file, with two parameters. |
void |
msg(long type,
java.lang.String className,
java.lang.String methodName,
java.lang.String key,
java.lang.String file)
Deprecated. Logs a message, by key and file, with no parameters. |
void |
msg(long type,
java.lang.String className,
java.lang.String methodName,
java.lang.String key,
java.lang.String file,
java.lang.Object parm1)
Deprecated. Logs a message, by key and file, with one parameter. |
void |
msg(long type,
java.lang.String className,
java.lang.String methodName,
java.lang.String key,
java.lang.String file,
java.lang.Object[] parms)
Deprecated. Logs a message, by key and file, with an array of parameters. |
void |
msg(long type,
java.lang.String className,
java.lang.String methodName,
java.lang.String key,
java.lang.String file,
java.lang.Object parm1,
java.lang.Object parm2)
Deprecated. Logs a message, by key and file, with two parameters. |
void |
removeSuppressedKey(java.lang.String key)
Deprecated. Removes a message key from the set of keys which should not be logged. |
void |
setComponent(java.lang.String name)
Deprecated. Sets the name of the component that is using this logger. |
void |
setConfig(java.util.Hashtable ht)
Deprecated. Sets the configuration of this object. |
void |
setMessageFile(java.lang.String file)
Deprecated. Sets the message file associated with this logger. |
void |
setMessageMask(long mask)
Deprecated. Sets the mask which defines the set of message types that will be processed. |
void |
setOrganization(java.lang.String name)
Deprecated. Sets the name of the organization which wrote the application that is using this logger. |
void |
setProduct(java.lang.String name)
Deprecated. Sets the name of the product that is using this logger. |
void |
textMessage(long type,
java.lang.Object obj,
java.lang.String methodName,
java.lang.String text)
Deprecated. Logs a text message (no key) with no parameters. |
void |
textMessage(long type,
java.lang.Object obj,
java.lang.String methodName,
java.lang.String text,
java.lang.Object parm1)
Deprecated. Logs a text message (no key) with one parameter. |
void |
textMessage(long type,
java.lang.Object obj,
java.lang.String methodName,
java.lang.String text,
java.lang.Object[] parms)
Deprecated. Logs a text message (no key) with an array of parameters. |
void |
textMessage(long type,
java.lang.Object obj,
java.lang.String methodName,
java.lang.String text,
java.lang.Object parm1,
java.lang.Object parm2)
Deprecated. Logs a text message (no key) with two parameters. |
void |
textMessage(long type,
java.lang.String className,
java.lang.String methodName,
java.lang.String text)
Deprecated. Logs a text message (no key) with no parameters. |
void |
textMessage(long type,
java.lang.String className,
java.lang.String methodName,
java.lang.String text,
java.lang.Object parm1)
Deprecated. Logs a text message (no key) with one parameter. |
void |
textMessage(long type,
java.lang.String className,
java.lang.String methodName,
java.lang.String text,
java.lang.Object[] parms)
Deprecated. Logs a text message (no key) with an array of parameters. |
void |
textMessage(long type,
java.lang.String className,
java.lang.String methodName,
java.lang.String text,
java.lang.Object parm1,
java.lang.Object parm2)
Deprecated. Logs a text message (no key) with two parameters. |
Methods inherited from interface com.ibm.ras.RASILogger |
---|
addHandler, fireRASEvent, getClient, getHandlers, getServer, isLoggable, isLogging, isSynchronous, removeHandler, setClient, setLogging, setServer, setSynchronous |
Methods inherited from interface com.ibm.ras.RASIMaskChangeGenerator |
---|
addMaskChangeListener, addMessageEventClass, addTraceEventClass, fireMaskChangedEvent, getMaskChangeListeners, getMessageEventClasses, getTraceEventClasses, getTraceMask, removeMaskChangeListener, removeMessageEventClass, removeTraceEventClass, setTraceMask |
Methods inherited from interface com.ibm.ras.RASIObject |
---|
getDescription, getGroup, getName, setDescription, setName |
Method Detail |
---|
java.util.Hashtable getConfig()
getConfig
in interface RASILogger
getConfig
in interface RASIMaskChangeGenerator
getConfig
in interface RASIObject
Hashtable
containing the configuration.
This object inserts the following key/value pairs into the
configuration:
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 RASILogger
setConfig
in interface RASIMaskChangeGenerator
setConfig
in interface RASIObject
ht
- A Hashtable
containing the configuration.
This object searches for the following keys:
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.
long getMessageMask()
RASIMessageEvent
TYPE_XXXX
constants.
getMessageMask
in interface RASIMaskChangeGenerator
void setMessageMask(long mask)
RASIMessageEvent
TYPE_XXXX
constants.
The mask value is not validated against these types.
setMessageMask
in interface RASIMaskChangeGenerator
mask
- The message mask.java.lang.String getOrganization()
void setOrganization(java.lang.String name)
null
, the current
name is not changed.
name
- The organization name.java.lang.String getProduct()
void setProduct(java.lang.String name)
null
, the current name is not changed.
name
- The product name.java.lang.String getComponent()
void setComponent(java.lang.String name)
null
, the current name is not changed.
name
- The component name.java.lang.String getMessageFile()
null
if a message file
has not been added to the logger.void setMessageFile(java.lang.String file)
null
, the current message file is not changed.
If the message file does not exist, a message indicating this will
be displayed in place of the formatted message.
file
- The message file name.void addSuppressedKey(java.lang.String key)
null
or is already registered, this method does nothing.
key
- The message key which is not to be logged.void removeSuppressedKey(java.lang.String key)
null
or is not registered, this method
does nothing.
key
- The message key to be removed.java.util.Vector getSuppressedKeys()
Vector
of message keys. If no suppressed keys
are registered, the Vector
is empty.void message(long type, java.lang.Object obj, java.lang.String methodName, java.lang.String key)
type
- The type of the message.obj
- The logging object ("this").methodName
- The name of the logging method.key
- The message key.void message(long type, java.lang.Object obj, java.lang.String methodName, java.lang.String key, java.lang.Object parm1)
type
- The type of the message.obj
- The logging object ("this").methodName
- The name of the logging method.key
- The message key.parm1
- An element to be inserted into the message.void message(long type, java.lang.Object obj, java.lang.String methodName, java.lang.String key, java.lang.Object parm1, java.lang.Object parm2)
type
- The type of the message.obj
- The logging object ("this").methodName
- The name of the logging method.key
- The message key.parm1
- An element to be inserted into the message.parm2
- An element to be inserted into the message.void message(long type, java.lang.Object obj, java.lang.String methodName, java.lang.String key, java.lang.Object[] parms)
type
- The type of the message.obj
- The logging object ("this").methodName
- The name of the logging method.key
- The message key.parms
- An array of elements to be inserted into the message.void message(long type, java.lang.String className, java.lang.String methodName, java.lang.String key)
type
- The type of the message.className
- The name of the logging class.methodName
- The name of the logging method.key
- The message key.void message(long type, java.lang.String className, java.lang.String methodName, java.lang.String key, java.lang.Object parm1)
type
- The type of the message.className
- The name of the logging class.methodName
- The name of the logging method.key
- The message key.parm1
- An element to be inserted into the message.void message(long type, java.lang.String className, java.lang.String methodName, java.lang.String key, java.lang.Object parm1, java.lang.Object parm2)
type
- The type of the message.className
- The name of the logging class.methodName
- The name of the logging method.key
- The message key.parm1
- An element to be inserted into the message.parm2
- An element to be inserted into the message.void message(long type, java.lang.String className, java.lang.String methodName, java.lang.String key, java.lang.Object[] parms)
type
- The type of the message.className
- The name of the logging class.methodName
- The name of the logging method.key
- The message key.parms
- An array of elements to be inserted into the message.void msg(long type, java.lang.Object obj, java.lang.String methodName, java.lang.String key, java.lang.String file)
type
- The type of the message.obj
- The logging object ("this").methodName
- The name of the logging method.key
- The message key.file
- The name of the message file to use.void msg(long type, java.lang.Object obj, java.lang.String methodName, java.lang.String key, java.lang.String file, java.lang.Object parm1)
type
- The type of the message.obj
- The logging object ("this").methodName
- The name of the logging method.key
- The message key.file
- The name of the message file to use.parm1
- An element to be inserted into the message.void msg(long type, java.lang.Object obj, java.lang.String methodName, java.lang.String key, java.lang.String file, java.lang.Object parm1, java.lang.Object parm2)
type
- The type of the message.obj
- The logging object ("this").methodName
- The name of the logging method.key
- The message key.file
- The name of the message file to use.parm1
- An element to be inserted into the message.parm2
- An element to be inserted into the message.void msg(long type, java.lang.Object obj, java.lang.String methodName, java.lang.String key, java.lang.String file, java.lang.Object[] parms)
type
- The type of the message.obj
- The logging object ("this").methodName
- The name of the logging method.key
- The message key.file
- The name of the message file to use.parms
- An array of elements to be inserted into the message.void msg(long type, java.lang.String className, java.lang.String methodName, java.lang.String key, java.lang.String file)
type
- The type of the message.className
- The name of the logging class.methodName
- The name of the logging method.key
- The message key.file
- The name of the message file to use.void msg(long type, java.lang.String className, java.lang.String methodName, java.lang.String key, java.lang.String file, java.lang.Object parm1)
type
- The type of the message.className
- The name of the logging class.methodName
- The name of the logging method.key
- The message key.file
- The name of the message file to use.parm1
- An element to be inserted into the message.void msg(long type, java.lang.String className, java.lang.String methodName, java.lang.String key, java.lang.String file, java.lang.Object parm1, java.lang.Object parm2)
type
- The type of the message.className
- The name of the logging class.methodName
- The name of the logging method.key
- The message key.file
- The name of the message file to use.parm1
- An element to be inserted into the message.parm2
- An element to be inserted into the message.void msg(long type, java.lang.String className, java.lang.String methodName, java.lang.String key, java.lang.String file, java.lang.Object[] parms)
type
- The type of the message.className
- The name of the logging class.methodName
- The name of the logging method.key
- The message key.file
- The name of the message file to use.parms
- An array of elements to be inserted into the message.void textMessage(long type, java.lang.Object obj, java.lang.String methodName, java.lang.String text)
type
- The type of the message.obj
- The logging object ("this").methodName
- The name of the logging method.text
- The message text.void textMessage(long type, java.lang.Object obj, java.lang.String methodName, java.lang.String text, java.lang.Object parm1)
type
- The type of the message.obj
- The logging object ("this").methodName
- The name of the logging method.text
- The message text.parm1
- An element to be displayed with the message.void textMessage(long type, java.lang.Object obj, java.lang.String methodName, java.lang.String text, java.lang.Object parm1, java.lang.Object parm2)
type
- The type of the message.obj
- The logging object ("this").methodName
- The name of the logging method.text
- The message text.parm1
- An element to be displayed with the message.parm2
- An element to be displayed with the message.void textMessage(long type, java.lang.Object obj, java.lang.String methodName, java.lang.String text, java.lang.Object[] parms)
type
- The type of the message.obj
- The logging object ("this").methodName
- The name of the logging method.text
- The message text.parms
- An array of elements to be displayed with the message.void textMessage(long type, java.lang.String className, java.lang.String methodName, java.lang.String text)
type
- The type of the message.className
- The name of the logging class.methodName
- The name of the logging method.text
- The message text.void textMessage(long type, java.lang.String className, java.lang.String methodName, java.lang.String text, java.lang.Object parm1)
type
- The type of the message.className
- The name of the logging class.methodName
- The name of the logging method.text
- The message text.parm1
- An element to be displayed with the message.void textMessage(long type, java.lang.String className, java.lang.String methodName, java.lang.String text, java.lang.Object parm1, java.lang.Object parm2)
type
- The type of the message.className
- The name of the logging class.methodName
- The name of the logging method.text
- The message text.parm1
- An element to be displayed with the message.parm2
- An element to be displayed with the message.void textMessage(long type, java.lang.String className, java.lang.String methodName, java.lang.String text, java.lang.Object[] parms)
type
- The type of the message.className
- The name of the logging class.methodName
- The name of the logging method.text
- The message text.parms
- An array of elements to be displayed with the message.void exception(long type, java.lang.Object obj, java.lang.String methodName, java.lang.Throwable exception)
Exception
in a non-static method.
type
- The type of the trace point.obj
- The traced object ("this").methodName
- The name of the traced method.exception
- A Throwable
object.void exception(long type, java.lang.String className, java.lang.String methodName, java.lang.Throwable exception)
Exception
in a static method.
type
- The type of the trace point.className
- The name of the traced class.methodName
- The name of the traced method.exception
- A Throwable
object.
|
IBM WebSphere Application ServerTM Release 8 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |