com.ibm.ras
Class WsJrasMessageLogger

java.lang.Object
  |
  +--com.ibm.ras.RASObject
        |
        +--com.ibm.ras.RASLogger
              |
              +--com.ibm.ras.RASMessageLogger
                    |
                    +--com.ibm.ras.WsJrasMessageLogger
All Implemented Interfaces:
java.util.EventListener, RASILogger, RASIMaskChangeListener, RASIMessageLogger, RASIObject

public class WsJrasMessageLogger
extends RASMessageLogger
implements RASIMessageLogger

The WsJRasMessageLogger class extends the RASMessageLogger class and implements the RASIMessageLogger interface. Users must not directly create an instance of a WsJRasMessageLogger. Instead, the Manager class must be used to obtain an instance.

A WsJrasMessageLogger is fully integrated with the native WebSphere message logging facilities. As such, messages logged via this class are forwarded on to existing Systems Management runtime facilities. The existing Systems Managment facilities can be used to view, sort and manage these messages. By default, message logging is enabled when a WsJrasMessageLogger is created.

Four basic message logging methods are provided by the RASIMessageLogger interface. They are message, msg, textMessage and exception. These methods all include the name of the class and method which generated the message. When logging messages in non-static methods, you may use the methods that take "this" (the object performing the logging) as the second parameter. This is a convenience to the programmer, as the class name can be derived from any Object. For static methods, an object does not exist. Use the methods which take "String className" as the second parameter. Of course, this latter approach may be used in all methods, if desired. It will result in better performance (significant if many messages are logged), as the RAS system will not have to translate an Object to a class name.

The set of types that may be used in the message, msg, textMessage and exception methods is defined in the RASIMessageEvent class. The type assigned to any trace point is arbitrary and up to the user. It should be noted that the types defined in the RASIMessageEvent class are mapped to existing trace types supported by the WebSphere runtime. This mapping may vary with edition. See the documentation for your edition to determine the mappings in effect.

Normally, the text for a set of messages is stored in one or more message files. Text strings are accessed by a "key," which is a name for the message text. This mechanism allows the message text to be separated from the program that uses it, making translation into different national languages easier. A message logger therefore, must be told which message files to search. Two mechanisms are available to accomplish this:

The message key can be any desired string. For example, a key HUNGRY might select the message text, "Are you ready to eat?". Run-time substitution of variables into the message text is possible. The message and msg methods accept a number of Objects whose String representations may be inserted into the message text according to the rules of the java.text.MessageFormat class. The only restriction is that the Objects are converted to Strings before they are passed to the MessageFormat class, so that the MessageFormat style options (such as {1,time}) may not be used. If a message file is not specified or does not exist, or the message key is not found in the message file, an error message is formatted instead.

WsJrasMessageLogger provides minimal support for the logging of plain text messages which do not use message catalogs. The textMessage methods are available for this. They are provided as a convenience for an application developer who might want to log a quick debug message that will not make it into the final product. The textMessage method takes an arbitrary text string in place of a message key. Objects may be included with the message, but they are simply displayed with the message text (according to their toString representation), not substituted into the message text.

WsJrasMessageLogger has several other fields which may be included in the message. These fields should not vary among messages produced by a given WsJrasMessageLogger, so they are not included in the methods of this class. They are specified when the WsJrasMessageLogger is obtained from the Manager or by the appropriate "set" and "get" methods of this class. These fields are:

If not specified, each of these fields defaults to an empty string.

See Also:
RASIMessageLogger, RASIMessageEvent

Fields inherited from class com.ibm.ras.RASLogger
isLogging
 
Method Summary
 void addHandler(RASIHandler handler)
          Register a RASIHandler handler with this logger.
 void addSuppressedKey(java.lang.String key)
          Add a single 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.Exception exc)
          Log an Exception in a non-static method.
 void exception(long type, java.lang.String className, java.lang.String methodName, java.lang.Exception exc)
          Log an Exception in a static method.
 java.lang.String getClient()
          Get the name of the client which is associated with this logger.
 java.lang.String getComponent()
          Get the name of the component that is using this object.
 java.util.Hashtable getConfig()
          Get the configuration of this object.
 java.lang.String getDescription()
          Get the description field for this object.
 java.util.Enumeration getHandlers()
          Get all of the handlers associated with this logger.
 java.lang.String getMessageFile()
          Get the message file associated with this logger.
 long getMessageMask()
          Get the mask which defines the set of message types that will be processed by this object.
 java.lang.String getName()
          Get the name of this object that was specified when the object was created.
 java.lang.String getOrganization()
          Get the name of the organization which wrote the application that is using this object.
 java.lang.String getProduct()
          Get the name of the product that is using this object.
 java.lang.String getServer()
          Get the name of the server which is associated with this object.
 java.util.Vector getSuppressedKeys()
          Get all of the suppressed message keys associated with this logger.
 boolean isLoggable(long type)
          Determine if the specified RASIMessageEvent type is currently enabled for this WsJrasMessageLogger.
 boolean isSynchronous()
          Determine if synchronous logging is in effect.
 void message(long type, java.lang.Object obj, java.lang.String methodName, java.lang.String key)
          Log 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)
          Log 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)
          Log 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)
          Log a message, by key, with two parameters.
 void message(long type, java.lang.String className, java.lang.String methodName, java.lang.String key)
          Log 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)
          Log 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)
          Log 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)
          Log 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)
          Log 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)
          Log 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)
          Log 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)
          Log 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)
          Log 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)
          Log 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)
          Log 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)
          Log a message, by key and file, with two parameters.
 void removeHandler(RASIHandler handler)
          Remove a RASIHandler from this logger.
 void removeSuppressedKey(java.lang.String key)
          Remove a single message key from the set of keys which should not be logged.
 void setClient(java.lang.String name)
          Set the name of the client which is associated with this logger.
 void setComponent(java.lang.String name)
          Set the name of the component that is using this logger.
 void setConfig(java.util.Hashtable ht)
          Set the configuration of this object.
 void setDescription(java.lang.String desc)
          Set the description field of this object to the specified value.
 void setMessageFile(java.lang.String file)
          Set the message file associated with this logger.
 void setMessageMask(long mask)
          Set the mask which defines the set of message types that will be processed by this object.
 void setName(java.lang.String name)
          Set the name by which this object is known.
 void setOrganization(java.lang.String name)
          Set the name of the organization which wrote the application that is using this logger.
 void setProduct(java.lang.String name)
          Set the name of the product that is using this logger.
 void setServer(java.lang.String name)
          Set the name of the server which is associated with this logger.
 void setSynchronous(boolean flag)
          Set a flag to tell the logger whether to log data synchronously or asynchronously.
 void textMessage(long type, java.lang.Object obj, java.lang.String methodName, java.lang.String text)
          Log 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)
          Log 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)
          Log 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)
          Log a text message (no key) with two parameters.
 void textMessage(long type, java.lang.String className, java.lang.String methodName, java.lang.String text)
          Log 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)
          Log 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)
          Log 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)
          Log a text message (no key) with two parameters.
 
Methods inherited from class com.ibm.ras.RASMessageLogger
maskValueChanged
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getConfig

public java.util.Hashtable getConfig()
Get the configuration of this object.

Websphere WsJrasMessageLoggers are fully configured by the runtime when created. The configuration data has no significant meaning outside of the runtime context. Null will always be returned.

Specified by:
getConfig in interface RASIMessageLogger
Overrides:
getConfig in class RASMessageLogger
Returns:
null

setConfig

public void setConfig(java.util.Hashtable ht)
Set the configuration of this object.

Websphere WsJrasMessageLoggers are fully configured by the runtime when created. Users are not allowed to reconfigure or change the internal configuration state of a WsJrasMessageLogger via this interface. Calling this method results in a no-op.

Specified by:
setConfig in interface RASIMessageLogger
Overrides:
setConfig in class RASMessageLogger
Following copied from interface: com.ibm.ras.RASIMessageLogger
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.
            "organization"   The organization.
            "product"        The product.
            "component"      The component.
            "server"         The server.
            "client"         The client.
            "messageMask"    The mask which selects the message types to
                             be processed.
            "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, that configuration element is not updated. The parent and extensions of this object may use additional keys.

getDescription

public java.lang.String getDescription()
Get the description field for this object.

The WebSphere runtime does not utilize this field. For performance and memory footprint reasons it is recommended that users do not use this field.

Specified by:
getDescription in interface RASIObject
Overrides:
getDescription in class RASObject
Returns:
the value of the description set via the setDescription() method or the empty String if no value has been set.

setDescription

public void setDescription(java.lang.String desc)
Set the description field of this object to the specified value.

The WebSphere runtime does not utilize the description field. For performance and memory footprint reasons, it is recommended that users do not utilize this field.

Specified by:
setDescription in interface RASIObject
Overrides:
setDescription in class RASObject
Parameters:
desc - the new value for the description field. If null is passed, the current value is not changed.

getName

public java.lang.String getName()
Get the name of this object that was specified when the object was created.

The name field specfied when then WsJrasMessageLogger was created is returned. This field is settable only on creation and is otherwise immutable.

Specified by:
getName in interface RASIObject
Overrides:
getName in class RASObject
Returns:
the value specified for the name of this object when it was created.

setName

public void setName(java.lang.String name)
Set the name by which this object is known.

The WebSphere runtime is dependent upon the name field to coherently manage the state of a WsJrasMessageLogger. The name for a WsJrasMessageLogger is specified to the Manager when the WsJrasMessageLogger is created. Users are not allowed to subsequently change the name. This operation is a no-op.

Specified by:
setName in interface RASIObject
Overrides:
setName in class RASObject
Parameters:
name - The name of this object.

addHandler

public void addHandler(RASIHandler handler)
Register a RASIHandler handler with this logger.

The WebSphere runtime configures this object with the appropriate system-integrated handlers when the object is created. Currently, users ar not allowed to add other RASIHandlers. This method is a no-op.

Specified by:
addHandler in interface RASILogger
Overrides:
addHandler in class RASLogger
Parameters:
handler - A RASIHandler handler.

removeHandler

public void removeHandler(RASIHandler handler)
Remove a RASIHandler from this logger.

The WebSphere runtime configures this object with the appropriate system-integrated handlers when the object is created. Currently, users cannot get a reference to any system-supplied handler and are not allowed to add their own. This method is a no-op.

Specified by:
removeHandler in interface RASILogger
Overrides:
removeHandler in class RASLogger
Parameters:
handler - A RASIHandler handler.

getHandlers

public java.util.Enumeration getHandlers()
Get all of the handlers associated with this logger.

The WebSphere runtime does not support users adding RASIHandlers to this object and does not return references to WebSphere-created handlers to user code. This method will always returns null.

Specified by:
getHandlers in interface RASILogger
Overrides:
getHandlers in class RASLogger
Returns:
null.

setSynchronous

public void setSynchronous(boolean flag)
Set a flag to tell the logger whether to log data synchronously or asynchronously.

The WebSphere runtime dictates that all logging must be performed synchronously and the user is not allowed to override that behavior. This method is a no-op.

Specified by:
setSynchronous in interface RASILogger
Overrides:
setSynchronous in class RASLogger
Following copied from interface: com.ibm.ras.RASILogger
Parameters:
flag - A boolean set true for synchronous logging and false otherwise.

isSynchronous

public boolean isSynchronous()
Determine if synchronous logging is in effect.

The WebSphere runtime dictates that all logging must be performed synchronously and the user is not allowed to override that behavior. This method always returns true.

Specified by:
isSynchronous in interface RASILogger
Overrides:
isSynchronous in class RASLogger
Returns:
true

isLoggable

public boolean isLoggable(long type)
Determine if the specified RASIMessageEvent type is currently enabled for this WsJrasMessageLogger.

