SIPTransactionImpl (jain-sip-ri 1.2.232 API)

java.lang.Object
- gov.nist.javax.sip.stack.SIPTransactionImpl

All Implemented Interfaces:

SIPTransaction, TransactionExt, Serializable, Transaction

Direct Known Subclasses:

SIPClientTransactionImpl, SIPServerTransactionImpl
```
public abstract class SIPTransactionImpl
extends Object
implements SIPTransaction
```
Abstract class to support both client and server transactions. Provides an encapsulation of a message channel, handles timer events, and creation of the Via header for a message.

Version:

1.2 $Revision: 1.100 $ $Date: 2010-12-02 22:04:13 $

Author:

Jeff Keyser, M. Ranganathan

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Object`	`applicationData`
`protected long`	`auditTag`
`protected int`	`baseTimerInterval`
`protected int`	`collectionTime`
`protected MessageChannel`	`encapsulatedChannel`
`gov.nist.javax.sip.stack.SIPClientTransactionImpl.ExpiresTimerTask`	`expiresTimerTask`
`protected boolean`	`isMapped`
`protected SIPResponse`	`lastResponse`
`protected String`	`mergeId`
`protected SIPRequest`	`originalRequest`
`protected String`	`originalRequestBranch`
`protected byte[]`	`originalRequestBytes`
`protected long`	`originalRequestCSeqNumber`
`protected boolean`	`originalRequestHasPort`
`protected SIPTransactionStack`	`sipStack`
`protected int`	`T2` The maximum retransmit interval for non-INVITE requests and INVITE responses
`protected int`	`T4` 5 sec Maximum duration a message will remain in the network
`protected int`	`timeoutTimerTicksLeft`
`protected int`	`timerD`
`protected int`	`timerI`
`protected int`	`timerK`
`protected boolean`	`toListener`
`protected String`	`transactionId`
`protected AtomicBoolean`	`transactionTimerStarted`

Fields inherited from interface gov.nist.javax.sip.stack.SIPTransaction
CALLING_STATE, COMPLETED_STATE, CONFIRMED_STATE, INITIAL_STATE, PROCEEDING_STATE, T1, TERMINATED_STATE, TIMER_A, TIMER_B, TIMER_F, TIMER_H, TIMER_J, TRYING_STATE

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`SIPTransactionImpl(SIPTransactionStack newParentStack, MessageChannel newEncapsulatedChannel)` Transaction constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`acquireSem()` A given tx can process only a single outstanding event at a time.
`void`	`addEventListener(SIPTransactionEventListener newListener)` Adds a new event listener to this transaction.
`void`	`cancelMaxTxLifeTimeTimer()`
`abstract void`	`cleanUp()`
`void`	`close()` Close the encapsulated channel.
`void`	`disableRetransmissionTimer()` Turns off retransmission events for this transaction.
`void`	`disableTimeoutTimer()` Disabled the timeout timer.
`boolean`	`doesCancelMatchTransaction(SIPRequest requestToTest)` A method that can be used to test if an incoming request belongs to this transction.
`protected void`	`enableRetransmissionTimer()` Enables retransmission timer events for this transaction to begin in one tick.
`protected void`	`enableRetransmissionTimer(int tickCount)` Enables retransmission timer events for this transaction to begin after the number of ticks passed to this routine.
`protected void`	`enableTimeoutTimer(int tickCount)` Enables a timeout event to occur for this transaction after the number of ticks passed to this method.
`List<String>`	`extractCertIdentities()` Extract identities from certificates exchanged over TLS, based on guidelines from rfc5922.
`void`	`fireTimer()` Fired after each timer tick.
`Object`	`getApplicationData()` Get the application data associated with this transaction.
`long`	`getAuditTag()`
`int`	`getBaseTimerInterval()`
`String`	`getBranch()` Gets the current setting for the branch parameter of this transaction.
`String`	`getBranchId()` Returns a unique branch identifer that identifies this transaction.
`String`	`getCipherSuite()` Return the Cipher Suite that was used for the SSL handshake.
`long`	`getCSeq()` Get the Sequence number of the request used to create the transaction.
`abstract Dialog`	`getDialog()` Gets the dialog object of this Transaction object.
`String`	`getForkId()` Retrieves the fork id for the transaction.
`String`	`getHost()` return the ip address on which this message was initially received
`int`	`getInternalState()` Gets the current state of this transaction.
`String`	`getKey()`
`SIPResponse`	`getLastResponse()` Get the last response.
`Certificate[]`	`getLocalCertificates()` Get the certificate(s) that were sent to the peer during handshaking.
`String`	`getMergeId()`
`MessageChannel`	`getMessageChannel()` Returns the message channel used for transmitting/receiving messages for this transaction.
`MessageProcessor`	`getMessageProcessor()`
`String`	`getMethod()` Get the method of the request used to create this transaction.
`SIPRequest`	`getOriginalRequest()` Gets the request being handled by this transaction.
`String`	`getPeerAddress()` Returns the IP address of the upstream/downstream hop from which this message was initially received
`Certificate[]`	`getPeerCertificates()`
`InetAddress`	`getPeerInetAddress()`
`InetAddress`	`getPeerPacketSourceAddress()`
`int`	`getPeerPacketSourcePort()`
`int`	`getPeerPort()` Returns the port of the upstream/downstream hop from which this message was initially received
`String`	`getPeerProtocol()`
`int`	`getPort()` return the port on which this message was initially received
`Request`	`getRequest()` Get the original request but cast to a Request structure.
`Response`	`getResponse()` Get the JAIN interface response
`int`	`getRetransmitTimer()` Returns the current value of the retransmit timer in milliseconds used to retransmit messages over unreliable transports.
`SipProviderImpl`	`getSipProvider()` Return the SipProvider for which the transaction is assigned.
`SIPTransactionStack`	`getSIPStack()`
`TransactionState`	`getState()` Gets the current state of this transaction.
`int`	`getT2()`
`int`	`getT4()`
`int`	`getTimerD()` Sets the value of Timer D (in ms)
`int`	`getTimerI()`
`int`	`getTimerK()`
`int`	`getTimerT2()` Retrieve the value of Timer T2 (in ms)
`int`	`getTimerT4()` Retrieve the value of Timer T4 (in ms)
`String`	`getTransactionId()` Get the transaction Id.
`String`	`getTransport()` Returns the name of the protocol with which this message was initially received
`Via`	`getViaHeader()` Returns the Via header for this channel.
`String`	`getViaHost()` Get the host to assign for an outgoing Request via header.
`int`	`getViaPort()` Get the port to assign for the via header of an outgoing message.
`int`	`hashCode()` Hashcode method for fast hashtable lookup.
`boolean`	`isByeTransaction()` Return a flag that states if this is a BYE transaction.
`boolean`	`isCancelTransaction()` Return true if the transaction corresponds to a CANCEL message.
`boolean`	`isDialogCreatingTransaction()` Returns a flag stating whether this transaction is for a request that creates a dialog.
`boolean`	`isInviteTransaction()` Returns a flag stating whether this transaction is for an INVITE request or not.
`abstract boolean`	`isMessagePartOfTransaction(SIPMessage messageToTest)` Tests a message to see if it is part of this transaction.
`boolean`	`isReleaseReferences()` retrieve the value of release references to know if the stack performs optimizations on cleanup to save on memory
`boolean`	`isReliable()`
`boolean`	`isSecure()`
`boolean`	`isServerTransaction()` A shortcut way of telling if we are a server transaction.
`boolean`	`isTerminated()` Tests if this transaction has terminated.
`boolean`	`isTransactionMapped()`
`boolean`	`passToListener()` Set true to pass the request up to the listener.
`void`	`raiseErrorEvent(int errorEventID)` Creates a SIPTransactionErrorEvent and sends it to all of the listeners of this transaction.
`void`	`raiseIOExceptionEvent()` Raise an IO Exception event - this is used for reporting asynchronous IO Exceptions that are attributable to this transaction.
`void`	`releaseSem()` Release the transaction semaphore.
`void`	`removeEventListener(SIPTransactionEventListener oldListener)` Removed an event listener from this transaction.
`void`	`scheduleMaxTxLifeTimeTimer()`
`void`	`semRelease()`
`void`	`sendMessage(byte[] messageBytes, InetAddress receiverAddress, int receiverPort, boolean retry)` Parse the byte array as a message, process it through the transaction, and send it to the SIP peer.
`void`	`sendMessage(SIPMessage messageToSend)` Process the message through the transaction and sends it to the SIP peer.
`void`	`setApplicationData(Object applicationData)` Set the application data pointer.
`void`	`setAuditTag(long auditTag)`
`void`	`setBranch(String newBranch)` Sets the Via header branch parameter used to identify this transaction.
`void`	`setCollectionTime(int collectionTime)`
`abstract void`	`setDialog(SIPDialog sipDialog, String dialogId)` set the dialog object.
`void`	`setEncapsulatedChannel(MessageChannel messageChannel)` Set the encapsuated channel.
`void`	`setForkId(String forkId)` Sets the fork id for the transaction.
`void`	`setOriginalRequest(SIPRequest newOriginalRequest)` Sets the request message that this transaction handles.
`void`	`setPassToListener()` Set the passToListener flag to true.
`void`	`setReleaseReferences(boolean releaseReferences)` If set to true it will release all references that it no longer needs.
`void`	`setRetransmitTimer(int retransmitTimer)` Sets the value of the retransmit timer to the newly supplied timer value.
`void`	`setState(int newState)` Changes the state of this transaction.
`void`	`setTimerD(int interval)` Sets the value of Timer D (in ms)
`void`	`setTimerT2(int interval)` Sets the value of Timer T2 (in ms)
`void`	`setTimerT4(int interval)` Sets the value of Timer T4 (in ms)
`void`	`setTransactionMapped(boolean transactionMapped)`
`boolean`	`testAndSetTransactionTerminatedEvent()` Flag to test if the terminated event is delivered.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface gov.nist.javax.sip.stack.SIPTransaction
fireRetransmissionTimer, fireTimeoutTimer, startTransactionTimer

Methods inherited from interface javax.sip.Transaction
terminate

- Field Detail
  - toListener
```
protected boolean toListener
```
  - baseTimerInterval
```
protected int baseTimerInterval
```
  - T4
```
protected int T4
```
    5 sec Maximum duration a message will remain in the network
  - T2
```
protected int T2
```
    The maximum retransmit interval for non-INVITE requests and INVITE responses
  - timerI
```
protected int timerI
```
  - timerK
```
protected int timerK
```
  - timerD
```
protected int timerD
```
  - applicationData
```
protected transient Object applicationData
```
  - lastResponse
```
protected SIPResponse lastResponse
```
  - isMapped
```
protected boolean isMapped
```
  - transactionId
```
protected String transactionId
```
  - auditTag
```
protected long auditTag
```
  - sipStack
```
protected transient SIPTransactionStack sipStack
```
  - originalRequest
```
protected SIPRequest originalRequest
```
  - originalRequestBytes
```
protected byte[] originalRequestBytes
```
  - originalRequestCSeqNumber
```
protected long originalRequestCSeqNumber
```
  - originalRequestBranch
```
protected String originalRequestBranch
```
  - originalRequestHasPort
```
protected boolean originalRequestHasPort
```
  - encapsulatedChannel
```
protected transient MessageChannel encapsulatedChannel
```
  - transactionTimerStarted
```
protected AtomicBoolean transactionTimerStarted
```
  - timeoutTimerTicksLeft
```
protected int timeoutTimerTicksLeft
```
  - collectionTime
```
protected int collectionTime
```
  - mergeId
```
protected String mergeId
```
  - expiresTimerTask
```
public gov.nist.javax.sip.stack.SIPClientTransactionImpl.ExpiresTimerTask expiresTimerTask
```
- Constructor Detail
  - SIPTransactionImpl
```
protected SIPTransactionImpl(SIPTransactionStack newParentStack,
                  MessageChannel newEncapsulatedChannel)
```
    Transaction constructor.
    
    Parameters:
    newParentStack - Parent stack for this transaction.
    newEncapsulatedChannel - Underlying channel for this transaction.
- Method Detail
  - getBranchId
```
public String getBranchId()
```
    Description copied from interface: Transaction
    
    Returns a unique branch identifer that identifies this transaction. The branch identifier is used in the ViaHeader. The uniqueness property of the branch ID parameter to facilitate its use as a transaction ID, was not part of RFC 2543. The branch ID inserted by an element compliant with the RFC3261 specification MUST always begin with the characters "z9hG4bK". These 7 characters are used as a magic cookie, so that servers receiving the request can determine that the branch ID was constructed to be globally unique. The precise format of the branch token is implementation-defined. This method should always return the same branch identifier for the same transaction.
    
    Specified by:
    
    getBranchId in interface SIPTransaction
    
    Specified by:
    
    getBranchId in interface Transaction
    
    Returns:
    the new branch that uniquely identifies this transaction.
    See Also:
    SIPTransaction.getBranchId()
  - cleanUp
```
public abstract void cleanUp()
```
    Specified by:
    
    cleanUp in interface SIPTransaction
    
    See Also:
    SIPTransaction.cleanUp()
  - setOriginalRequest
```
public void setOriginalRequest(SIPRequest newOriginalRequest)
```
    Description copied from interface: SIPTransaction
    
    Sets the request message that this transaction handles.
    
    Specified by:
    
    setOriginalRequest in interface SIPTransaction
    
    Parameters:
    newOriginalRequest - Request being handled.
    See Also:
    SIPTransaction.setOriginalRequest(gov.nist.javax.sip.message.SIPRequest)
  - getOriginalRequest
```
public SIPRequest getOriginalRequest()
```
    Description copied from interface: SIPTransaction
    
    Gets the request being handled by this transaction.
    
    Specified by:
    
    getOriginalRequest in interface SIPTransaction
    
    Returns:
    -- the original Request associated with this transaction.
    See Also:
    SIPTransaction.getOriginalRequest()
  - getRequest
```
public Request getRequest()
```
    Description copied from interface: SIPTransaction
    
    Get the original request but cast to a Request structure.
    
    Specified by:
    
    getRequest in interface SIPTransaction
    
    Specified by:
    
    getRequest in interface Transaction
    
    Returns:
    the request that generated this transaction.
    See Also:
    SIPTransaction.getRequest()
  - isDialogCreatingTransaction
```
public boolean isDialogCreatingTransaction()
```
    Description copied from interface: SIPTransaction
    
    Returns a flag stating whether this transaction is for a request that creates a dialog.
    
    Specified by:
    
    isDialogCreatingTransaction in interface SIPTransaction
    
    Returns:
    -- true if this is a request that creates a dialog, false if not.
    See Also:
    SIPTransaction.isDialogCreatingTransaction()
  - isInviteTransaction
```
public boolean isInviteTransaction()
```
    Description copied from interface: SIPTransaction
    
    Returns a flag stating whether this transaction is for an INVITE request or not.
    
    Specified by:
    
    isInviteTransaction in interface SIPTransaction
    
    Returns:
    -- true if this is an INVITE request, false if not.
    See Also:
    SIPTransaction.isInviteTransaction()
  - isCancelTransaction
```
public boolean isCancelTransaction()
```
    Description copied from interface: SIPTransaction
    
    Return true if the transaction corresponds to a CANCEL message.
    
    Specified by:
    
    isCancelTransaction in interface SIPTransaction
    
    Returns:
    -- true if the transaciton is a CANCEL transaction.
    See Also:
    SIPTransaction.isCancelTransaction()
  - isByeTransaction
```
public boolean isByeTransaction()
```
    Description copied from interface: SIPTransaction
    
    Return a flag that states if this is a BYE transaction.
    
    Specified by:
    
    isByeTransaction in interface SIPTransaction
    
    Returns:
    true if the transaciton is a BYE transaction.
    See Also:
    SIPTransaction.isByeTransaction()
  - getMessageChannel
```
public MessageChannel getMessageChannel()
```
    Description copied from interface: SIPTransaction
    
    Returns the message channel used for transmitting/receiving messages for this transaction. Made public in support of JAIN dual transaction model.
    
    Specified by:
    
    getMessageChannel in interface SIPTransaction
    
    Returns:
    Encapsulated MessageChannel.
    See Also:
    SIPTransaction.getMessageChannel()
  - setBranch
```
public void setBranch(String newBranch)
```
    Description copied from interface: SIPTransaction
    
    Sets the Via header branch parameter used to identify this transaction.
    
    Specified by:
    
    setBranch in interface SIPTransaction
    
    Parameters:
    newBranch - New string used as the branch for this transaction.
    See Also:
    SIPTransaction.setBranch(java.lang.String)
  - getBranch
```
public String getBranch()
```
    Description copied from interface: SIPTransaction
    
    Gets the current setting for the branch parameter of this transaction.
    
    Specified by:
    
    getBranch in interface SIPTransaction
    
    Returns:
    Branch parameter for this transaction.
    See Also:
    SIPTransaction.getBranch()
  - getMethod
```
public String getMethod()
```
    Description copied from interface: SIPTransaction
    
    Get the method of the request used to create this transaction.
    
    Specified by:
    
    getMethod in interface SIPTransaction
    
    Returns:
    the method of the request for the transaction.
    See Also:
    SIPTransaction.getMethod()
  - getCSeq
```
public long getCSeq()
```
    Description copied from interface: SIPTransaction
    
    Get the Sequence number of the request used to create the transaction.
    
    Specified by:
    
    getCSeq in interface SIPTransaction
    
    Returns:
    the cseq of the request used to create the transaction.
    See Also:
    SIPTransaction.getCSeq()
  - setState
```
public void setState(int newState)
```
    Description copied from interface: SIPTransaction
    
    Changes the state of this transaction.
    
    Specified by:
    
    setState in interface SIPTransaction
    
    Parameters:
    newState - New state of this transaction.
    See Also:
    SIPTransaction.setState(int)
  - getInternalState
```
public int getInternalState()
```
    Description copied from interface: SIPTransaction
    
    Gets the current state of this transaction.
    
    Specified by:
    
    getInternalState in interface SIPTransaction
    
    Returns:
    Current state of this transaction.
    See Also:
    SIPTransaction.getInternalState()
  - getState
```
public TransactionState getState()
```
    Description copied from interface: SIPTransaction
    
    Gets the current state of this transaction.
    
    Specified by:
    
    getState in interface SIPTransaction
    
    Specified by:
    
    getState in interface Transaction
    
    Returns:
    Current state of this transaction.
    See Also:
    SIPTransaction.getState()
  - enableRetransmissionTimer
```
protected void enableRetransmissionTimer()
```
    Enables retransmission timer events for this transaction to begin in one tick.
  - enableRetransmissionTimer
```
protected void enableRetransmissionTimer(int tickCount)
```
    Enables retransmission timer events for this transaction to begin after the number of ticks passed to this routine.
    
    Parameters:
    tickCount - Number of ticks before the next retransmission timer event occurs.
  - disableRetransmissionTimer
```
public void disableRetransmissionTimer()
```
    Description copied from interface: SIPTransaction
    
    Turns off retransmission events for this transaction.
    
    Specified by:
    
    disableRetransmissionTimer in interface SIPTransaction
    
    See Also:
    SIPTransaction.disableRetransmissionTimer()
  - enableTimeoutTimer
```
protected void enableTimeoutTimer(int tickCount)
```
    Enables a timeout event to occur for this transaction after the number of ticks passed to this method.
    
    Parameters:
    tickCount - Number of ticks before this transaction times out.
  - disableTimeoutTimer
```
public void disableTimeoutTimer()
```
    Description copied from interface: SIPTransaction
    
    Disabled the timeout timer.
    
    Specified by:
    
    disableTimeoutTimer in interface SIPTransaction
    
    See Also:
    SIPTransaction.disableTimeoutTimer()
  - fireTimer
```
public void fireTimer()
```
    Description copied from interface: SIPTransaction
    
    Fired after each timer tick. Checks the retransmission and timeout timers of this transaction, and fired these events if necessary.
    
    Specified by:
    
    fireTimer in interface SIPTransaction
    
    See Also:
    SIPTransaction.fireTimer()
  - isTerminated
```
public boolean isTerminated()
```
    Description copied from interface: SIPTransaction
    
    Tests if this transaction has terminated.
    
    Specified by:
    
    isTerminated in interface SIPTransaction
    
    Returns:
    Trus if this transaction is terminated, false if not.
    See Also:
    SIPTransaction.isTerminated()
  - getHost
```
public String getHost()
```
    Description copied from interface: TransactionExt
    
    return the ip address on which this message was initially received
    
    Specified by:
    
    getHost in interface SIPTransaction
    
    Specified by:
    
    getHost in interface TransactionExt
    
    Returns:
    the ip address on which this message was initially received
    See Also:
    SIPTransaction.getHost()
  - getKey
```
public String getKey()
```
    Specified by:
    
    getKey in interface SIPTransaction
    
    See Also:
    SIPTransaction.getKey()
  - getPort
```
public int getPort()
```
    Description copied from interface: TransactionExt
    
    return the port on which this message was initially received
    
    Specified by:
    
    getPort in interface SIPTransaction
    
    Specified by:
    
    getPort in interface TransactionExt
    
    Returns:
    the port on which this message was initially received
    See Also:
    SIPTransaction.getPort()
  - getSIPStack
```
public SIPTransactionStack getSIPStack()
```
    Specified by:
    
    getSIPStack in interface SIPTransaction
    
    See Also:
    SIPTransaction.getSIPStack()
  - getPeerAddress
```
public String getPeerAddress()
```
    Description copied from interface: TransactionExt
    
    Returns the IP address of the upstream/downstream hop from which this message was initially received
    
    Specified by:
    
    getPeerAddress in interface SIPTransaction
    
    Specified by:
    
    getPeerAddress in interface TransactionExt
    
    Returns:
    the IP address of the upstream/downstream hop from which this message was initially received
    See Also:
    SIPTransaction.getPeerAddress()
  - getPeerPort
```
public int getPeerPort()
```
    Description copied from interface: TransactionExt
    
    Returns the port of the upstream/downstream hop from which this message was initially received
    
    Specified by:
    
    getPeerPort in interface SIPTransaction
    
    Specified by:
    
    getPeerPort in interface TransactionExt
    
    Returns:
    the port of the upstream/downstream hop from which this message was initially received
    See Also:
    SIPTransaction.getPeerPort()
  - getPeerPacketSourcePort
```
public int getPeerPacketSourcePort()
```
    Specified by:
    
    getPeerPacketSourcePort in interface SIPTransaction
    
    See Also:
    SIPTransaction.getPeerPacketSourcePort()
  - getPeerPacketSourceAddress
```
public InetAddress getPeerPacketSourceAddress()
```
    Specified by:
    
    getPeerPacketSourceAddress in interface SIPTransaction
    
    See Also:
    SIPTransaction.getPeerPacketSourceAddress()
  - getPeerInetAddress
```
public InetAddress getPeerInetAddress()
```
  - getPeerProtocol
```
public String getPeerProtocol()
```
    Specified by:
    
    getPeerProtocol in interface SIPTransaction
  - getTransport
```
public String getTransport()
```
    Description copied from interface: TransactionExt
    
    Returns the name of the protocol with which this message was initially received
    
    Specified by:
    
    getTransport in interface SIPTransaction
    
    Specified by:
    
    getTransport in interface TransactionExt
    
    Returns:
    the name of the protocol with which this message was initially received
    See Also:
    SIPTransaction.getTransport()
  - isReliable
```
public boolean isReliable()
```
    Specified by:
    
    isReliable in interface SIPTransaction
    
    See Also:
    SIPTransaction.isReliable()
  - getViaHeader
```
public Via getViaHeader()
```
    Description copied from interface: SIPTransaction
    
    Returns the Via header for this channel. Gets the Via header of the underlying message channel, and adds a branch parameter to it for this transaction.
    
    Specified by:
    
    getViaHeader in interface SIPTransaction
    
    See Also:
    SIPTransaction.getViaHeader()
  - sendMessage
```
public void sendMessage(SIPMessage messageToSend)
                 throws IOException
