org.cafesip.sipunit
Class SipTransaction

java.lang.Object
  org.cafesip.sipunit.SipTransaction

public class SipTransaction
extends java.lang.Object

SipTransaction is primarily used by the SipUnit API classes to manage some SIP operations. The user program doesn't need to do anything with a SipTransaction if returned by the API other than pass it in to a related, subsequent API call as instructed on a per-operation basis. The user program MAY call methods on this object to get related JAIN SIP API objects. One of the methods is getRequest() to get the javax.sip.message.Request object that created this transaction. The others include the getClientTransaction() or getServerTransaction() method - only one of these should be called for a given SipTransaction depending on the context of the transaction (request sending vs. receiving). Knowledge of JAIN SIP API is required to use the returned objects.

Method Summary

javax.sip.ClientTransaction	getClientTransaction()
javax.sip.message.Request	getRequest() The user test program MAY call this method to view the javax.sip.message.Request object that created this transaction.
javax.sip.ServerTransaction	getServerTransaction()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getClientTransaction

public javax.sip.ClientTransaction getClientTransaction()

Returns:

Returns the JAIN SIP ClientTransaction. Use this method only within the context of a sent request. Knowledge of JAIN SIP API is required to use the returned object.

getServerTransaction

public javax.sip.ServerTransaction getServerTransaction()

Returns:

Returns the JAIN SIP ServerTransaction. Use this method only within the context of a received request. Knowledge of JAIN SIP API is required to use the returned object.

getRequest

public javax.sip.message.Request getRequest()

The user test program MAY call this method to view the javax.sip.message.Request object that created this transaction. However, knowledge of JAIN SIP API is required to interpret the Request object.

Returns:

Returns the javax.sip.message.Request object that created this transaction.