This method also provides an efficiency mechanism to wrap a logging call. Log entries that will not be processed need not even be built. For example:

 if (messageLogger.isLoggable(RASIMessageEvent.TYPE_INFO)
   messageLogger.message(RASIMessageEvent.TYPE_INFO...);
 

Specified by:
isLoggable in interface RASILogger
Overrides:
isLoggable in class RASLogger
Parameters:
type - The type of the log entry. The set of possible values is defined by the RASIMessageEvent constants
Returns:
true if the trace event will be logged, false otherwise.

getMessageMask

public long getMessageMask()
Get the mask which defines the set of message types that will be processed by this object.

Specified by:
getMessageMask in interface RASIMessageLogger
Overrides:
getMessageMask in class RASMessageLogger
Returns:
The message mask.

setMessageMask

public void setMessageMask(long mask)
Set the mask which defines the set of message types that will be processed by this object.

The WebSphere runtime sets this mask to the appropriate value when this object is created. User code does not need to set or reset this mask value programmatically.

Specified by:
setMessageMask in interface RASIMessageLogger
Overrides:
setMessageMask in class RASMessageLogger
Parameters:
mask - The message mask.

getOrganization

public java.lang.String getOrganization()
Get the name of the organization which wrote the application that is using this object.

Specified by:
getOrganization in interface RASIMessageLogger
Overrides:
getOrganization in class RASMessageLogger
Returns:
The organization name specified when this object was created.

setOrganization

public void setOrganization(java.lang.String name)
Set the name of the organization which wrote the application that is using this logger.

The organization name was specified when the logger was created. This name is treated as an immutable field by the WebSphere runtime. This method results in a no-op.

Specified by:
setOrganization in interface RASIMessageLogger
Overrides:
setOrganization in class RASMessageLogger
Parameters:
name - The organization name.

getProduct

public java.lang.String getProduct()
Get the name of the product that is using this object.

Specified by:
getProduct in interface RASIMessageLogger
Overrides:
getProduct in class RASMessageLogger
Returns:
The product name that was specified when this object was created.

setProduct

public void setProduct(java.lang.String name)
Set the name of the product that is using this logger.

The product name was specified when the logger was created. This name is treated as an immutable field by the WebSphere runtime. This method results in a no-op.

Specified by:
setProduct in interface RASIMessageLogger
Overrides:
setProduct in class RASMessageLogger
Parameters:
name - The product name.

getComponent

public java.lang.String getComponent()
Get the name of the component that is using this object.

Specified by:
getComponent in interface RASIMessageLogger
Overrides:
getComponent in class RASMessageLogger
Returns:
The component name that was specified when this logger was created.

setComponent

public void setComponent(java.lang.String name)
Set the name of the component that is using this logger.

The component name was specified when the logger was created. This name is treated as an immutable field by the WebSphere runtime. This method results in a no-op.

Specified by:
setComponent in interface RASIMessageLogger
Overrides:
setComponent in class RASMessageLogger
Parameters:
name - The component name.

getServer

public java.lang.String getServer()
Get the name of the server which is associated with this object.

The WebSphere runtime does not utilize this field. For performance and memory footprint reasons it is recommended that users do not use this field.

Specified by:
getServer in interface RASIMessageLogger
Overrides:
getServer in class RASLogger
Returns:
The server name, or an empty string ("") if the server has not been set.

setServer

public void setServer(java.lang.String name)
Set the name of the server which is associated with this logger.

The WebSphere runtime does not utilize this field. For performance and memory footprint reasons it is recommended that users do not use this field.

Specified by:
setServer in interface RASIMessageLogger
Overrides:
setServer in class RASLogger
Parameters:
name - The server name. If the name is null, the current name is not changed.

getClient

public java.lang.String getClient()
Get the name of the client which is associated with this logger.

The WebSphere runtime does not utilize this field. For performance and memory footprint reasons it is recommended that users do not use this field.

Specified by:
getClient in interface RASIMessageLogger
Overrides:
getClient in class RASLogger
Returns:
The client name, or an empty string ("") if the client has not been set.

setClient

public void setClient(java.lang.String name)
Set the name of the client which is associated with this logger.

The WebSphere runtime does not utilize this field. For performance and memory footprint reasons it is recommended that users do not use this field.

Specified by:
setClient in interface RASIMessageLogger
Overrides:
setClient in class RASLogger
Parameters:
name - The client name. If the name is null, the current name is not changed.

getMessageFile

public java.lang.String getMessageFile()
Get the message file associated with this logger.

Specified by:
getMessageFile in interface RASIMessageLogger
Overrides:
getMessageFile in class RASMessageLogger
Returns:
The message file name, or null if a message file has not been set.

setMessageFile

public void setMessageFile(java.lang.String file)
Set the message file associated with this logger.

Specified by:
setMessageFile in interface RASIMessageLogger
Overrides:
setMessageFile in class RASMessageLogger
Parameters:
file - The message file name. If the name is null, the current name is not changed.

addSuppressedKey

public void addSuppressedKey(java.lang.String key)
Add a single message key to a set of keys which should not be logged.

WebSphere does not currently support the suppression of message keys. This method is a no-op.

Specified by:
addSuppressedKey in interface RASIMessageLogger
Overrides:
addSuppressedKey in class RASMessageLogger
Parameters:
key - The message key which is not to be logged.

removeSuppressedKey

public void removeSuppressedKey(java.lang.String key)
Remove a single message key from the set of keys which should not be logged.

WebSphere does not currently support the suppression of message keys. This method is a no-op.

Specified by:
removeSuppressedKey in interface RASIMessageLogger
Overrides:
removeSuppressedKey in class RASMessageLogger
Parameters:
key - The message key to be removed.

getSuppressedKeys

public java.util.Vector getSuppressedKeys()
Get all of the suppressed message keys associated with this logger.

WebSphere does not currently support the suppression of message keys. This method is a no-op and null is always returned.

Specified by:
getSuppressedKeys in interface RASIMessageLogger
Overrides:
getSuppressedKeys in class RASMessageLogger
Returns:
null.

message

public void message(long type,
                    java.lang.Object obj,
                    java.lang.String methodName,
                    java.lang.String key)
Log a message, by key, with no parameters. This call can be used in a non-static method and assumes that at a message file is registered with the logger.

Specified by:
message in interface RASIMessageLogger
Overrides:
message in class RASMessageLogger
Parameters:
type - The type of the message.
obj - The logging object ("this").
methodName - The name of the logging method.
key - The message key.

message

public void message(long type,
                    java.lang.Object obj,
                    java.lang.String methodName,
                    java.lang.String key,
                    java.lang.Object parm1)
Log a message, by key, with one parameter. This call can be used in a non-static method and assumes that a message file is registered with the logger.

Specified by:
message in interface RASIMessageLogger
Overrides:
message in class RASMessageLogger
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

public void message(long type,
                    java.lang.Object obj,
                    java.lang.String methodName,
                    java.lang.String key,
                    java.lang.Object parm1,
                    java.lang.Object parm2)
Log a message, by key, with two parameters. This call can be used in a non-static method and assumes that a message file is registered with the logger.

Specified by:
message in interface RASIMessageLogger
Overrides:
message in class RASMessageLogger
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

public void message(long type,
                    java.lang.Object obj,
                    java.lang.String methodName,
                    java.lang.String key,
                    java.lang.Object[] parms)
Log a message, by key, with an array of parameters. This call can be used in a non-static method and assumes that a message file is registered with the logger.

Specified by:
message in interface RASIMessageLogger
Overrides:
message in class RASMessageLogger
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

public void message(long type,
                    java.lang.String className,
                    java.lang.String methodName,
                    java.lang.String key)
Log a message, by key, with no parameters. This call can be used in any method and assumes that a message file is registered with the logger.

Specified by:
message in interface RASIMessageLogger
Overrides:
message in class RASMessageLogger
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

public void message(long type,
                    java.lang.String className,
                    java.lang.String methodName,
                    java.lang.String key,
                    java.lang.Object parm1)
Log a message, by key, with one parameter. This call can be used in any method and assumes that a message file is registered with the logger.

Specified by:
message in interface RASIMessageLogger
Overrides:
message in class RASMessageLogger
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

public void message(long type,
                    java.lang.String className,
                    java.lang.String methodName,
                    java.lang.String key,
                    java.lang.Object parm1,
                    java.lang.Object parm2)
Log a message, by key, with two parameters. This call can be used in any method and assumes that a message file is registered with the logger.

Specified by:
message in interface RASIMessageLogger
Overrides:
message in class RASMessageLogger
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

public void message(long type,
                    java.lang.String className,
                    java.lang.String methodName,
                    java.lang.String key,
                    java.lang.Object[] parms)
Log a message, by key, with an array of parameters. This call can be used in any method and assumes that a message file is registered with the logger.

Specified by:
message in interface RASIMessageLogger
Overrides:
message in class RASMessageLogger
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

public void msg(long type,
                java.lang.Object obj,
                java.lang.String methodName,
                java.lang.String key,
                java.lang.String file)
Log a message, by key and file, with no parameters. This call can be used in a non-static method.

Specified by:
msg in interface RASIMessageLogger
Overrides:
msg in class RASMessageLogger
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

public void msg(long type,
                java.lang.Object obj,
                java.lang.String methodName,
                java.lang.String key,
                java.lang.String file,
                java.lang.Object parm1)
Log a message, by key and file with one parameter. This call can be used in a non-static method.

Specified by:
msg in interface RASIMessageLogger
Overrides:
msg in class RASMessageLogger
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

public 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)
Log a message, by key and file, with two parameters. This call can be used in a non-static method.

Specified by:
msg in interface RASIMessageLogger
Overrides:
msg in class RASMessageLogger
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

public void msg(long type,
                java.lang.Object obj,
                java.lang.String methodName,
                java.lang.String key,
                java.lang.String file,
                java.lang.Object[] parms)
Log a message, by key and file, with an array of parameters. This call can be used in a non-static method.

Specified by:
msg in interface RASIMessageLogger
Overrides:
msg in class RASMessageLogger
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

public void msg(long type,
                java.lang.String className,
                java.lang.String methodName,
                java.lang.String key,
                java.lang.String file)
Log a message, by key and file, with no parameters. This call can be used in any method.

Specified by:
msg in interface RASIMessageLogger
Overrides:
msg in class RASMessageLogger
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

public void msg(long type,
                java.lang.String className,
                java.lang.String methodName,
                java.lang.String key,
                java.lang.String file,
                java.lang.Object parm1)
Log a message, by key and file, with one parameter. This call can be used in any method.

Specified by:
msg in interface RASIMessageLogger
Overrides:
msg in class RASMessageLogger
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

public 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)
Log a message, by key and file, with two parameters. This call can be used in any method.

Specified by:
msg in interface RASIMessageLogger
Overrides:
msg in class RASMessageLogger
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

public void msg(long type,
                java.lang.String className,
                java.lang.String methodName,
                java.lang.String key,
                java.lang.String file,
                java.lang.Object[] parms)
