|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
RASIMessageLogger
defines a set of methods that must be
implemented to create RAS messages.
RASILogger
,
RASMessageLogger
Method Summary | |
void |
addSuppressedKey(java.lang.String key)
Adds a message key to a set of keys which should not be logged. |
java.lang.String |
getClient()
Gets the name of the client which is associated with this logger. |
java.lang.String |
getComponent()
Gets the name of the component that is using this logger. |
java.util.Hashtable |
getConfig()
Gets the configuration of this object. |
java.lang.String |
getMessageFile()
Gets the message file associated with this logger. |
long |
getMessageMask()
Gets the mask which defines the set of message types that will be processed. |
java.lang.String |
getOrganization()
Gets the name of the organization which wrote the application that is using this logger. |
java.lang.String |
getProduct()
Gets the name of the product that is using this logger. |
java.lang.String |
getServer()
Gets the name of the server which is associated with this logger. |
java.util.Vector |
getSuppressedKeys()
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)
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)
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)
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)
Logs a message, by key, with two parameters. |
void |
message(long type,
java.lang.String className,
java.lang.String methodName,
java.lang.String key)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
Logs a message, by key and file, with two parameters. |
void |
removeSuppressedKey(java.lang.String key)
Removes a message key from the set of keys which should not be logged. |
void |
setClient(java.lang.String name)
Sets the name of the client which is associated with this logger. |
void |
setComponent(java.lang.String name)
Sets the name of the component that is using this logger. |
void |
setConfig(java.util.Hashtable ht)
Sets the configuration of this object. |
void |
setMessageFile(java.lang.String file)
Sets the message file associated with this logger. |
void |
setMessageMask(long mask)
Sets the mask which defines the set of message types that will be processed. |
void |
setOrganization(java.lang.String name)
Sets the name of the organization which wrote the application that is using this logger. |
void |
setProduct(java.lang.String name)
Sets the name of the product that is using this logger. |
void |
setServer(java.lang.String name)
Sets the name of the server which is associated with this logger. |
void |
textMessage(long type,
java.lang.Object obj,
java.lang.String methodName,
java.lang.String text)
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)
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)
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)
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)
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)
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)
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)
Logs a text message (no key) with two parameters. |
Methods inherited from interface com.ibm.ras.RASILogger |
addHandler,
getHandlers,
isLoggable,
isSynchronous,
removeHandler,
setSynchronous |
Methods inherited from interface com.ibm.ras.RASIObject |
getDescription,
getName,
setDescription,
setName |
Method Detail |
public java.util.Hashtable getConfig()
Hashtable
containing the configuration.
This object inserts the following key/value pairs into the
configuration:
"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
.
The parent and extensions of this object may add additional keys.public void setConfig(java.util.Hashtable ht)
RASManager
to initialize a RAS object. It should not
be necessary for an application to use this method.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.public long getMessageMask()
RASIMessageEvent.TYPE_XXXX
constants.public void setMessageMask(long mask)
RASIMessageEvent.TYPE_XXXX
constants.
The mask value is not validated against these types.mask
- The message mask.public java.lang.String getOrganization()
public void setOrganization(java.lang.String name)
null
, the current
name is not changed.name
- The organization name.public java.lang.String getProduct()
public void setProduct(java.lang.String name)
null
, the current name is not changed.name
- The product name.public java.lang.String getComponent()
public void setComponent(java.lang.String name)
null
, the current name is not changed.name
- The component name.public java.lang.String getServer()
public void setServer(java.lang.String name)
null
, the current name is not changed.name
- The server name.public java.lang.String getClient()
public void setClient(java.lang.String name)
null
, the current name is not changed.name
- The client name.public java.lang.String getMessageFile()
null
if a message file
has not been added to the logger.public void setMessageFile(java.lang.String file)
null
, the current message file is not changed.
If the message file does not exist, a message indicating this will
be displayed in place of the formatted message.file
- The message file name.public void addSuppressedKey(java.lang.String key)
null
or is already registered, this method does nothing.key
- The message key which is not to be logged.public void removeSuppressedKey(java.lang.String key)
null
or is not registered, this method
does nothing.key
- The message key to be removed.public java.util.Vector getSuppressedKeys()
Vector
of message keys. If no suppressed keys
are registered, the Vector
is empty.public void message(long type, java.lang.Object obj, java.lang.String methodName, java.lang.String key)
type
- The type of the message.obj
- The logging object ("this").methodName
- The name of the logging method.key
- The message key.public void message(long type, java.lang.Object obj, java.lang.String methodName, java.lang.String key, java.lang.Object parm1)
type
- The type of the message.obj
- The logging object ("this").methodName
- The name of the logging method.key
- The message key.parm1
- An element to be inserted into the message.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)
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.public void message(long type, java.lang.Object obj, java.lang.String methodName, java.lang.String key, java.lang.Object[] parms)
type
- The type of the message.obj
- The logging object ("this").methodName
- The name of the logging method.key
- The message key.parms
- An array of elements to be inserted into the message.public void message(long type, java.lang.String className, java.lang.String methodName, java.lang.String key)
type
- The type of the message.className
- The name of the logging class.methodName
- The name of the logging method.key
- The message key.public void message(long type, java.lang.String className, java.lang.String methodName, java.lang.String key, java.lang.Object parm1)
type
- The type of the message.className
- The name of the logging class.methodName
- The name of the logging method.key
- The message key.parm1
- An element to be inserted into the message.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)
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.public void message(long type, java.lang.String className, java.lang.String methodName, java.lang.String key, java.lang.Object[] parms)
type
- The type of the message.className
- The name of the logging class.methodName
- The name of the logging method.key
- The message key.parms
- An array of elements to be inserted into the message.public void msg(long type, java.lang.Object obj, java.lang.String methodName, java.lang.String key, java.lang.String file)
type
- The type of the message.obj
- The logging object ("this").methodName
- The name of the logging method.key
- The message key.file
- The name of the message file to use.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)
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.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)
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.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)
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.public void msg(long type, java.lang.String className, java.lang.String methodName, java.lang.String key, java.lang.String file)
type
- The type of the message.className
- The name of the logging class.methodName
- The name of the logging method.key
- The message key.file
- The name of the message file to use.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)
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.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)
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.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)
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.public void textMessage(long type, java.lang.Object obj, java.lang.String methodName, java.lang.String text)
type
- The type of the message.obj
- The logging object ("this").methodName
- The name of the logging method.text
- The message text.public void textMessage(long type, java.lang.Object obj, java.lang.String methodName, java.lang.String text, java.lang.Object parm1)
type
- The type of the message.obj
- The logging object ("this").methodName
- The name of the logging method.text
- The message text.parm1
- An element to be displayed with the message.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)
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.public void textMessage(long type, java.lang.Object obj, java.lang.String methodName, java.lang.String text, java.lang.Object[] parms)
type
- The type of the message.obj
- The logging object ("this").methodName
- The name of the logging method.text
- The message text.parms
- An array of elements to be displayed with the message.public void textMessage(long type, java.lang.String className, java.lang.String methodName, java.lang.String text)
type
- The type of the message.className
- The name of the logging class.methodName
- The name of the logging method.text
- The message text.public void textMessage(long type, java.lang.String className, java.lang.String methodName, java.lang.String text, java.lang.Object parm1)
type
- The type of the message.className
- The name of the logging class.methodName
- The name of the logging method.text
- The message text.parm1
- An element to be displayed with the message.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)
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.public void textMessage(long type, java.lang.String className, java.lang.String methodName, java.lang.String text, java.lang.Object[] parms)
type
- The type of the message.className
- The name of the logging class.methodName
- The name of the logging method.text
- The message text.parms
- An array of elements to be displayed with the message.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |