com.ibm.rational.test.lt.execution.socket.custom
Interface ISckCustomSend


public interface ISckCustomSend

ISckCustomSend is the interface that Custom Send writers must implement.
The customized send action, whom a reference is passed through sendActionRef parameter of the setup() method, lets a chance to form/encode/check the sent data before it goes on the wire.


 The custom send code is called by the mean of two hooks: one before the substitutions are done and one
 after.
References to the ITestExecutionServices and ISckSendAction are passed to the custom code through a call to the setup() method.


Method Summary
 byte[] onAfterSubstitution(byte[] data)
          Called after the substitutions are applied on the data to be sent
 byte[] onBeforeSubstitution(byte[] data)
          Called before the substitutions are applied on the data to be sent
 void setup(ITestExecutionServices tesRef, ISckSendAction sendActionRef)
          Setup is called before the customized send action is executed.
 

Method Detail

setup

void setup(ITestExecutionServices tesRef,
           ISckSendAction sendActionRef)
Setup is called before the customized send action is executed.

Parameters:
tesRef - the reference to the ITestExecutionServices, that allows to log custom events in the Test Log amongst other things
sendActionRef - the reference to the customized send action

onBeforeSubstitution

byte[] onBeforeSubstitution(byte[] data)
Called before the substitutions are applied on the data to be sent

Parameters:
data -
Returns:
the new data to send or data if no changes are made

onAfterSubstitution

byte[] onAfterSubstitution(byte[] data)
Called after the substitutions are applied on the data to be sent

Parameters:
data -
Returns:
the new data to send or data if no changes are made