public class CICSTrace
extends java.lang.Object
CommonLogger
class so it can be used to trace the
Local ECI resource adapter messages.
Note: This is not built by CICS TS. Any changes to this class should be copied to CICS TG to include in their build as the TraceInterface class is package protected, so this trace class has to be included as part of the TG JAR.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COMPONENT
The component name to use for the resource adapter
|
static char |
LEVEL
The level to log at
|
Constructor and Description |
---|
CICSTrace() |
Modifier and Type | Method and Description |
---|---|
void |
applyTraceSettings()
Unsupported by CICS
|
void |
ex(java.lang.Object caller,
java.lang.Throwable exception)
Trace an exception
|
long |
flushTrace()
Unsupported by CICS
|
java.lang.String |
getDefaultTFile() |
java.lang.Object |
getPrsTrace()
Unsupported by CICS
|
java.lang.String |
getTFileName() |
void |
hexDump(java.lang.Object caller,
byte[] dumpArea,
java.lang.String comment,
int start,
int end,
boolean isEBCDIC)
Dump the contents of a data area in hexadecimal format.
|
void |
in(java.lang.Object caller,
java.lang.String method,
int parameterCount,
java.lang.Object objParm0,
java.lang.Object objParm1,
java.lang.Object objParm2,
java.lang.Object objParm3,
java.lang.Object objParm4,
java.lang.Object objParm5,
java.lang.Object objParm6,
java.lang.Object objParm7,
java.lang.Object objParm8,
java.lang.Object objParm9)
Trace the entry of a method
|
void |
ln(java.lang.Object caller,
java.lang.String format,
int parameterCount,
java.lang.Object param1,
java.lang.Object param2,
java.lang.Object param3,
java.lang.Object param4,
java.lang.Object param5,
java.lang.Object param6,
java.lang.Object param7,
java.lang.Object param8,
java.lang.Object param9,
java.lang.Object param10)
Log an entry with an insert string.
|
void |
out(java.lang.Object caller,
java.lang.String method)
Trace an exit from a method.
|
void |
out(java.lang.Object caller,
java.lang.String method,
boolean returnValue)
Trace an exit from a method with a boolean return.
|
void |
out(java.lang.Object caller,
java.lang.String method,
int returnValue)
Trace an exit from a method with an integer return.
|
void |
out(java.lang.Object caller,
java.lang.String method,
java.lang.Object returnValue)
Trace an exit from a method with an object return
|
void |
setDefaultTFile(java.lang.String defaultTFile)
Unsupported by CICS
|
void |
setOutput(java.io.PrintStream printStream)
Unsupported by CICS
|
boolean |
setTFile(boolean arg0,
java.lang.String arg1,
long arg2)
Unsupported by CICS
|
void |
setTFileOn(java.lang.String arg0)
Unsupported by CICS
|
void |
traceln(java.lang.String message)
Trace a line.
|
void |
writeInitialTraceInfo()
Write the initial trace information.
|
void |
writeLogToTrace(java.lang.String message)
Writes a message to the trace file.
|
public static final java.lang.String COMPONENT
public static final char LEVEL
public void applyTraceSettings()
public void ex(java.lang.Object caller, java.lang.Throwable exception)
caller
- The object which threw the exceptionexception
- The exceptionpublic long flushTrace()
public java.lang.String getDefaultTFile()
public java.lang.Object getPrsTrace()
public java.lang.String getTFileName()
public void hexDump(java.lang.Object caller, byte[] dumpArea, java.lang.String comment, int start, int end, boolean isEBCDIC)
caller
- The objectdumpArea
- The data area to dumpcomment
- The explanation of the data areastart
- The offset to start atend
- the offset to end atisEBCDIC
- true
if the data is in EBCDICpublic void traceln(java.lang.String message)
message
- The message to log.public void in(java.lang.Object caller, java.lang.String method, int parameterCount, java.lang.Object objParm0, java.lang.Object objParm1, java.lang.Object objParm2, java.lang.Object objParm3, java.lang.Object objParm4, java.lang.Object objParm5, java.lang.Object objParm6, java.lang.Object objParm7, java.lang.Object objParm8, java.lang.Object objParm9)
caller
- The callermethod
- The method the caller is executingparameterCount
- The number of parametersobjParm0
- The parametersobjParm1
- The parametersobjParm2
- The parametersobjParm3
- The parametersobjParm4
- The parametersobjParm5
- The parametersobjParm6
- The parametersobjParm7
- The parametersobjParm8
- The parametersobjParm9
- The parameterspublic void out(java.lang.Object caller, java.lang.String method)
caller
- The callermethod
- The method the caller returned frompublic void out(java.lang.Object caller, java.lang.String method, boolean returnValue)
caller
- The objectmethod
- The method the caller returned fromreturnValue
- The boolean return valuepublic void out(java.lang.Object caller, java.lang.String method, int returnValue)
caller
- The callermethod
- The method the caller returned fromreturnValue
- The integer return valuepublic void out(java.lang.Object caller, java.lang.String method, java.lang.Object returnValue)
caller
- The callermethod
- The method the caller returned fromreturnValue
- The value that was returned from the method.public void ln(java.lang.Object caller, java.lang.String format, int parameterCount, java.lang.Object param1, java.lang.Object param2, java.lang.Object param3, java.lang.Object param4, java.lang.Object param5, java.lang.Object param6, java.lang.Object param7, java.lang.Object param8, java.lang.Object param9, java.lang.Object param10)
caller
- The callerformat
- The format stringparameterCount
- The number of arguments.public void setDefaultTFile(java.lang.String defaultTFile)
public void setOutput(java.io.PrintStream printStream)
printStream
- The new PrintStream to use for tracingpublic boolean setTFile(boolean arg0, java.lang.String arg1, long arg2)
arg0
- true to turn tracefile onarg1
- filenamearg2
- wrapping sizepublic void setTFileOn(java.lang.String arg0) throws java.io.IOException
java.io.IOException
public void writeInitialTraceInfo() throws java.io.IOException
java.io.IOException
public void writeLogToTrace(java.lang.String message)
message
- The message.