IBM Rational Performance Tester SDK

com.ibm.rational.test.lt.trace
Class PayloadMsg

java.lang.Object
  extended by com.ibm.rational.test.lt.trace.Msg
      extended by com.ibm.rational.test.lt.trace.PayloadMsg
All Implemented Interfaces:
Serializable

public class PayloadMsg
extends Msg

See Also:
Serialized Form

Constructor Summary
PayloadMsg()
          Class constructor.
PayloadMsg(String protocol, String vendor, String version, int type, int connectionNumber)
          Class constructor specifying various properties.
PayloadMsg(String protocol, String vendor, String version, int type, int connectionNumber, byte[] bData)
          Class constructor specifying various properties.
PayloadMsg(String protocol, String vendor, String version, int type, int connectionNumber, byte[] bData, int bDataLength)
          Class constructor specifying various properties.
PayloadMsg(String protocol, String vendor, String version, int type, int connectionNumber, String sData)
          Class constructor specifying various properties.
 
Method Summary
 byte[] getBytes()
          Gets the (optional) binary data associated with this msg.
 int getBytesLength()
          Gets the length of the (optional) binary data associated with this msg.
 int getConnectionNumber()
          Gets the connection number associated with this msg.
 String getString()
          Gets the (optional) string data associated with this msg.
 int getType()
          Gets the type of information associated with this msg.
 void setBytes(byte[] bData)
          Sets the (optional) binary data associated with this msg.
 void setConnectionNumber(int c)
          Sets the connection number associated with this msg.
 void setString(String sData)
          Sets the (optional) string data associated with this msg.
 void setType(int type)
          Sets the type of information associated with this msg.
 
Methods inherited from class com.ibm.rational.test.lt.trace.Msg
getProtocol, getTicket, getTimestamp, getVendor, getVersion, setProtocol, setTicket, setTimestamp, setVendor, setVersion
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PayloadMsg

public PayloadMsg()
Class constructor.


PayloadMsg

public PayloadMsg(String protocol,
                  String vendor,
                  String version,
                  int type,
                  int connectionNumber)
Class constructor specifying various properties.

Parameters:
protocol - protocol name (example: "HTTP")
vendor - vendor name (example: "IBM")
version - version string (example: "6.1.2.0")
type - integer reflecting the type of information associated with this msg
connectionNumber - connection number associated with this msg

PayloadMsg

public PayloadMsg(String protocol,
                  String vendor,
                  String version,
                  int type,
                  int connectionNumber,
                  byte[] bData)
Class constructor specifying various properties.

Parameters:
protocol - protocol name (example: "HTTP")
vendor - vendor name (example: "IBM")
version - version string (example: "6.1.2.0")
type - integer reflecting the type of information associated with this msg
connectionNumber - connection number associated with this msg
bData - binary data associated with this msg

PayloadMsg

public PayloadMsg(String protocol,
                  String vendor,
                  String version,
                  int type,
                  int connectionNumber,
                  byte[] bData,
                  int bDataLength)
Class constructor specifying various properties.

Parameters:
protocol - protocol name (example: "HTTP")
vendor - vendor name (example: "IBM")
version - version string (example: "6.1.2.0")
type - integer reflecting the type of information associated with this msg
connectionNumber - connection number associated with this msg
bData - binary data associated with this msg
bDataLength - length of binary data associated with this msg

PayloadMsg

public PayloadMsg(String protocol,
                  String vendor,
                  String version,
                  int type,
                  int connectionNumber,
                  String sData)
Class constructor specifying various properties.

Parameters:
protocol - protocol name (example: "HTTP")
vendor - vendor name (example: "IBM")
version - version string (example: "6.1.2.0")
type - integer reflecting the type of information associated with this msg
connectionNumber - connection number associated with this msg
sData - String data associated with this msg
Method Detail

getType

public int getType()
Gets the type of information associated with this msg. This value can be used to categorize the msg as SECURE, UNSECURE, etc. The actual value used here is arbitrary, and is defined by the 'contract' between a given recorder/testgen-protocol-handler pair. The values carried here are transparent to lt.trace.

Returns:
integer reflecting the type of information associated with this msg

setType

public void setType(int type)
Sets the type of information associated with this msg. This value can be used to categorize the msg as SECURE, UNSECURE, etc. The actual value used here is arbitrary, and is defined by the 'contract' between a given recorder/testgen-protocol-handler pair. The values carried here are transparent to lt.trace.

Parameters:
type - integer reflecting the type of information associated with this msg

getConnectionNumber

public int getConnectionNumber()
Gets the connection number associated with this msg.

Returns:
the connection number

setConnectionNumber

public void setConnectionNumber(int c)
Sets the connection number associated with this msg.

Parameters:
c - the connection number

getBytesLength

public int getBytesLength()
Gets the length of the (optional) binary data associated with this msg.

Returns:
the length of the binary data, or zero

getBytes

public byte[] getBytes()
Gets the (optional) binary data associated with this msg.

Returns:
the binary data

setBytes

public void setBytes(byte[] bData)
Sets the (optional) binary data associated with this msg.

Parameters:
bData - the binary data

getString

public String getString()
Gets the (optional) string data associated with this msg.

Returns:
the string data

setString

public void setString(String sData)
Sets the (optional) string data associated with this msg.

Parameters:
sData - the string data

IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2012. All rights reserved.