WsJrasMessageLogger (IBM WebSphere Application Server [ras])

com.ibm.websphere.ras
Class WsJrasMessageLogger
java.lang.Object
  |
  +--com.ibm.ras.RASObject
        |
        +--com.ibm.ras.RASMaskChangeGenerator
              |
              +--com.ibm.ras.RASLogger
                    |
                    +--com.ibm.ras.RASMessageLogger
                          |
                          +--com.ibm.websphere.ras.WsJrasMessageLogger
All Implemented Interfaces:
java.lang.Cloneable, java.util.EventListener, com.ibm.CORBA.iiop.OrbMsgLogger, RASConstants, RASILogger, RASIMaskChangeGenerator, RASIMaskChangeListener, RASIMessageEvent, RASIMessageLogger, RASIObject, java.io.Serializable

public class WsJrasMessageLogger
extends RASMessageLogger
implements com.ibm.CORBA.iiop.OrbMsgLogger

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 can be used to publish a message to both the WebSphere run time as well as user-defined message consumers. Messages published to the WebSphere run time are viewed and managed using the normal WebSphere message viewing and management facilities. 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, methods that take the "this" (the object performing the logging) as the second parameter can be used. 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. The methods which take "String className" as the second parameter should be used in this case. 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.
A base set of message types is defined in the RASIMessageEvent class. Users may define their own types by extending this class, but messages of user defined types are ignored by the WebSphere run time. In addition, the base types may be mapped to native types depending on the WebSphere platform. Consult the user documentation for WebSphere edition you are running on for a description of any such mappings.
Normally, the text for a set of messages is stored in one or more message files, known as a ResourceBundle. Usage of the Property resource bundle pattern is recommended.
WsJrasMessageLogger provides support for the logging of plain text messages which do not use message catalogs via the textMessage methods. This allows the passing of messages that are already localized. In addition, they can be used as a convenience by the 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:

The name of the organization which owns the application that creates these messages.
The name of the product that creates these messages.
The name of the component within the product that creates these messages.
A server associated with the creation of the messages.
The client on whose behalf the messages are created.
If not specified, each of these fields defaults to an empty string.

See Also:
RASIMessageLogger, RASMessageLogger, RASIMessageEvent, RASMessageEvent, RASIHandler, Serialized Form

Field Summary

Fields inherited from class com.ibm.ras.RASLogger

handlerFailures, isLoggableMask, isLogging

Fields inherited from interface com.ibm.ras.RASIMessageEvent

ALL_MESSAGE_MASK, DEFAULT_MESSAGE_MASK, TYPE_ERR, TYPE_ERROR, TYPE_INFO, TYPE_INFORMATION, TYPE_WARN, TYPE_WARNING

Fields inherited from interface com.ibm.ras.RASConstants

KEY_CLASS_NAME, KEY_CLIENT, KEY_COMPONENT, KEY_DATE_FORMAT, KEY_DEFAULT_HANDLERS, KEY_DEFAULT_MESSAGE_HANDLERS, KEY_DEFAULT_TRACE_HANDLERS, KEY_DESCRIPTION, KEY_ENCODING, KEY_EXCEPTION, KEY_EXCEPTION_TRACE, KEY_FILE_NAME, KEY_FORMATTER_NAMES, KEY_GROUP, KEY_HANDLER_NAMES, KEY_HEX_DATA, KEY_IS_CIRCULAR, KEY_IS_LOGGING, KEY_IS_SYNC, KEY_LOGGER, KEY_LOGGING_CLASS, KEY_LOGGING_METHOD, KEY_MAX_FILE_SIZE, KEY_MAX_FILES, KEY_MAX_QUEUE_SIZE, KEY_MESSAGE_EVENT_CLASSES, KEY_MESSAGE_FILE, KEY_MESSAGE_MASK, KEY_NAME, KEY_ORGANIZATION, KEY_PRODUCT, KEY_RETRY_INTERVAL, KEY_SEPARATOR, KEY_SERVER, KEY_SOCKET_PORT, KEY_SOCKET_SERVER, KEY_SUPPRESSED_KEYS, KEY_THREAD_ID, KEY_TIME_FORMAT, KEY_TRACE_EVENT_CLASSES, KEY_TRACE_MASK, RAS_VERSION