```
    Description copied from interface: SIPTransaction
    
    Process the message through the transaction and sends it to the SIP peer.
    
    Specified by:
    
    sendMessage in interface SIPTransaction
    
    Parameters:
    messageToSend - Message to send to the SIP peer.
    
    Throws:
    
    IOException
    See Also:
    SIPTransaction.sendMessage(gov.nist.javax.sip.message.SIPMessage)
  - sendMessage
```
public void sendMessage(byte[] messageBytes,
               InetAddress receiverAddress,
               int receiverPort,
               boolean retry)
                 throws IOException
```
    Parse the byte array as a message, process it through the transaction, and send it to the SIP peer. This is just a placeholder method -- calling it will result in an IO exception.
    
    Parameters:
    messageBytes - Bytes of the message to send.
    receiverAddress - Address of the target peer.
    receiverPort - Network port of the target peer.
    
    Throws:
    
    IOException - If called.
  - addEventListener
```
public void addEventListener(SIPTransactionEventListener newListener)
```
    Description copied from interface: SIPTransaction
    
    Adds a new event listener to this transaction.
    
    Specified by:
    
    addEventListener in interface SIPTransaction
    
    Parameters:
    newListener - Listener to add.
    See Also:
    SIPTransaction.addEventListener(gov.nist.javax.sip.stack.SIPTransactionEventListener)
  - removeEventListener
```
public void removeEventListener(SIPTransactionEventListener oldListener)
```
    Description copied from interface: SIPTransaction
    
    Removed an event listener from this transaction.
    
    Specified by:
    
    removeEventListener in interface SIPTransaction
    
    Parameters:
    oldListener - Listener to remove.
    See Also:
    SIPTransaction.removeEventListener(gov.nist.javax.sip.stack.SIPTransactionEventListener)
  - raiseErrorEvent
```
public void raiseErrorEvent(int errorEventID)
```
    Description copied from interface: SIPTransaction
    
    Creates a SIPTransactionErrorEvent and sends it to all of the listeners of this transaction. This method also flags the transaction as terminated.
    
    Specified by:
    
    raiseErrorEvent in interface SIPTransaction
    
    Parameters:
    errorEventID - ID of the error to raise.
    See Also:
    SIPTransaction.raiseErrorEvent(int)
  - isServerTransaction
```
public boolean isServerTransaction()
```
    Description copied from interface: SIPTransaction
    
    A shortcut way of telling if we are a server transaction.
    
    Specified by:
    
    isServerTransaction in interface SIPTransaction
    
    See Also:
    SIPTransaction.isServerTransaction()
  - getDialog
```
public abstract Dialog getDialog()
```
    Description copied from interface: SIPTransaction
    
    Gets the dialog object of this Transaction object. This object returns null if no dialog exists. A dialog only exists for a transaction when a session is setup between a User Agent Client and a User Agent Server, either by a 1xx Provisional Response for an early dialog or a 200OK Response for a committed dialog.
    
    Specified by:
    
    getDialog in interface SIPTransaction
    
    Specified by:
    
    getDialog in interface Transaction
    
    Returns:
    the Dialog Object of this Transaction object.
    See Also:
    SIPTransaction.getDialog()
  - setDialog
```
public abstract void setDialog(SIPDialog sipDialog,
             String dialogId)
