|
IBM WebSphere Application ServerTM Release 8 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.uddi.promoter.PromoterLogger
public class PromoterLogger
Manages the output of messages and trace.
All messages output by UDDI Utility Tools are national language messages. These messages will be written to a messages log file if that has been specified and/or a PrintStream if one has been configured.
Messages written to the message log file are prefixed by a timestamp. Messages written to the messages PrintStream are not prefixed with a timestamp.
Trace output is in English only. Exception stack traces are written to the trace log file only. Trace logging would normally only be required in exceptional circumstances to aid IBM support diagnosis of problems.
Field Summary |
---|
Method Summary | |
---|---|
void |
cleanUp()
Closes the OutputStream s used for message and trace logs. |
protected void |
finalize()
In case the logger has not been cleaned up this should be called before it is garbage collected. |
int |
getCurrentLevel()
Returns current trace detail level. |
static PromoterLogger |
getLogger()
Returns the single instance of PromoterLogger. |
void |
initialise(LoggerConfiguration loggerConfig)
Uses LoggerConfiguration to initialise the logger. |
void |
logMessage(java.lang.String messageKey,
java.lang.String[] inserts,
int level)
Writes an informational message to the message log and message stream, if they exist. |
void |
logMessageToFileOnly(java.lang.String message)
Prints a message to the messages file stream only. |
void |
setCurrentLevel(int level)
Sets the detail level of trace. |
void |
setMessagesStream(java.io.PrintStream stream)
Sets the Stream to be used for writing messages to. |
void |
setVerbose(boolean verbose)
Sets detailed message output on. |
void |
trace(int traceLevel,
java.lang.Object className,
java.lang.String methodName,
java.lang.String message)
Traces a message from within a particular method. |
void |
trace(int traceLevel,
java.lang.String className,
java.lang.String methodName,
java.lang.String message)
Traces a message from within a particular method. |
void |
traceEntry(int traceLevel,
java.lang.Object className,
java.lang.String methodName)
Traces entry of a method. |
void |
traceEntry(int traceLevel,
java.lang.String className,
java.lang.String methodName)
Traces entry of a method. |
void |
traceException(int traceLevel,
java.lang.Throwable throwable)
Writes an exception to the trace log file. |
void |
traceExit(int traceLevel,
java.lang.Object className,
java.lang.String methodName)
Traces exit of a method. |
void |
traceExit(int traceLevel,
java.lang.String className,
java.lang.String methodName)
Traces exit of a method. |
Methods inherited from class java.lang.Object |
---|
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static PromoterLogger getLogger()
public void initialise(LoggerConfiguration loggerConfig) throws PromoterIOException
LoggerConfiguration
to initialise the logger.
The data is copied out of the configuration object so subsequent
changes to it's values will not affect the logger.
loggerConfig
-
PromoterIOException
public void setMessagesStream(java.io.PrintStream stream)
stream
- public void setVerbose(boolean verbose)
verbose
- true
if detailed message should appear in the messages stream.public void logMessage(java.lang.String messageKey, java.lang.String[] inserts, int level)
Messages are translated according to the user's locale.
messageKey
- Key into the messages resource.inserts
- level
- PromoterConstants.MESSAGE_NORMAL
or PromoterConstants.MESSAGE_DETAIL
public void logMessageToFileOnly(java.lang.String message)
message
- public void traceEntry(int traceLevel, java.lang.String className, java.lang.String methodName)
traceLevel
- PromoterConstants.TRACE_SEVERE
, PromoterConstants.TRACE_NORMAL
or PromoterConstants.TRACE_DETAIL
.className
- As a String, for class logging where 'this' isn't applicablemethodName
- public void traceEntry(int traceLevel, java.lang.Object className, java.lang.String methodName)
traceLevel
- PromoterConstants.TRACE_SEVERE
, PromoterConstants.TRACE_NORMAL
or PromoterConstants.TRACE_DETAIL
.className
- As an Object (typically as 'this
')methodName
- public void traceExit(int traceLevel, java.lang.String className, java.lang.String methodName)
traceLevel
- PromoterConstants.TRACE_SEVERE
, PromoterConstants.TRACE_NORMAL
or PromoterConstants.TRACE_DETAIL
.className
- As a String, for class logging where 'this' isn't applicablemethodName
- public void traceExit(int traceLevel, java.lang.Object className, java.lang.String methodName)
traceLevel
- PromoterConstants.TRACE_SEVERE
, PromoterConstants.TRACE_NORMAL
or PromoterConstants.TRACE_DETAIL
.className
- As an Object (typically as 'this
')methodName
- public void trace(int traceLevel, java.lang.String className, java.lang.String methodName, java.lang.String message)
traceLevel
- PromoterConstants.TRACE_SEVERE
, PromoterConstants.TRACE_NORMAL
or PromoterConstants.TRACE_DETAIL
.className
- As StringmethodName
- message
- public void trace(int traceLevel, java.lang.Object className, java.lang.String methodName, java.lang.String message)
traceLevel
- PromoterConstants.TRACE_SEVERE
, PromoterConstants.TRACE_NORMAL
or PromoterConstants.TRACE_DETAIL
.className
- As Object (typically as 'this
').methodName
- message
- public void traceException(int traceLevel, java.lang.Throwable throwable)
traceLevel
- PromoterConstants.TRACE_SEVERE
, PromoterConstants.TRACE_NORMAL
or PromoterConstants.TRACE_DETAIL
.throwable
- public void cleanUp() throws PromoterIOException
OutputStream
s used for message and trace logs.
PromoterIOException
protected void finalize() throws java.lang.Throwable
finalize
in class java.lang.Object
java.lang.Throwable
Object.finalize()
public void setCurrentLevel(int level)
level
- Can be 0 (no logging) to 3 (highest detail).public int getCurrentLevel()
|
IBM WebSphere Application ServerTM Release 8 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |