com.ibm.ras
Interface RASIMessageLogger
-
- All Superinterfaces:
- RASILogger, RASIMaskChangeGenerator, RASIObject, java.io.Serializable
- All Known Implementing Classes:
- RASMessageLogger, WsJrasMessageLogger
Deprecated.As of WAS 6.0, recommend using java.util.logging
public interface RASIMessageLogger extends RASILogger
RASIMessageLogger
defines a set of methods that must be implemented to create RAS messages. SeeRASMessageLogger
for information on the usage of these methods.- See Also:
RASILogger
-
-
Method Summary
Methods Modifier and Type Method and Description 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 anException
in a non-static method.void
exception(long type, java.lang.String className, java.lang.String methodName, java.lang.Throwable exception)
Deprecated.Logs anException
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
-
getConfig
java.util.Hashtable getConfig()
Deprecated.Gets the configuration of this object.- Specified by:
getConfig
in interfaceRASILogger
- 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:- organization
- The organization.
- product
- The product.
- component
- The component.
- messageFile
- A message file name, used to translate message keys.
- suppressedKeys
- A blank-delimited set of message keys which are not to be processed.
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 interfaceRASILogger
- Specified by:
setConfig
in interfaceRASIMaskChangeGenerator
- Specified by:
setConfig
in interfaceRASIObject
- Parameters:
ht
- AHashtable
containing the configuration. This object searches for the following keys:- organization
- The organization.
- product
- The product.
- component
- The component.
- messageFile
- A message file name, used to translate message keys.
- suppressedKeys
- A blank-delimited set of message keys which are not to be processed.
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
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 theRASIMessageEvent
TYPE_XXXX
constants.- Specified by:
getMessageMask
in interfaceRASIMaskChangeGenerator
- Returns:
- The message mask.
-
setMessageMask
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 logical OR of theRASIMessageEvent
TYPE_XXXX
constants. The mask value is not validated against these types.- Specified by:
setMessageMask
in interfaceRASIMaskChangeGenerator
- Parameters:
mask
- The message mask.
-
getOrganization
java.lang.String getOrganization()
Deprecated.Gets the name of the organization which wrote the application that is using this logger.- Returns:
- The organization name, or an empty string ("") if the organization has not been set.
-
setOrganization
void setOrganization(java.lang.String name)
Deprecated.Sets the name of the organization which wrote the application that is using this logger. If the name isnull
, the current name is not changed.- Parameters:
name
- The organization name.
-
getProduct
java.lang.String getProduct()
Deprecated.Gets the name of the product that is using this logger.- Returns:
- The product name, or an empty string ("") if the product has not been set.
-
setProduct
void setProduct(java.lang.String name)
Deprecated.Sets the name of the product that is using this logger. If the name isnull
, the current name is not changed.- Parameters:
name
- The product name.
-
getComponent
java.lang.String getComponent()
Deprecated.Gets the name of the component that is using this logger.- Returns:
- The component name, or an empty string ("") if the component has not been set.
-
setComponent
void setComponent(java.lang.String name)
Deprecated.Sets the name of the component that is using this logger. If the name isnull
, the current name is not changed.- Parameters:
name
- The component name.
-
getMessageFile
java.lang.String getMessageFile()
Deprecated.Gets the message file associated with this logger.- Returns:
- The message file name, or
null
if a message file has not been added to the logger.
-
setMessageFile
void setMessageFile(java.lang.String file)
Deprecated.Sets the message file associated with this logger. If the file isnull
, 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.- Parameters:
file
- The message file name.
-
addSuppressedKey
void addSuppressedKey(java.lang.String key)
Deprecated.Adds a message key to a set of keys which should not be logged. More than one message key may be in this set. If the key isnull
or is already registered, this method does nothing.- Parameters:
key
- The message key which is not to be logged.
-
removeSuppressedKey
void removeSuppressedKey(java.lang.String key)
Deprecated.Removes a message key from the set of keys which should not be logged. If the key isnull
or is not registered, this method does nothing.- Parameters:
key
- The message key to be removed.
-
getSuppressedKeys
java.util.Vector getSuppressedKeys()
Deprecated.Gets all of the suppressed message keys associated with this logger.- Returns:
- A
Vector
of message keys. If no suppressed keys are registered, theVector
is empty.
-
message
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. This call can be used in a non-static method and assumes that at least one message file is registered with the logger.- Parameters:
type
- The type of the message.obj
- The logging object ("this").methodName
- The name of the logging method.key
- The message key.
-
message
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. This call can be used in a non-static method and assumes that at least one message file is registered with the logger.- Parameters:
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.
-
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)
Deprecated.Logs a message, by key, with two parameters. This call can be used in a non-static method and assumes that at least one message file is registered with the logger.- Parameters:
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.
-
message
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. This call can be used in a non-static method and assumes that at least one message file is registered with the logger.- Parameters:
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.
-
message
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. This call can be used in any method and assumes that at least one message file is registered with the logger.- Parameters:
type
- The type of the message.className
- The name of the logging class.methodName
- The name of the logging method.key
- The message key.
-
message
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. This call can be used in any method and assumes that at least one message file is registered with the logger.- Parameters:
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.
-
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)
Deprecated.Logs a message, by key, with two parameters. This call can be used in any method and assumes that at least one message file is registered with the logger.- Parameters:
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.
-
message
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. This call can be used in any method and assumes that at least one message file is registered with the logger.- Parameters:
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.
-
msg
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. This call can be used in a non-static method.- Parameters:
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.
-
msg
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. This call can be used in a non-static method.- Parameters:
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.
-
msg
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. This call can be used in a non-static method.- Parameters:
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.
-
msg
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. This call can be used in a non-static method.- Parameters:
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.
-
msg
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. This call can be used in any method.- Parameters:
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.
-
msg
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. This call can be used in any method.- Parameters:
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.
-
msg
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. This call can be used in any method.- Parameters:
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.
-
msg
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. This call can be used in any method.- Parameters:
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.
-
textMessage
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. This call can be used in a non-static method.- Parameters:
type
- The type of the message.obj
- The logging object ("this").methodName
- The name of the logging method.text
- The message text.
-
textMessage
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. This call can be used in a non-static method.- Parameters:
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.
-
textMessage
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. This call can be used in a non-static method.- Parameters:
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.
-
textMessage
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. This call can be used in a non-static method.- Parameters:
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.
-
textMessage
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. This call can be used in any method.- Parameters:
type
- The type of the message.className
- The name of the logging class.methodName
- The name of the logging method.text
- The message text.
-
textMessage
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. This call can be used in any method.- Parameters:
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.
-
textMessage
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. This call can be used in any method.- Parameters:
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.
-
textMessage
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. This call can be used in any method.- Parameters:
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.
-
exception
void exception(long type, java.lang.Object obj, java.lang.String methodName, java.lang.Throwable exception)
Deprecated.Logs anException
in a non-static method.- Parameters:
type
- The type of the trace point.obj
- The traced object ("this").methodName
- The name of the traced method.exception
- AThrowable
object.
-
exception
void exception(long type, java.lang.String className, java.lang.String methodName, java.lang.Throwable exception)
Deprecated.Logs anException
in a static method.- Parameters:
type
- The type of the trace point.className
- The name of the traced class.methodName
- The name of the traced method.exception
- AThrowable
object.
-
-