```
    Description copied from interface: SIPTransaction
    
    set the dialog object.
    
    Specified by:
    
    setDialog in interface SIPTransaction
    
    Parameters:
    sipDialog - -- the dialog to set.
    dialogId - -- the dialog id ot associate with the dialog.s
    See Also:
    SIPTransaction.setDialog(gov.nist.javax.sip.stack.SIPDialog, java.lang.String)
  - getRetransmitTimer
```
public int getRetransmitTimer()
```
    Description copied from interface: SIPTransaction
    
    Returns the current value of the retransmit timer in milliseconds used to retransmit messages over unreliable transports.
    
    Specified by:
    
    getRetransmitTimer in interface SIPTransaction
    
    Specified by:
    
    getRetransmitTimer in interface Transaction
    
    Returns:
    the integer value of the retransmit timer in milliseconds.
    See Also:
    SIPTransaction.getRetransmitTimer()
  - getViaHost
```
public String getViaHost()
```
    Description copied from interface: SIPTransaction
    
    Get the host to assign for an outgoing Request via header.
    
    Specified by:
    
    getViaHost in interface SIPTransaction
    
    See Also:
    SIPTransaction.getViaHost()
  - getLastResponse
```
public SIPResponse getLastResponse()
```
    Description copied from interface: SIPTransaction
    
    Get the last response. This is used internally by the implementation. Dont rely on it.
    
    Specified by:
    
    getLastResponse in interface SIPTransaction
    
    Returns:
    the last response received (for client transactions) or sent (for server transactions).
    See Also:
    SIPTransaction.getLastResponse()
  - getResponse
```
public Response getResponse()
```
    Description copied from interface: SIPTransaction
    
    Get the JAIN interface response
    
    Specified by:
    
    getResponse in interface SIPTransaction
    
    See Also:
    SIPTransaction.getResponse()
  - getTransactionId
```
public String getTransactionId()
```
    Description copied from interface: SIPTransaction
    
    Get the transaction Id.
    
    Specified by:
    
    getTransactionId in interface SIPTransaction
    
    See Also:
    SIPTransaction.getTransactionId()
  - hashCode
```
public int hashCode()
```
    Description copied from interface: SIPTransaction
    
    Hashcode method for fast hashtable lookup.
    
    Specified by:
    
    hashCode in interface SIPTransaction
    
    Overrides:
    
    hashCode in class Object
    
    See Also:
    SIPTransaction.hashCode()
  - getViaPort
```
public int getViaPort()
```
    Description copied from interface: SIPTransaction
    
    Get the port to assign for the via header of an outgoing message.
    
    Specified by:
    
    getViaPort in interface SIPTransaction
    
    See Also:
    SIPTransaction.getViaPort()
  - doesCancelMatchTransaction
```
public boolean doesCancelMatchTransaction(SIPRequest requestToTest)
```
    Description copied from interface: SIPTransaction
    
    A method that can be used to test if an incoming request belongs to this transction. This does not take the transaction state into account when doing the check otherwise it is identical to isMessagePartOfTransaction. This is useful for checking if a CANCEL belongs to this transaction.
    
    Specified by:
    
    doesCancelMatchTransaction in interface SIPTransaction
    
    Parameters:
    requestToTest - is the request to test.
    
    Returns:
    true if the the request belongs to the transaction.
    See Also:
    SIPTransaction.doesCancelMatchTransaction(gov.nist.javax.sip.message.SIPRequest)
  - setRetransmitTimer
```
public void setRetransmitTimer(int retransmitTimer)
```
    Description copied from interface: SIPTransaction
    
    Sets the value of the retransmit timer to the newly supplied timer value. The retransmit timer is expressed in milliseconds and its default value is 500ms. This method allows the application to change the transaction retransmit behavior for different networks. Take the gateway proxy as an example. The internal intranet is likely to be reatively uncongested and the endpoints will be relatively close. The external network is the general Internet. This functionality allows different retransmit times for either side.
    
    Specified by:
    
    setRetransmitTimer in interface SIPTransaction
    
    Specified by:
    
    setRetransmitTimer in interface Transaction
    
    Parameters:
    retransmitTimer - - the new integer value of the retransmit timer in milliseconds.
    See Also:
    SIPTransaction.setRetransmitTimer(int)
  - close
```
public void close()
```
    Description copied from interface: SIPTransaction
    
    Close the encapsulated channel.
    
    Specified by:
    
    close in interface SIPTransaction
    
    See Also:
    SIPTransaction.close()
  - isSecure
```
public boolean isSecure()
```
    Specified by:
    
    isSecure in interface SIPTransaction
    
    See Also:
    SIPTransaction.isSecure()
  - getMessageProcessor
```
public MessageProcessor getMessageProcessor()
```
    Specified by:
    
    getMessageProcessor in interface SIPTransaction
    
    See Also:
    SIPTransaction.getMessageProcessor()
  - setApplicationData
```
public void setApplicationData(Object applicationData)
```
    Description copied from interface: SIPTransaction
    
    Set the application data pointer. This is un-interpreted by the stack. This is provided as a conveniant way of keeping book-keeping data for applications. Note that null clears the application data pointer (releases it).
    
    Specified by:
    
    setApplicationData in interface SIPTransaction
    
    Specified by:
    
    setApplicationData in interface Transaction
    
    Parameters:
    applicationData - -- application data pointer to set. null clears the applicationd data pointer.
    See Also:
    SIPTransaction.setApplicationData(java.lang.Object)
  - getApplicationData
```
public Object getApplicationData()
```
    Description copied from interface: SIPTransaction
    
    Get the application data associated with this transaction.
    
    Specified by:
    
    getApplicationData in interface SIPTransaction
    
    Specified by:
    
    getApplicationData in interface Transaction
    
    Returns:
    stored application data.
    See Also:
    SIPTransaction.getApplicationData()
  - setEncapsulatedChannel
```
public void setEncapsulatedChannel(MessageChannel messageChannel)
```
    Description copied from interface: SIPTransaction
    
    Set the encapsuated channel. The peer inet address and port are set equal to the message channel.
    
    Specified by:
    
    setEncapsulatedChannel in interface SIPTransaction
    
    See Also:
    SIPTransaction.setEncapsulatedChannel(gov.nist.javax.sip.stack.MessageChannel)
  - getSipProvider
```
public SipProviderImpl getSipProvider()
```
    Description copied from interface: SIPTransaction
    
    Return the SipProvider for which the transaction is assigned.
    
    Specified by:
    
    getSipProvider in interface SIPTransaction
    
    Specified by:
    
    getSipProvider in interface TransactionExt
    
    Returns:
    the SipProvider for the transaction.
    See Also:
    SIPTransaction.getSipProvider()
  - raiseIOExceptionEvent
```
public void raiseIOExceptionEvent()
```
    Description copied from interface: SIPTransaction
    
    Raise an IO Exception event - this is used for reporting asynchronous IO Exceptions that are attributable to this transaction.
    
    Specified by:
    
    raiseIOExceptionEvent in interface SIPTransaction
    
    See Also:
    SIPTransaction.raiseIOExceptionEvent()
  - acquireSem
```
public boolean acquireSem()
```
    Description copied from interface: SIPTransaction
    
    A given tx can process only a single outstanding event at a time. This semaphore gaurds re-entrancy to the transaction.
    
    Specified by:
    
    acquireSem in interface SIPTransaction
    
    See Also:
    SIPTransaction.acquireSem()
  - releaseSem
```
public void releaseSem()
```
    Description copied from interface: SIPTransaction
    
    Release the transaction semaphore.
    
    Specified by:
    
    releaseSem in interface SIPTransaction
    
    See Also:
    SIPTransaction.releaseSem()
  - semRelease
```
public void semRelease()
```
    Specified by:
    
    semRelease in interface SIPTransaction
  - passToListener
```
public boolean passToListener()
```
    Description copied from interface: SIPTransaction
    
    Set true to pass the request up to the listener. False otherwise.
    
    Specified by:
    
    passToListener in interface SIPTransaction
    
    See Also:
    SIPTransaction.passToListener()
  - setPassToListener
```
public void setPassToListener()
```
    Description copied from interface: SIPTransaction
    
    Set the passToListener flag to true.
    
    Specified by:
    
    setPassToListener in interface SIPTransaction
    
    See Also:
    SIPTransaction.setPassToListener()
  - testAndSetTransactionTerminatedEvent
```
public boolean testAndSetTransactionTerminatedEvent()
```
    Description copied from interface: SIPTransaction
    
    Flag to test if the terminated event is delivered.
    
    Specified by:
    
    testAndSetTransactionTerminatedEvent in interface SIPTransaction
    
    Returns:
    See Also:
    SIPTransaction.testAndSetTransactionTerminatedEvent()
  - getCipherSuite
```
public String getCipherSuite()
                      throws UnsupportedOperationException
