|
IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.btt.base.Trace
public class Trace
This class provide the traditional static API for trace users. These APIs are deprecated in BTT6.1.New API of BTTLog class are recommended.
Field Summary | |
---|---|
static int |
All
Deprecated. Use AllTypes instead of All |
static int |
AllLevels
The constants that represents all levels. |
static int |
AllTypes
The constants that represents all types. |
protected static TraceBuffer |
buffer
The buffer where the trace lines are stored. |
static int |
Debug
The Debug type. |
protected static java.lang.String |
Default_CP
The code page for trace file. |
protected static boolean |
directToCommonLogging
|
protected static boolean |
directToWAS
|
static int |
Display
The Display type. |
static boolean |
enableTraces
The flag to indicate if the trace to display facility is activated. |
static int |
Error
The Error type. |
static java.util.ResourceBundle |
exceptionBundle
Define exception resource bundle. |
protected static int |
globalLevel
|
static int |
High
The High level. |
static int |
Information
The Information type. |
static int |
Low
The Low level. |
static int |
Medium
The Medium level. |
static int |
Severe
The Severe type. |
static boolean |
showStack
The flag to indicate if the show originator option is activated. |
static boolean |
showThreadName
|
protected static java.lang.String |
tID
|
static java.util.ResourceBundle |
traceBundle
define trace resource bundle. |
protected static java.lang.String |
traceMethodPath
The complete name of trace method. |
protected static TracesWindow |
tracesWindow
The tracesWindow instance. |
protected static boolean |
traceToCommLogging
|
static boolean |
traceToFile
The flag to indicate if the trace to file facility is activated. |
static boolean |
traceToWAS
The flag is to indicate whether the trace to WAS facility is activated |
protected static boolean |
useLog
The flag to indicate if the web server log facilities are used instead of trace to display or disk facilities. |
static int |
VTF
Deprecated. See the traces API in the Product Documentation |
static int |
Warning
The Warning type. |
protected static short |
wasTraceCatalog
|
Constructor Summary | |
---|---|
Trace()
This constructor creates a Trace object. |
Method Summary | |
---|---|
static void |
closeDisplay()
Closes and disables the trace to display facility. |
protected static void |
createEnvironment()
Creates all the object structure necessary for traces system. |
static boolean |
doTrace(java.lang.String component,
int level,
int type)
Returns true if the specified level and the specified type are enabled for the specified component. |
static java.util.Iterator |
getComponents()
Returns the name of all the components that are registered in traces system. |
static java.util.HashMap<java.lang.String,TraceRequester> |
getComponentTraceSetting()
Get all components trace setting with TraceRequester hash map |
static TraceRequester |
getComponentTraceSetting(java.lang.String component)
Get the component trace setting by component name |
static boolean |
getEnableToDisplay()
Returns true if the trace to display facility is enabled. |
static boolean |
getEnableToFile()
Returns true if the trace to file facility is enabled. |
static boolean |
getEnableTrace(java.lang.String component)
Returns true if the trace facility is enabled for the specified component. |
static java.util.ResourceBundle |
getExceptionBundle()
Returns the exceptionBundle. |
static boolean |
getLockScrolling()
Returns true if the lock-scrolling attribute is enabled in the viewer tool's trace window. |
static boolean |
getOriginator()
Returns true if the showOriginator setting is enabled. |
static boolean |
getShowThread()
Returns true if the showOriginator setting is enabled. |
static boolean |
getShowWarning()
Returns true if the trace object will show a warning message in case of security exception. |
static java.lang.String |
getTID()
Get terminal ID (only for RCP client trace) |
static java.util.ResourceBundle |
getTraceBundle()
Returns the traceBundle. |
static int |
getTraceLevel()
Return the global trace level |
static boolean |
getTraceTarget(int target)
get if a Trace Target is enabled |
static void |
reset()
Resets and initializes trace facility with the original configuration. |
static void |
resetNextLine()
Sets the number of the next line to write to 1. |
void |
run()
Main Trace thread process. |
static void |
setClearList()
Clears the content of the viewer tool's trace window. |
static void |
setEnableToDisplay(boolean ena)
Enables or disables the trace to display facility according to the specified boolean value. |
static void |
setEnableToFile(boolean ena)
Enables or disables the trace to file facility according to the specified boolean value. |
static void |
setEnableTrace(java.lang.String component,
boolean newStatus)
Enables or disables the trace facility for the specified component according to the specified boolean value. |
static void |
setExceptionBundle(java.util.ResourceBundle exceptionBundle)
Sets the exceptionBundle. |
static void |
setLockScrolling(boolean state)
Enables or disables the lock-scrolling attribute in the trace window according to the specified boolean value. |
static void |
setOriginator(boolean state)
Enables or disables the originator information in the trace record according to the specified boolean value. |
static void |
setTID(java.lang.String tid)
Set terminal ID (only for RCP client trace) |
static void |
setTraceBundle(java.util.ResourceBundle traceBundle)
Sets the traceBundle. |
static void |
setTraceLevel(int level)
Deprecated. - See the traces API in the Product Documentation |
static void |
setTraceLevel(int level,
boolean state)
Enables or disables the specified level in the generic trace levels according to the specified boolean value. |
static void |
setTraceLevel(java.lang.String component,
boolean enable,
int level)
Enables or disables the specified level for the specified component according to the specified boolean value. |
static void |
setTraceTarget(int target,
boolean enabled)
enable/disable trace target |
static void |
setTraceType(int type,
boolean state)
Enables or disables the specified type in the generic trace types according to the specified boolean value. |
static void |
stop()
|
static void |
trace(boolean check,
java.lang.String component,
int level,
int type,
java.lang.String TID,
java.lang.Exception anException)
Builds a trace record with the contents of the specified component, level, type, terminal identifier and exception. |
static void |
trace(boolean check,
java.lang.String component,
int level,
int type,
java.lang.String TID,
java.lang.String message)
Builds a trace record with the contents of the specified component, level, type, terminal identifier and message. |
static void |
trace(int inf,
java.lang.String str)
Deprecated. - See the traces API in the Product Documentation |
static void |
trace(int inf,
java.lang.String TID,
java.lang.String str)
Deprecated. - See the traces API in the Product Documentation |
static void |
trace(java.lang.String component,
int level,
int type,
java.lang.String TID,
java.lang.Exception anException)
Builds a trace record with the contents of the specified component, level, type, terminal identifier, and exception. |
static void |
trace(java.lang.String component,
int level,
int inf,
java.lang.String TID,
java.lang.String str)
Builds a trace record with the contents of the specified component, level, type, terminal identifier, and message. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int Display
public static final int Information
public static final int Warning
public static final int Error
public static final int Severe
public static final int Debug
public static final int VTF
public static final int All
public static final int AllTypes
public static final int High
public static final int Medium
public static final int Low
public static final int AllLevels
protected static java.lang.String Default_CP
protected static boolean useLog
protected static TracesWindow tracesWindow
protected static TraceBuffer buffer
public static boolean traceToFile
public static boolean enableTraces
public static boolean showStack
public static boolean showThreadName
protected static java.lang.String traceMethodPath
public static boolean traceToWAS
protected static boolean traceToCommLogging
public static java.util.ResourceBundle traceBundle
public static java.util.ResourceBundle exceptionBundle
protected static int globalLevel
protected static java.lang.String tID
protected static short wasTraceCatalog
protected static boolean directToCommonLogging
protected static boolean directToWAS
Constructor Detail |
---|
public Trace()
Method Detail |
---|
public static void closeDisplay()
protected static void createEnvironment()
public static final boolean doTrace(java.lang.String component, int level, int type)
component
- java.lang.String - The name of the componentlevel
- int - The level of tracetype
- int - The type of trace
public static java.util.Iterator getComponents()
public static boolean getEnableToDisplay()
public static boolean getEnableToFile()
public static boolean getEnableTrace(java.lang.String component)
component
- java.lang.String - The name of the component
public static boolean getLockScrolling()
public static boolean getOriginator()
public static boolean getShowThread()
public static boolean getShowWarning()
public static final void reset()
public static final void resetNextLine()
public void run()
run
in interface java.lang.Runnable
public static void setClearList()
public static void setEnableToDisplay(boolean ena)
ena
- boolean - The new statuspublic static void setEnableToFile(boolean ena)
ena
- boolean - The new statuspublic static void setEnableTrace(java.lang.String component, boolean newStatus)
component
- java.lang.String - The name of the componentnewStatus
- boolean - The new status valuepublic static void setLockScrolling(boolean state)
state
- boolean - The new state for the lock scrolling optionpublic static void setOriginator(boolean state)
state
- boolean - The new state for the originator optionpublic static void setTraceLevel(int level, boolean state)
level
- int - The level of tracestate
- boolean - The new state for the generic level of tracepublic static void setTraceType(int type, boolean state)
type
- int - The type of tracestate
- boolean - The new state for the generic type of tracepublic static final void trace(int inf, java.lang.String str)
inf
- int - The typestr
- java.lang.String - The message of trace recordpublic static final void trace(int inf, java.lang.String TID, java.lang.String str)
public static final void trace(java.lang.String component, int level, int type, java.lang.String TID, java.lang.Exception anException)
component
- java.lang.String - The name of the componentlevel
- int - The level of tracetype
- int - The type of traceTID
- java.lang.String - The terminal identificationanException
- java.lang.Exception - The exception from where is extracted the contents of trace recordpublic static final void trace(java.lang.String component, int level, int inf, java.lang.String TID, java.lang.String str)
component
- java.lang.String - The name of the componentlevel
- int - The level of traceinf
- int - The type of traceTID
- java.lang.String - The terminal identificationstr
- java.lang.String - The message of trace record.public static final void trace(boolean check, java.lang.String component, int level, int type, java.lang.String TID, java.lang.Exception anException)
check
- booleancomponent
- java.lang.String - The name of the componentlevel
- int - The level of tracetype
- int - The type of traceTID
- java.lang.String - The terminal identificationpublic static final void trace(boolean check, java.lang.String component, int level, int type, java.lang.String TID, java.lang.String message)
check
- booleancomponent
- java.lang.String - The name of the componentlevel
- int - The level of tracetype
- int - The type of traceTID
- java.lang.String - The terminal identificationmessage
- java.lang.String - The message of trace recordpublic static java.util.ResourceBundle getExceptionBundle()
public static void setExceptionBundle(java.util.ResourceBundle exceptionBundle)
exceptionBundle
- The exceptionBundle to setpublic static java.util.ResourceBundle getTraceBundle()
public static void setTraceBundle(java.util.ResourceBundle traceBundle)
traceBundle
- The traceBundle to setpublic static void stop()
public static void setTID(java.lang.String tid)
tid
- public static java.lang.String getTID()
public static void setTraceLevel(int level)
level
- int the levelpublic static void setTraceLevel(java.lang.String component, boolean enable, int level)
component
- java.lang.String - The name of the componentenable
- java.lang.boolean - If the trace is eanbled for the componentlevel
- int - The level of tracepublic static java.util.HashMap<java.lang.String,TraceRequester> getComponentTraceSetting()
public static TraceRequester getComponentTraceSetting(java.lang.String component)
component
-
public static boolean getTraceTarget(int target)
target
- refer Trace trage constant defined in TraceConst class.
public static void setTraceTarget(int target, boolean enabled)
target
- refer Trace trage constant defined in TraceConst class.enabled
- public static int getTraceLevel()
|
IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |