Prolog (JTOpen 21.0.3 API)

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

```
public class Prolog
extends Object
```
Parses the 256 byte header of a trace and allows for printing and access to the fields of the Prolog

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getBufferWrap()`	Returns if buffer wrapped Y/N.
`String`	`getBuffSize()`	Returns the buffer size in bytes.
`String`	`getBytesCollected()`	Returns bytes collected.
`String`	`getChannels()`	Returns number of x.25 logical channels.
`String`	`getControllerName()`	Returns the Controller name.
`String`	`getDataDirection()`	Returns the data direction: 1=Sent 2=received 3=both
`String`	`getDate()`	return the current date in the Date.toString() format.
`String`	`getEndingBytes()`	Returns the ending bytes.
`String`	`getFilterIPv6()`	Returns address filtering for IPv6.
`String`	`getIPID()`	Returns IP protocol number.
`String`	`getIPv4()`	Returns IP address IPv4.
`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
`String`	`getLMIData()`	Returns trace LMI data" '0' - Normal trace '6' - Exclude LMI '3' - LMI only
`String`	`getLocalSAP()`	Returns local SAP address.
`String`	`getMaxFrameProtocol()`	Returns max frame allowed by protocol.
`String`	`getMaxFrameUser()`	Returns max frame allowed by user.
`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.
`String`	`getObjectType()`	Returns the Object type and subtype: '1' - Line description '2' - Network interface '3' - Network Server
`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
`String`	`getRecTimer()`	Returns record timer length 2/4 bytes.
`String`	`getRmtContName()`	Returns the remote controller name.
`String`	`getRmtMacAddr()`	Returns remote MAC address.
`String`	`getRmtSAP()`	Returns remote SAP address.
`String`	`getStartBytes()`	Returns the beginning bytes.
`String`	`getStartTime()`	Returns Start time of trace in 8-byte TOD clock value.
`String`	`getStatus()`	Returns status of trace: 'STOP' - Stopped 'ERR ' - Error
`String`	`getStopFull()`	returns Stop on Buffer full.
`String`	`getStopTime()`	Returns stop time of trace in 8-byte TOD clock value.
`String`	`getTitle()`	return the title of this communication trace
`String`	`getTraceDescription()`	Returns the trace description.
`String`	`getType()`	Returns the type.
`String`	`getUserData()`	Returns if traced all user data.
`boolean`	`invalidData()`	returns if there was an error parsing the data provided
`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 String getTitle()
```
    return the title of this communication trace
    
    Returns:
    
    The title
  - getDate
```
public 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 String toString()
```
    Returns a printable representation of this Prolog.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    Returns a string representation of this Prolog.
  - getTraceDescription
```
public String getTraceDescription()
```
    Returns the trace description.
    
    Returns:
    
    String containing the trace description.
  - getNDObject
```
public String getNDObject()
```
    Returns the ND object name.
    
    Returns:
    
    String containing ND object name.
  - getObjectType
```
public 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 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 String getBuffSize()
```
    Returns the buffer size in bytes.
    
    Returns:
    
    String containing buffer size in bytes.
  - getDataDirection
```
public String getDataDirection()
```
    Returns the data direction:
    1=Sent
    2=received
    3=both
    
    Returns:
    
    String containing the data direction.
  - getStopFull
```
public String getStopFull()
```
    returns Stop on Buffer full.
    
    Returns:
    
    String containing the code(Y/N).
  - getStartBytes
```
public String getStartBytes()
```
    Returns the beginning bytes.
    
    Returns:
    
    String containing the beginning bytes.
  - getEndingBytes
```
public String getEndingBytes()
```
    Returns the ending bytes.
    
    Returns:
    
    String containing the ending bytes.
  - getControllerName
```
public String getControllerName()
```
    Returns the Controller name.
    
    Returns:
    
    String containing the controller name.
  - getUserData
```
public String getUserData()
```
    Returns if traced all user data.
    
    Returns:
    
    String containing the code(Y/N).
  - getLANFilter
```
public 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 String getRmtContName()
```
    Returns the remote controller name.
    
    Returns:
    
    String containing the remote controller name.
  - getRmtMacAddr
```
public String getRmtMacAddr()
```
    Returns remote MAC address.
    
    Returns:
    
    String containing the remote MAC address.
  - getRmtSAP
```
public String getRmtSAP()
```
    Returns remote SAP address.
    
    Returns:
    
    String containing the remote SAP address.
  - getLocalSAP
```
public String getLocalSAP()
```
    Returns local SAP address.
    
    Returns:
    
    String containing the local SAP address.
  - getFilterIPv6
```
public String getFilterIPv6()
```
    Returns address filtering for IPv6.
    
    Returns:
    
    String containing the code.
  - getIPv4
```
public String getIPv4()
```
    Returns IP address IPv4.
    
    Returns:
    
    String containing the address.
  - getIPID
```
public String getIPID()
```
    Returns IP protocol number.
    
    Returns:
    
    String containing ip protocol number.
  - getLMIData
```
public String getLMIData()
```
    Returns trace LMI data"
    '0' - Normal trace
    '6' - Exclude LMI
    '3' - LMI only
    
    Returns:
    
    String containing the code.
  - getStatus
```
public String getStatus()
```
    Returns status of trace:
    'STOP' - Stopped
    'ERR ' - Error
    
    Returns:
    
    String containing the status.
  - getStartTime
```
public String getStartTime()
```
    Returns Start time of trace in 8-byte TOD clock value.
    
    Returns:
    
    String containing the start time.
  - getStopTime
```
public String getStopTime()
```
    Returns stop time of trace in 8-byte TOD clock value.
    
    Returns:
    
    String containing the stop time.
  - getBytesCollected
```
public String getBytesCollected()
```
    Returns bytes collected.
    
    Returns:
    
    String containing the number of bytes collected.
  - getMaxFrameProtocol
```
public String getMaxFrameProtocol()
```
    Returns max frame allowed by protocol.
    
    Returns:
    
    String containing the max frame.
  - getMaxFrameUser
```
public String getMaxFrameUser()
```
    Returns max frame allowed by user.
    
    Returns:
    
    String containing the max frame.
  - getChannels
```
public String getChannels()
```
    Returns number of x.25 logical channels.
    
    Returns:
    
    String containing the code.
  - getBufferWrap
```
public String getBufferWrap()
```
    Returns if buffer wrapped Y/N.
    
    Returns:
    
    String containing the code.
  - getRecTimer
```
public String getRecTimer()
```
    Returns record timer length 2/4 bytes.
    
    Returns:
    
    String containing the length.
  - getType
```
public String getType()
```
    Returns the type.
    
    Returns:
    
    String containing the type.

Class Prolog

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getNumRecs

getTitle

getDate

invalidData

getNumBytes

toString

getTraceDescription

getNDObject

getObjectType

getProtocol

getBuffSize

getDataDirection

getStopFull

getStartBytes

getEndingBytes

getControllerName

getUserData

getLANFilter

getRmtContName

getRmtMacAddr

getRmtSAP

getLocalSAP

getFilterIPv6

getIPv4

getIPID

getLMIData

getStatus

getStartTime

getStopTime

getBytesCollected

getMaxFrameProtocol

getMaxFrameUser

getChannels

getBufferWrap

getRecTimer

getType