```
    Description copied from interface: TransactionExt
    
    Return the Cipher Suite that was used for the SSL handshake.
    
    Specified by:
    
    getCipherSuite in interface SIPTransaction
    
    Specified by:
    
    getCipherSuite in interface TransactionExt
    
    Returns:
    Returns the cipher suite in use by the session which was produced by the handshake.
    
    Throws:
    
    UnsupportedOperationException
    See Also:
    SIPTransaction.getCipherSuite()
  - getLocalCertificates
```
public Certificate[] getLocalCertificates()
                                   throws UnsupportedOperationException
```
    Description copied from interface: TransactionExt
    
    Get the certificate(s) that were sent to the peer during handshaking.
    
    Specified by:
    
    getLocalCertificates in interface SIPTransaction
    
    Specified by:
    
    getLocalCertificates in interface TransactionExt
    
    Returns:
    the certificate(s) that were sent to the peer during handshaking.
    
    Throws:
    
    UnsupportedOperationException
    See Also:
    SIPTransaction.getLocalCertificates()
  - getPeerCertificates
```
public Certificate[] getPeerCertificates()
                                  throws SSLPeerUnverifiedException
```
    Specified by:
    
    getPeerCertificates in interface SIPTransaction
    
    Specified by:
    
    getPeerCertificates in interface TransactionExt
    
    Returns:
    the identity of the peer which was identified as part of defining the session.
    
    Throws:
    
    SSLPeerUnverifiedException
    See Also:
    SIPTransaction.getPeerCertificates()
  - extractCertIdentities
```
public List<String> extractCertIdentities()
                                   throws SSLPeerUnverifiedException
```
    Description copied from interface: SIPTransaction
    
    Extract identities from certificates exchanged over TLS, based on guidelines from rfc5922.
    
    Specified by:
    
    extractCertIdentities in interface SIPTransaction
    
    Specified by:
    
    extractCertIdentities in interface TransactionExt
    
    Returns:
    list of authenticated identities
    
    Throws:
    
    SSLPeerUnverifiedException
    See Also:
    SIPTransaction.extractCertIdentities()
  - isMessagePartOfTransaction
```
public abstract boolean isMessagePartOfTransaction(SIPMessage messageToTest)
```
    Description copied from interface: SIPTransaction
    
    Tests a message to see if it is part of this transaction.
    
    Specified by:
    
    isMessagePartOfTransaction in interface SIPTransaction
    
    Returns:
    True if the message is part of this transaction, false if not.
    See Also:
    SIPTransaction.isMessagePartOfTransaction(gov.nist.javax.sip.message.SIPMessage)
  - isReleaseReferences
```
public boolean isReleaseReferences()
```
    Description copied from interface: TransactionExt
    
    retrieve the value of release references to know if the stack performs optimizations on cleanup to save on memory
    
    Specified by:
    
    isReleaseReferences in interface SIPTransaction
    
    Specified by:
    
    isReleaseReferences in interface TransactionExt
    
    Returns:
    release references value
    See Also:
    SIPTransaction.isReleaseReferences()
  - setReleaseReferences
```
public void setReleaseReferences(boolean releaseReferences)
```
    Description copied from interface: TransactionExt
    
    If set to true it will release all references that it no longer needs. This will include the reference to the Request, Response, Dialogs, Any unused timers etc. This will significantly reduce memory consumption under high load
    
    Specified by:
    
    setReleaseReferences in interface SIPTransaction
    
    Specified by:
    
    setReleaseReferences in interface TransactionExt
    
    See Also:
    SIPTransaction.setReleaseReferences(boolean)
  - getTimerD
```
public int getTimerD()
```
    Description copied from interface: TransactionExt
    
    Sets the value of Timer D (in ms)
    
    Specified by:
    
    getTimerD in interface SIPTransaction
    
    Specified by:
    
    getTimerD in interface TransactionExt
    
    See Also:
    SIPTransaction.getTimerD()
  - getTimerT2
```
public int getTimerT2()
```
    Description copied from interface: TransactionExt
    
    Retrieve the value of Timer T2 (in ms)
    
    Specified by:
    
    getTimerT2 in interface SIPTransaction
    
    Specified by:
    
    getTimerT2 in interface TransactionExt
    
    Returns:
    T2 value (in ms)
    See Also:
    SIPTransaction.getTimerT2()
  - getTimerT4
```
public int getTimerT4()
```
    Description copied from interface: TransactionExt
    
    Retrieve the value of Timer T4 (in ms)
    
    Specified by:
    
    getTimerT4 in interface SIPTransaction
    
    Specified by:
    
    getTimerT4 in interface TransactionExt
    
    Returns:
    T4 value (in ms)
    See Also:
    SIPTransaction.getTimerT4()
  - setTimerD
```
public void setTimerD(int interval)
```
    Description copied from interface: TransactionExt
    
    Sets the value of Timer D (in ms)
    
    Specified by:
    
    setTimerD in interface SIPTransaction
    
    Specified by:
    
    setTimerD in interface TransactionExt
    
    Parameters:
    interval - value of Timer D (in ms)
    See Also:
    SIPTransaction.setTimerD(int)
  - setTimerT2
```
public void setTimerT2(int interval)
```
    Description copied from interface: TransactionExt
    
    Sets the value of Timer T2 (in ms)
    
    Specified by:
    
    setTimerT2 in interface SIPTransaction
    
    Specified by:
    
    setTimerT2 in interface TransactionExt
    
    Parameters:
    interval - value of Timer T2 (in ms)
    See Also:
    SIPTransaction.setTimerT2(int)
  - setTimerT4
```
public void setTimerT4(int interval)
```
    Description copied from interface: TransactionExt
    
    Sets the value of Timer T4 (in ms)
    
    Specified by:
    
    setTimerT4 in interface SIPTransaction
    
    Specified by:
    
    setTimerT4 in interface TransactionExt
    
    Parameters:
    interval - value of Timer T4 (in ms)
    See Also:
    SIPTransaction.setTimerT4(int)
  - getBaseTimerInterval
```
public int getBaseTimerInterval()
```
    Specified by:
    
    getBaseTimerInterval in interface SIPTransaction
    
    See Also:
    SIPTransaction.getBaseTimerInterval()
  - getT4
```
public int getT4()
```
    Specified by:
    
    getT4 in interface SIPTransaction
    
    See Also:
    SIPTransaction.getT4()
  - getT2
```
public int getT2()
```
    Specified by:
    
    getT2 in interface SIPTransaction
    
    See Also:
    SIPTransaction.getT2()
  - getTimerI
```
public int getTimerI()
```
    Specified by:
    
    getTimerI in interface SIPTransaction
    
    See Also:
    SIPTransaction.getTimerI()
  - getTimerK
```
public int getTimerK()
```
    Specified by:
    
    getTimerK in interface SIPTransaction
    
    See Also:
    SIPTransaction.getTimerK()
  - setForkId
```
public void setForkId(String forkId)
```
    Description copied from interface: SIPTransaction
    
    Sets the fork id for the transaction.
    
    Specified by:
    
    setForkId in interface SIPTransaction
    
    See Also:
    SIPTransaction.setForkId(java.lang.String)
  - getForkId
```
public String getForkId()
```
    Description copied from interface: SIPTransaction
    
    Retrieves the fork id for the transaction.
    
    Specified by:
    
    getForkId in interface SIPTransaction
    
    Returns:
    See Also:
    SIPTransaction.getForkId()
  - scheduleMaxTxLifeTimeTimer
```
public void scheduleMaxTxLifeTimeTimer()
```
    Specified by:
    
    scheduleMaxTxLifeTimeTimer in interface SIPTransaction
    
    See Also:
    SIPTransaction.scheduleMaxTxLifeTimeTimer()
  - cancelMaxTxLifeTimeTimer
```
public void cancelMaxTxLifeTimeTimer()
```
    Specified by:
    
    cancelMaxTxLifeTimeTimer in interface SIPTransaction
    
    See Also:
    SIPTransaction.cancelMaxTxLifeTimeTimer()
  - getMergeId
```
public String getMergeId()
```
    Specified by:
    
    getMergeId in interface SIPTransaction
    
    Returns:
    the mergeId
    See Also:
    SIPTransaction.getMergeId()
  - getAuditTag
```
public long getAuditTag()
```
    Specified by:
    
    getAuditTag in interface SIPTransaction
    
    See Also:
    SIPTransaction.getAuditTag()
  - setAuditTag
```
public void setAuditTag(long auditTag)
```
    Specified by:
    
    setAuditTag in interface SIPTransaction
    
    See Also:
    SIPTransaction.setAuditTag(long)
  - isTransactionMapped
```
public boolean isTransactionMapped()
```
    Specified by:
    
    isTransactionMapped in interface SIPTransaction
    
    See Also:
    SIPServerTransaction.isTransactionMapped()
  - setTransactionMapped
```
public void setTransactionMapped(boolean transactionMapped)
```
    Specified by:
    
    setTransactionMapped in interface SIPTransaction
    
    See Also:
    SIPServerTransaction.setTransactionMapped(boolean)
  - setCollectionTime
```
public void setCollectionTime(int collectionTime)
```
    Specified by:
    
    setCollectionTime in interface SIPTransaction
    
    See Also:
    SIPTransaction.setCollectionTime(int)

Class SIPTransactionImpl

Field Summary

Fields inherited from interface gov.nist.javax.sip.stack.SIPTransaction

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface gov.nist.javax.sip.stack.SIPTransaction

Methods inherited from interface javax.sip.Transaction

Field Detail

toListener

baseTimerInterval

T4

T2

timerI

timerK

timerD

applicationData

lastResponse

isMapped

transactionId

auditTag

sipStack

originalRequest

originalRequestBytes

originalRequestCSeqNumber

originalRequestBranch

originalRequestHasPort

encapsulatedChannel

transactionTimerStarted

timeoutTimerTicksLeft

collectionTime

mergeId

expiresTimerTask

Constructor Detail

SIPTransactionImpl

Method Detail

getBranchId

cleanUp

setOriginalRequest

getOriginalRequest

getRequest

isDialogCreatingTransaction

isInviteTransaction

isCancelTransaction

isByeTransaction

getMessageChannel

setBranch

getBranch

getMethod

getCSeq

setState

getInternalState

getState

enableRetransmissionTimer

enableRetransmissionTimer

disableRetransmissionTimer

enableTimeoutTimer

disableTimeoutTimer

fireTimer

isTerminated

getHost

getKey

getPort

getSIPStack

getPeerAddress

getPeerPort

getPeerPacketSourcePort

getPeerPacketSourceAddress

getPeerInetAddress

getPeerProtocol

getTransport

isReliable

getViaHeader

sendMessage

sendMessage

addEventListener

removeEventListener

raiseErrorEvent

isServerTransaction

getDialog