IBM Rational Performance Tester SDK

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

java.lang.Object
  extended by com.ibm.rational.test.lt.trace.Msg
      extended by com.ibm.rational.test.lt.trace.UDMethodBaseMsg
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
UDMethodDefMsg, UDMethodEntryMsg, UDMethodExitMsg, UDMethodInvocationMsg

public class UDMethodBaseMsg
extends Msg

See Also:
Serialized Form

Constructor Summary
UDMethodBaseMsg()
          Class constructor.
UDMethodBaseMsg(String protocol, String vendor, String version)
          Class constructor specifying various properties.
UDMethodBaseMsg(String protocol, String vendor, String version, int id)
          Class constructor specifying various properties.
 
Method Summary
 int getMethodDefID()
          Gets the methodDef ID associated with this msg.
 byte[] getParameterBytes(int ndx)
          Gets the value of the specified parameter.
 String getParameterString(int ndx)
          Gets the value of the specified parameter.
 void setMethodDefID(int id)
          Sets the methodDef ID associated with this msg.
 void setParameterBytes(int ndx, byte[] val)
          Sets the value of the specified parameter.
 void setParameterString(int ndx, String val)
          Sets the value of the specified parameter.
 
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

UDMethodBaseMsg

public UDMethodBaseMsg()
Class constructor.


UDMethodBaseMsg

public UDMethodBaseMsg(String protocol,
                       String vendor,
                       String version)
Class constructor specifying various properties.

Parameters:
protocol - protocol name (example: "HTTP")
vendor - vendor name (example: "IBM")
version - version string (example: "6.1.2.0")

UDMethodBaseMsg

public UDMethodBaseMsg(String protocol,
                       String vendor,
                       String version,
                       int id)
Class constructor specifying various properties.

Parameters:
protocol - protocol name (example: "HTTP")
vendor - vendor name (example: "IBM")
version - version string (example: "6.1.2.0")
id - the methodDef ID associated with this User Defined msg (example: 1, 2, 3, etc.)
Method Detail

getMethodDefID

public int getMethodDefID()
Gets the methodDef ID associated with this msg.

Returns:
integer reflecting the methodDef ID associated with this msg

setMethodDefID

public void setMethodDefID(int id)
Sets the methodDef ID associated with this msg. This value will be subsequently used to associate UDMethodEntry|Exit|InvocationMsg objects with this methodDef. The actual value used here is arbitrary, but generally, a recorder should start these values at 1, and increment by 1 for each methodDef defined.

Parameters:
id - integer reflecting the methodDef ID associated with this msg

setParameterString

public void setParameterString(int ndx,
                               String val)
                        throws TraceException
Sets the value of the specified parameter.

Parameters:
ndx - the zero-based index of the parameter
val - the string to set the paramater to
Throws:
TraceException - if the specified parameter index is out of range

setParameterBytes

public void setParameterBytes(int ndx,
                              byte[] val)
                       throws TraceException
Sets the value of the specified parameter.

Parameters:
ndx - the zero-based index of the parameter
val - the byte array to set the paramater to
Throws:
TraceException - if the specified parameter index is out of range

getParameterString

public String getParameterString(int ndx)
                          throws TraceException
Gets the value of the specified parameter.

Parameters:
ndx - the zero-based index of the parameter
Returns:
the string contained in the paramater
Throws:
TraceException - if the specified parameter index is out of range

getParameterBytes

public byte[] getParameterBytes(int ndx)
                         throws TraceException
Gets the value of the specified parameter.

Parameters:
ndx - the zero-based index of the parameter
Returns:
the byte array contained in the paramater
Throws:
TraceException - if the specified parameter index is out of range

IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2012. All rights reserved.