Log a message, by key and file, with an array of parameters. This call can be used in any method.

Specified by:
msg in interface RASIMessageLogger
Overrides:
msg in class RASMessageLogger
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

public void textMessage(long type,
                        java.lang.Object obj,
                        java.lang.String methodName,
                        java.lang.String text)
Log a text message (no key) with no parameters. This call can be used in a non-static method.

Specified by:
textMessage in interface RASIMessageLogger
Overrides:
textMessage in class RASMessageLogger
Parameters:
type - The type of the message.
obj - The logging object ("this").
methodName - The name of the logging method.
text - The message text.

textMessage

public void textMessage(long type,
                        java.lang.Object obj,
                        java.lang.String methodName,
                        java.lang.String text,
                        java.lang.Object parm1)
Log a text message (no key) with one parameter. This call can be used in a non-static method.

Specified by:
textMessage in interface RASIMessageLogger
Overrides:
textMessage in class RASMessageLogger
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

public void textMessage(long type,
                        java.lang.Object obj,
                        java.lang.String methodName,
                        java.lang.String text,
                        java.lang.Object parm1,
                        java.lang.Object parm2)
Log a text message (no key) with two parameters. This call can be used in a non-static method.

Specified by:
textMessage in interface RASIMessageLogger
Overrides:
textMessage in class RASMessageLogger
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

public void textMessage(long type,
                        java.lang.Object obj,
                        java.lang.String methodName,
                        java.lang.String text,
                        java.lang.Object[] parms)
Log a text message (no key) with an array of parameters. This call can be used in a non-static method.

Specified by:
textMessage in interface RASIMessageLogger
Overrides:
textMessage in class RASMessageLogger
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

public void textMessage(long type,
                        java.lang.String className,
                        java.lang.String methodName,
                        java.lang.String text)
Log a text message (no key) with no parameters. This call can be used in any method.

Specified by:
textMessage in interface RASIMessageLogger
Overrides:
textMessage in class RASMessageLogger
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

public void textMessage(long type,
                        java.lang.String className,
                        java.lang.String methodName,
                        java.lang.String text,
                        java.lang.Object parm1)
Log a text message (no key) with one parameter. This call can be used in any method.
Specified by:
textMessage in interface RASIMessageLogger
Overrides:
textMessage in class RASMessageLogger
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

public void textMessage(long type,
                        java.lang.String className,
                        java.lang.String methodName,
                        java.lang.String text,
                        java.lang.Object parm1,
                        java.lang.Object parm2)
Log a text message (no key) with two parameters. This call can be used in any method.

Specified by:
textMessage in interface RASIMessageLogger
Overrides:
textMessage in class RASMessageLogger
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

public void textMessage(long type,
                        java.lang.String className,
                        java.lang.String methodName,
                        java.lang.String text,
                        java.lang.Object[] parms)
Log a text message (no key) with an array of parameters. This call can be used in any method.

Specified by:
textMessage in interface RASIMessageLogger
Overrides:
textMessage in class RASMessageLogger
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

public void exception(long type,
                      java.lang.Object obj,
                      java.lang.String methodName,
                      java.lang.Exception exc)
Log an Exception in a non-static method.

Overrides:
exception in class RASMessageLogger
Parameters:
type - The type of the trace point.
obj - The traced object ("this").
methodName - The name of the traced method.
exc - An exception.

exception

public void exception(long type,
                      java.lang.String className,
                      java.lang.String methodName,
                      java.lang.Exception exc)
Log an Exception in a static method.

Overrides:
exception in class RASMessageLogger
Parameters:
type - The type of the trace point.
className - The name of the traced class.
methodName - The name of the traced method.
exc - An exception.