Method Summary

void addHandler(RASIHandler handler)
          Add a RASIHandler object to the list of Handlers to which this MessageLogger will forward events.

void addTraceEventClass(java.lang.String name)
          Add the specified name of a trace event class to the list of trace event classes which this object uses.

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

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

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

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

java.lang.String getGroup()
          Return the name of the RASManager group with which this object is associated.

long getTraceMask()
          Return the current value of the trace mask for this MessageLogger.

protected void init()
          Initialize this object, setting default values.

boolean isSynchronous()
          Return a boolean indicating whether or not 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 object from the list of Handlers to which this MessageLogger will forward events.

void removeTraceEventClass(java.lang.String name)
          Remove the specified name of a trace event class from the list of trace event classes which this object uses.

void setLogging(boolean flag)
          Set the isLogging boolean to the indicated state.

void setLoggingOutput(java.lang.String file)
          Set the name of the file to which log entries will be written

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

void setSynchronous(boolean flag)
          Set a flag that tells the logger whether to log data synchronously.

void setTraceMask(long mask)
          Set the value of the trace mask for this logger.

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

addSuppressedKey, getComponent, getConfig, getMessageFile, getOrganization, getProduct, getSuppressedKeys, logMsg, maskValueChanged, removeSuppressedKey, setComponent, setConfig, setMessageFile, setOrganization, setProduct

Methods inherited from class com.ibm.ras.RASLogger

fireRASEvent, getClient, getHandlers, getServer, isLoggable, isLogging, setClient, setServer

Methods inherited from class com.ibm.ras.RASMaskChangeGenerator

addMaskChangeListener, addMessageEventClass, fireMaskChangedEvent, getMaskChangeListeners, getMessageEventClasses, getMessageMask, getTraceEventClasses, messageMaskLongValue, messageMaskToString, removeMaskChangeListener, removeMessageEventClass, setMessageMask, traceMaskLongValue, traceMaskToString

Methods inherited from class com.ibm.ras.RASObject

clone, getDescription, getName, setDescription

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ibm.CORBA.iiop.OrbMsgLogger

getMessageFile, isLoggable, setMessageFile

Methods inherited from interface com.ibm.ras.RASIMessageLogger

getMessageMask, setMessageMask

Methods inherited from interface com.ibm.ras.RASILogger

fireRASEvent, getClient, getHandlers, getServer, isLoggable, isLogging, setClient, setServer

Methods inherited from interface com.ibm.ras.RASIMaskChangeGenerator

addMaskChangeListener, addMessageEventClass, fireMaskChangedEvent, getMaskChangeListeners, getMessageEventClasses, getTraceEventClasses, removeMaskChangeListener, removeMessageEventClass

Methods inherited from interface com.ibm.ras.RASIObject

getDescription, getName, setDescription

Method Detail

init
protected void init()
Initialize this object, setting default values.

Overrides:
init in class RASMessageLogger

setLoggingOutput
public void setLoggingOutput(java.lang.String file)
Set the name of the file to which log entries will be written
WebSphere will redirect Orb message entries to internal logs. This method is a no operation.

Specified by:
setLoggingOutput in interface com.ibm.CORBA.iiop.OrbMsgLogger

Parameters:
file - the name of a file. Ignored.

setName
public void setName(java.lang.String name)
Set the name by which this MessageLogger is known.
The name of the WebSphere logger is set at construction time and must not be modified by the user. Calling this method results in no operation.

Specified by:
setName in interface RASIObject
Overrides:
setName in class RASObject

Parameters:
name - The name of this object. Input is ignored.

