com.ibm.ctg.client

Class CICSTrace

  • java.lang.Object
    • com.ibm.ctg.client.CICSTrace


  • public class CICSTrace
    extends java.lang.Object
    Wrapper for the 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.

    • Field Summary

      Fields 
      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 Summary

      Constructors 
      Constructor and Description
      CICSTrace() 
    • Method Summary

      Methods 
      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.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • COMPONENT

        public static final java.lang.String COMPONENT
        The component name to use for the resource adapter
        See Also:
        Constant Field Values
    • Constructor Detail

      • CICSTrace

        public CICSTrace()
    • Method Detail

      • applyTraceSettings

        public void applyTraceSettings()
        Unsupported by CICS
      • ex

        public void ex(java.lang.Object caller,
              java.lang.Throwable exception)
        Trace an exception
        Parameters:
        caller - The object which threw the exception
        exception - The exception
      • flushTrace

        public long flushTrace()
        Unsupported by CICS
      • getDefaultTFile

        public java.lang.String getDefaultTFile()
        Returns:
        The name of the JVM trace file.
      • getPrsTrace

        public java.lang.Object getPrsTrace()
        Unsupported by CICS
      • getTFileName

        public java.lang.String getTFileName()
        Returns:
        The JVM trace file name.
      • hexDump

        public 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.
        Parameters:
        caller - The object
        dumpArea - The data area to dump
        comment - The explanation of the data area
        start - The offset to start at
        end - the offset to end at
        isEBCDIC - true if the data is in EBCDIC
      • traceln

        public void traceln(java.lang.String message)
        Trace a line.
        Parameters:
        message - The message to log.
      • in

        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)
        Trace the entry of a method
        Parameters:
        caller - The caller
        method - The method the caller is executing
        parameterCount - The number of parameters
        objParm0 - The parameters
        objParm1 - The parameters
        objParm2 - The parameters
        objParm3 - The parameters
        objParm4 - The parameters
        objParm5 - The parameters
        objParm6 - The parameters
        objParm7 - The parameters
        objParm8 - The parameters
        objParm9 - The parameters
      • out

        public void out(java.lang.Object caller,
               java.lang.String method)
        Trace an exit from a method.
        Parameters:
        caller - The caller
        method - The method the caller returned from
      • out

        public void out(java.lang.Object caller,
               java.lang.String method,
               boolean returnValue)
        Trace an exit from a method with a boolean return.
        Parameters:
        caller - The object
        method - The method the caller returned from
        returnValue - The boolean return value
      • out

        public void out(java.lang.Object caller,
               java.lang.String method,
               int returnValue)
        Trace an exit from a method with an integer return.
        Parameters:
        caller - The caller
        method - The method the caller returned from
        returnValue - The integer return value
      • out

        public void out(java.lang.Object caller,
               java.lang.String method,
               java.lang.Object returnValue)
        Trace an exit from a method with an object return
        Parameters:
        caller - The caller
        method - The method the caller returned from
        returnValue - The value that was returned from the method.
      • ln

        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)
        Log an entry with an insert string.
        Parameters:
        caller - The caller
        format - The format string
        parameterCount - The number of arguments.
      • setDefaultTFile

        public void setDefaultTFile(java.lang.String defaultTFile)
        Unsupported by CICS
      • setOutput

        public void setOutput(java.io.PrintStream printStream)
        Unsupported by CICS
        Parameters:
        printStream - The new PrintStream to use for tracing
      • setTFile

        public boolean setTFile(boolean arg0,
                       java.lang.String arg1,
                       long arg2)
        Unsupported by CICS
        Parameters:
        arg0 - true to turn tracefile on
        arg1 - filename
        arg2 - wrapping size
        Returns:
        true if the the trace file was successfully set, false otherwise
      • setTFileOn

        public void setTFileOn(java.lang.String arg0)
                        throws java.io.IOException
        Unsupported by CICS
        Throws:
        java.io.IOException
      • writeInitialTraceInfo

        public void writeInitialTraceInfo()
                                   throws java.io.IOException
        Write the initial trace information.
        Throws:
        java.io.IOException
      • writeLogToTrace

        public void writeLogToTrace(java.lang.String message)
        Writes a message to the trace file.
        Parameters:
        message - The message.

©Copyright IBM Corp. 1994, 2016


Legal