com.ibm.as400.util.commtrace

Class Prolog

  • java.lang.Object
    • com.ibm.as400.util.commtrace.Prolog


  • public class Prolog
    extends java.lang.Object
    Parses the 256 byte header of a trace and allows for printing and access to the fields of the Prolog
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.String getBufferWrap()
      Returns if buffer wrapped Y/N.
      java.lang.String getBuffSize()
      Returns the buffer size in bytes.
      java.lang.String getBytesCollected()
      Returns bytes collected.
      java.lang.String getChannels()
      Returns number of x.25 logical channels.
      java.lang.String getControllerName()
      Returns the Controller name.
      java.lang.String getDataDirection()
      Returns the data direction:
      1=Sent
      2=received
      3=both
      java.lang.String getDate()
      return the current date in the Date.toString() format.
      java.lang.String getEndingBytes()
      Returns the ending bytes.
      java.lang.String getFilterIPv6()
      Returns address filtering for IPv6.
      java.lang.String getIPID()
      Returns IP protocol number.
      java.lang.String getIPv4()
      Returns IP address IPv4.
      java.lang.String getLANFilter()
      Returns the Lan Filter option.
      java.lang.String getLMIData()
      Returns trace LMI data"
      '0' - Normal trace
      '6' - Exclude LMI
      '3' - LMI only
      java.lang.String getLocalSAP()
      Returns local SAP address.
      java.lang.String getMaxFrameProtocol()
      Returns max frame allowed by protocol.
      java.lang.String getMaxFrameUser()
      Returns max frame allowed by user.
      java.lang.String getNDObject()
      Returns the ND object name.
      int getNumBytes()
      Returns the number of bytes collected during this communication trace .
      int getNumRecs()
      return the number of records in this communication trace.
      java.lang.String getObjectType()
      Returns the Object type and subtype:
      '1' - Line description
      '2' - Network interface
      '3' - Network Server
      java.lang.String getProtocol()
      Returns the protocol:
      'A' - ASYNC
      'B' - BSC
      'C' - ETHERNET
      'D' - DDI
      'E' - ECL(TOKEN-RING)
      'E' - ECL(TOKEN-RING)
      'F' - FRAME RELAY
      'H' - HDLC(X.25)
      'I' - ISDN
      'Q' - IDLC
      'S' - SDLC
      java.lang.String getRecTimer()
      Returns record timer length 2/4 bytes.
      java.lang.String getRmtContName()
      Returns the remote controller name.
      java.lang.String getRmtMacAddr()
      Returns remote MAC address.
      java.lang.String getRmtSAP()
      Returns remote SAP address.
      java.lang.String getStartBytes()
      Returns the beginning bytes.
      java.lang.String getStartTime()
      Returns Start time of trace in 8-byte TOD clock value.
      java.lang.String getStatus()
      Returns status of trace:
      'STOP' - Stopped
      'ERR ' - Error
      java.lang.String getStopFull()
      returns Stop on Buffer full.
      java.lang.String getStopTime()
      Returns stop time of trace in 8-byte TOD clock value.
      java.lang.String getTitle()
      return the title of this communication trace
      java.lang.String getTraceDescription()
      Returns the trace description.
      java.lang.String getType()
      Returns the type.
      java.lang.String getUserData()
      Returns if traced all user data.
      boolean invalidData()
      returns if there was an error parsing the data provided
      java.lang.String toString()
      Returns a printable representation of this Prolog.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
  • >
    • Method Detail

      • getNumRecs

        public int getNumRecs()
        return the number of records in this communication trace.
        Returns:
        The number of records
      • getTitle

        public java.lang.String getTitle()
        return the title of this communication trace
        Returns:
        The title
      • getDate

        public java.lang.String getDate()
        return the current date in the Date.toString() format.
        Returns:
        String
      • invalidData

        public boolean invalidData()
        returns if there was an error parsing the data provided
        Returns:
        true if this file contains invalid data, else returns false
      • getNumBytes

        public int getNumBytes()
        Returns the number of bytes collected during this communication trace .
        Returns:
        Number of bytes collected
      • toString

        public java.lang.String toString()
        Returns a printable representation of this Prolog.
        Overrides:
        toString in class java.lang.Object
        Returns:
        Returns a string representation of this Prolog.
      • getTraceDescription

        public java.lang.String getTraceDescription()
        Returns the trace description.
        Returns:
        String containing the trace description.
      • getNDObject

        public java.lang.String getNDObject()
        Returns the ND object name.
        Returns:
        String containing ND object name.
      • getObjectType

        public java.lang.String getObjectType()
        Returns the Object type and subtype:
        '1' - Line description
        '2' - Network interface
        '3' - Network Server
        Returns:
        String containing a the Object type and subtype.
      • getProtocol

        public java.lang.String getProtocol()
        Returns the protocol:
        'A' - ASYNC
        'B' - BSC
        'C' - ETHERNET
        'D' - DDI
        'E' - ECL(TOKEN-RING)
        'E' - ECL(TOKEN-RING)
        'F' - FRAME RELAY
        'H' - HDLC(X.25)
        'I' - ISDN
        'Q' - IDLC
        'S' - SDLC
        Returns:
        String containing the protocol.
      • getBuffSize

        public java.lang.String getBuffSize()
        Returns the buffer size in bytes.
        Returns:
        String containing buffer size in bytes.
      • getDataDirection

        public java.lang.String getDataDirection()
        Returns the data direction:
        1=Sent
        2=received
        3=both
        Returns:
        String containing the data direction.
      • getStopFull

        public java.lang.String getStopFull()
        returns Stop on Buffer full.
        Returns:
        String containing the code(Y/N).
      • getStartBytes

        public java.lang.String getStartBytes()
        Returns the beginning bytes.
        Returns:
        String containing the beginning bytes.
      • getEndingBytes

        public java.lang.String getEndingBytes()
        Returns the ending bytes.
        Returns:
        String containing the ending bytes.
      • getControllerName

        public java.lang.String getControllerName()
        Returns the Controller name.
        Returns:
        String containing the controller name.
      • getUserData

        public java.lang.String getUserData()
        Returns if traced all user data.
        Returns:
        String containing the code(Y/N).
      • getLANFilter

        public java.lang.String getLANFilter()
        Returns the Lan Filter option.
        Filter by :
        '0' - All data (no filtering)
        '1' - remote controller
        '2' - remote MAC address
        '3' - remote SAP
        '4' - local SAP
        '5' - IP protocol number
        '6' - remote IP address
        Returns:
        String containing the code.
      • getRmtContName

        public java.lang.String getRmtContName()
        Returns the remote controller name.
        Returns:
        String containing the remote controller name.
      • getRmtMacAddr

        public java.lang.String getRmtMacAddr()
        Returns remote MAC address.
        Returns:
        String containing the remote MAC address.
      • getRmtSAP

        public java.lang.String getRmtSAP()
        Returns remote SAP address.
        Returns:
        String containing the remote SAP address.
      • getLocalSAP

        public java.lang.String getLocalSAP()
        Returns local SAP address.
        Returns:
        String containing the local SAP address.
      • getFilterIPv6

        public java.lang.String getFilterIPv6()
        Returns address filtering for IPv6.
        Returns:
        String containing the code.
      • getIPv4

        public java.lang.String getIPv4()
        Returns IP address IPv4.
        Returns:
        String containing the address.
      • getIPID

        public java.lang.String getIPID()
        Returns IP protocol number.
        Returns:
        String containing ip protocol number.
      • getLMIData

        public java.lang.String getLMIData()
        Returns trace LMI data"
        '0' - Normal trace
        '6' - Exclude LMI
        '3' - LMI only
        Returns:
        String containing the code.
      • getStatus

        public java.lang.String getStatus()
        Returns status of trace:
        'STOP' - Stopped
        'ERR ' - Error
        Returns:
        String containing the status.
      • getStartTime

        public java.lang.String getStartTime()
        Returns Start time of trace in 8-byte TOD clock value.
        Returns:
        String containing the start time.
      • getStopTime

        public java.lang.String getStopTime()
        Returns stop time of trace in 8-byte TOD clock value.
        Returns:
        String containing the stop time.
      • getBytesCollected

        public java.lang.String getBytesCollected()
        Returns bytes collected.
        Returns:
        String containing the number of bytes collected.
      • getMaxFrameProtocol

        public java.lang.String getMaxFrameProtocol()
        Returns max frame allowed by protocol.
        Returns:
        String containing the max frame.
      • getMaxFrameUser

        public java.lang.String getMaxFrameUser()
        Returns max frame allowed by user.
        Returns:
        String containing the max frame.
      • getChannels

        public java.lang.String getChannels()
        Returns number of x.25 logical channels.
        Returns:
        String containing the code.
      • getBufferWrap

        public java.lang.String getBufferWrap()
        Returns if buffer wrapped Y/N.
        Returns:
        String containing the code.
      • getRecTimer

        public java.lang.String getRecTimer()
        Returns record timer length 2/4 bytes.
        Returns:
        String containing the length.
      • getType

        public java.lang.String getType()
        Returns the type.
        Returns:
        String containing the type.