getGroup
public java.lang.String getGroup()
Return the name of the RASManager group with which this object is associated.
NOTE: This method may only be called by the RAS Manager.

Specified by:
getGroup in interface RASIObject
Overrides:
getGroup in class RASObject

Returns:
null is always returned.

getTraceMask
public long getTraceMask()
Return the current value of the trace mask for this MessageLogger.
The trace mask defines the set of trace types that will be processed. By definition, message loggers do not process trace types, this value will always be zero.

Specified by:
getTraceMask in interface RASIMaskChangeGenerator
Overrides:
getTraceMask in class RASMaskChangeGenerator

Returns:
Zero.

setTraceMask
public void setTraceMask(long mask)
Set the value of the trace mask for this logger.
The trace mask defines the set of trace types that will be processed. By definition, message loggers do not process trace types, this is always a no-operation.

Specified by:
setTraceMask in interface RASIMaskChangeGenerator
Overrides:
setTraceMask in class RASMaskChangeGenerator

Parameters:
mask - The trace mask. Input is ignored

addTraceEventClass
public void addTraceEventClass(java.lang.String name)
Add the specified name of a trace event class to the list of trace event classes which this object uses.
By definition, MessageLoggers do not use trace event classes. This method is a no operation.

Specified by:
addTraceEventClass in interface RASIMaskChangeGenerator
Overrides:
addTraceEventClass in class RASMaskChangeGenerator

Parameters:
name - The event class name. Input is ignored.

removeTraceEventClass
public void removeTraceEventClass(java.lang.String name)
Remove the specified name of a trace event class from the list of trace event classes which this object uses.
By definition, MessageLoggers do not use trace event classes. This method is a no operation.

Specified by:
removeTraceEventClass in interface RASIMaskChangeGenerator
Overrides:
removeTraceEventClass in class RASMaskChangeGenerator

Parameters:
name - The event class name. Input is ignored.

setLogging
public void setLogging(boolean flag)
Set the isLogging boolean to the indicated state.

Specified by:
setLogging in interface com.ibm.CORBA.iiop.OrbMsgLogger
Overrides:
setLogging in class RASLogger

Parameters:
flag - a boolean, true to indicate logging is enabled.

addHandler
public void addHandler(RASIHandler handler)
Add a RASIHandler object to the list of Handlers to which this MessageLogger will forward events.
More than one handler may be associated with a logger to direct the message events to multiple destinations.

Specified by:
addHandler in interface RASILogger
Overrides:
addHandler in class RASLogger

Parameters:
handler - A RAS handler. If the handler is null or is already registered, this method does nothing.

removeHandler
public void removeHandler(RASIHandler handler)
Remove a RASIHandler object from the list of Handlers to which this MessageLogger will forward events.
This method is only enabled on the IT-QOS package.

Specified by:
removeHandler in interface RASILogger
Overrides:
removeHandler in class RASLogger

Parameters:
handler - A RAS handler. If the handler is null or is not registered, this method does nothing.

isSynchronous
public boolean isSynchronous()
Return a boolean indicating whether or not synchronous logging is in effect.

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

Returns:
true if synchronous logging is in effect. otherwise false. Since logging is required to be synchronous in a WebSphere environment, true is always returned.

setSynchronous
public void setSynchronous(boolean flag)
Set 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.
By definition, logging in a WebSphere environment is required to be synchronous. Calling this method results in no-operations.

Specified by:
setSynchronous in interface RASILogger
Overrides:
setSynchronous in class RASLogger

Parameters:
flag - a boolean. Input is ignored.

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 com.ibm.CORBA.iiop.OrbMsgLogger
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 com.ibm.CORBA.iiop.OrbMsgLogger
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 com.ibm.CORBA.iiop.OrbMsgLogger
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 com.ibm.CORBA.iiop.OrbMsgLogger
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 com.ibm.CORBA.iiop.OrbMsgLogger
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 com.ibm.CORBA.iiop.OrbMsgLogger
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 com.ibm.CORBA.iiop.OrbMsgLogger
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 com.ibm.CORBA.iiop.OrbMsgLogger
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 com.ibm.CORBA.iiop.OrbMsgLogger
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 com.ibm.CORBA.iiop.OrbMsgLogger
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 com.ibm.CORBA.iiop.OrbMsgLogger
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 com.ibm.CORBA.iiop.OrbMsgLogger
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 com.ibm.CORBA.iiop.OrbMsgLogger
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 com.ibm.CORBA.iiop.OrbMsgLogger
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 com.ibm.CORBA.iiop.OrbMsgLogger
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 com.ibm.CORBA.iiop.OrbMsgLogger
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 com.ibm.CORBA.iiop.OrbMsgLogger
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 com.ibm.CORBA.iiop.OrbMsgLogger
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 com.ibm.CORBA.iiop.OrbMsgLogger
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 com.ibm.CORBA.iiop.OrbMsgLogger
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 com.ibm.CORBA.iiop.OrbMsgLogger
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 com.ibm.CORBA.iiop.OrbMsgLogger
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 com.ibm.CORBA.iiop.OrbMsgLogger
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 com.ibm.CORBA.iiop.OrbMsgLogger
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 exception)
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.
exception - an Exception.

exception
public void exception(long type,
                      java.lang.String className,
                      java.lang.String methodName,
                      java.lang.Exception exception)
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.
exception - an Exception.

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

Specified by:
exception in interface RASIMessageLogger
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.
throwable - a Throwable.

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

Specified by:
exception in interface RASIMessageLogger
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.
throwable - a Throwable.

WebSphere is a trademark of the IBM Corporation in the United States, other countries, or both.

IBM is a trademark of the IBM Corporation in the United States, other countries, or both.

Method Summary
void	addHandler(RASIHandler handler) Add a RASIHandler object to the list of Handlers to which this MessageLogger will forward events.
void	addTraceEventClass(java.lang.String name) Add the specified name of a trace event class to the list of trace event classes which this object uses.
void	exception(long type, java.lang.Object obj, java.lang.String methodName, java.lang.Exception exception) Log an Exception in a non-static method.
void	exception(long type, java.lang.Object obj, java.lang.String methodName, java.lang.Throwable throwable) Log an Exception in a non-static method.
void	exception(long type, java.lang.String className, java.lang.String methodName, java.lang.Exception exception) Log an Exception in a static method.
void	exception(long type, java.lang.String className, java.lang.String methodName, java.lang.Throwable throwable) Log an Exception in a static method.
java.lang.String	getGroup() Return the name of the RASManager group with which this object is associated.
long	getTraceMask() Return the current value of the trace mask for this MessageLogger.
protected void	init() Initialize this object, setting default values.
boolean	isSynchronous() Return a boolean indicating whether or not 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 object from the list of Handlers to which this MessageLogger will forward events.
void	removeTraceEventClass(java.lang.String name) Remove the specified name of a trace event class from the list of trace event classes which this object uses.
void	setLogging(boolean flag) Set the isLogging boolean to the indicated state.
void	setLoggingOutput(java.lang.String file) Set the name of the file to which log entries will be written
void	setName(java.lang.String name) Set the name by which this MessageLogger is known.
void	setSynchronous(boolean flag) Set a flag that tells the logger whether to log data synchronously.
void	setTraceMask(long mask) Set the value of the trace mask for this logger.
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.

com.ibm.websphere.ras Class WsJrasMessageLogger

init

setLoggingOutput

setName

getGroup

getTraceMask

setTraceMask

addTraceEventClass

removeTraceEventClass

setLogging

addHandler

removeHandler

isSynchronous

setSynchronous

message

message

message

message

message

message

message

message

msg

msg

msg

msg

msg

msg

msg

msg

textMessage

textMessage

textMessage

textMessage

textMessage

textMessage

textMessage

textMessage

exception

exception

exception

exception

com.ibm.websphere.ras
Class WsJrasMessageLogger