SIPTransaction (jain-sip-ri 1.2.219 API)

All Superinterfaces:

Serializable, Transaction, TransactionExt

All Known Subinterfaces:

SIPClientTransaction, SIPServerTransaction

All Known Implementing Classes:

SIPClientTransactionImpl, SIPServerTransactionImpl, SIPTransactionImpl
```
public interface SIPTransaction
extends TransactionExt
```

Field Summary

Fields
Modifier and Type	Field and Description
`static TransactionState`	`CALLING_STATE` CALLING State.
`static TransactionState`	`COMPLETED_STATE` Completed state.
`static TransactionState`	`CONFIRMED_STATE` Confirmed state.
`static TransactionState`	`INITIAL_STATE` Initialized but no state assigned.
`static TransactionState`	`PROCEEDING_STATE` Proceeding state.
`static int`	`T1` One timer tick.
`static TransactionState`	`TERMINATED_STATE` Terminated state.
`static int`	`TIMER_A` INVITE request retransmit interval, for UDP only
`static int`	`TIMER_B` INVITE transaction timeout timer
`static int`	`TIMER_F`
`static int`	`TIMER_H`
`static int`	`TIMER_J`
`static TransactionState`	`TRYING_STATE` Trying state.

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()`
`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.
`List<String>`	`extractCertIdentities()` Extract identities from certificates exchanged over TLS, based on guidelines from rfc5922.
`void`	`fireRetransmissionTimer()` Called by the transaction stack when a retransmission timer fires.
`void`	`fireTimeoutTimer()` This method is called when this transaction's timeout timer has fired.
`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.
`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`	`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.
`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(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)`
`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)`
`void`	`startTransactionTimer()` Start the timer that runs the transaction state machine.
`boolean`	`testAndSetTransactionTerminatedEvent()` Flag to test if the terminated event is delivered.

Methods inherited from interface javax.sip.Transaction
terminate

- Field Detail
  - T1
```
static final int T1
```
    One timer tick.
    
    See Also:
    Constant Field Values
  - TIMER_A
```
static final int TIMER_A
```
    INVITE request retransmit interval, for UDP only
    
    See Also:
    Constant Field Values
  - TIMER_B
```
static final int TIMER_B
```
    INVITE transaction timeout timer
    
    See Also:
    Constant Field Values
  - TIMER_J
```
static final int TIMER_J
```
    See Also:
    Constant Field Values
  - TIMER_F
```
static final int TIMER_F
```
    See Also:
    Constant Field Values
  - TIMER_H
```
static final int TIMER_H
```
    See Also:
    Constant Field Values
  - INITIAL_STATE
```
static final TransactionState INITIAL_STATE
```
    Initialized but no state assigned.
  - TRYING_STATE
```
static final TransactionState TRYING_STATE
```
    Trying state.
  - CALLING_STATE
```
static final TransactionState CALLING_STATE
```
    CALLING State.
  - PROCEEDING_STATE
```
static final TransactionState PROCEEDING_STATE
```
    Proceeding state.
  - COMPLETED_STATE
```
static final TransactionState COMPLETED_STATE
```
    Completed state.
  - CONFIRMED_STATE
```
static final TransactionState CONFIRMED_STATE
```
    Confirmed state.
  - TERMINATED_STATE
```
static final TransactionState TERMINATED_STATE
```
    Terminated state.
- Method Detail
  - getBranchId
```
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 Transaction
    
    Returns:
    the new branch that uniquely identifies this transaction.
  - cleanUp
```
void cleanUp()
```
  - setOriginalRequest
```
void setOriginalRequest(SIPRequest newOriginalRequest)
```
    Sets the request message that this transaction handles.
    
    Parameters:
    newOriginalRequest - Request being handled.
  - getOriginalRequest
```
SIPRequest getOriginalRequest()
```
    Gets the request being handled by this transaction.
    
    Returns:
    -- the original Request associated with this transaction.
  - getRequest
```
Request getRequest()
```
    Get the original request but cast to a Request structure.
    
    Specified by:
    
    getRequest in interface Transaction
    
    Returns:
    the request that generated this transaction.
  - isDialogCreatingTransaction
```
boolean isDialogCreatingTransaction()
```
    Returns a flag stating whether this transaction is for a request that creates a dialog.
    
    Returns:
    -- true if this is a request that creates a dialog, false if not.
  - isInviteTransaction
```
boolean isInviteTransaction()
```
    Returns a flag stating whether this transaction is for an INVITE request or not.
    
    Returns:
    -- true if this is an INVITE request, false if not.
  - isCancelTransaction
```
boolean isCancelTransaction()
```
    Return true if the transaction corresponds to a CANCEL message.
    
    Returns:
    -- true if the transaciton is a CANCEL transaction.
  - isByeTransaction
```
boolean isByeTransaction()
```
    Return a flag that states if this is a BYE transaction.
    
    Returns:
    true if the transaciton is a BYE transaction.
  - getMessageChannel
```
MessageChannel getMessageChannel()
```
    Returns the message channel used for transmitting/receiving messages for this transaction. Made public in support of JAIN dual transaction model.
    
    Returns:
    Encapsulated MessageChannel.
  - setBranch
```
void setBranch(String newBranch)
```
    Sets the Via header branch parameter used to identify this transaction.
    
    Parameters:
    newBranch - New string used as the branch for this transaction.
  - getBranch
```
String getBranch()
```
    Gets the current setting for the branch parameter of this transaction.
    
    Returns:
    Branch parameter for this transaction.
  - getMethod
```
String getMethod()
```
    Get the method of the request used to create this transaction.
    
    Returns:
    the method of the request for the transaction.
  - getCSeq
```
long getCSeq()
```
    Get the Sequence number of the request used to create the transaction.
    
    Returns:
    the cseq of the request used to create the transaction.
  - setState
```
void setState(int newState)
```
    Changes the state of this transaction.
    
    Parameters:
    newState - New state of this transaction.
  - getInternalState
```
int getInternalState()
```
    Gets the current state of this transaction.
    
    Returns:
    Current state of this transaction.
  - getState
```
TransactionState getState()
```
    Gets the current state of this transaction.
    
    Specified by:
    
    getState in interface Transaction
    
    Returns:
    Current state of this transaction.
  - isTerminated
```
boolean isTerminated()
```
    Tests if this transaction has terminated.
    
    Returns:
    Trus if this transaction is terminated, false if not.
  - getHost
```
String getHost()
```
    Description copied from interface: TransactionExt
    
    return the ip address on which this message was initially received
    
    Specified by:
    
    getHost in interface TransactionExt
    
    Returns:
    the ip address on which this message was initially received
  - getKey
```
String getKey()
```
  - getPort
```
int getPort()
```
    Description copied from interface: TransactionExt
    
    return the port on which this message was initially received
    
    Specified by:
    
    getPort in interface TransactionExt
    
    Returns:
    the port on which this message was initially received
  - getSIPStack
```
SIPTransactionStack getSIPStack()
```
  - getPeerAddress
```
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 TransactionExt
    
    Returns:
    the IP address of the upstream/downstream hop from which this message was initially received
  - getPeerPort
```
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 TransactionExt
    
    Returns:
    the port of the upstream/downstream hop from which this message was initially received
  - getPeerProtocol
```
String getPeerProtocol()
```
  - getPeerPacketSourcePort
```
int getPeerPacketSourcePort()
```
  - getPeerPacketSourceAddress
```
InetAddress getPeerPacketSourceAddress()
```
  - getTransport
```
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 TransactionExt
    
    Returns:
    the name of the protocol with which this message was initially received
  - isReliable
```
boolean isReliable()
```
  - getViaHeader
```
Via getViaHeader()
```
    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.
  - sendMessage
```
void sendMessage(SIPMessage messageToSend)
                 throws IOException
```
    Process the message through the transaction and sends it to the SIP peer.
    
    Parameters:
    messageToSend - Message to send to the SIP peer.
    
    Throws:
    
    IOException
  - addEventListener
```
void addEventListener(SIPTransactionEventListener newListener)
```
    Adds a new event listener to this transaction.
    
    Parameters:
    newListener - Listener to add.
  - removeEventListener
```
void removeEventListener(SIPTransactionEventListener oldListener)
```
    Removed an event listener from this transaction.
    
    Parameters:
    oldListener - Listener to remove.
  - getDialog
```
Dialog getDialog()
```
    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 Transaction
    
    Returns:
    the Dialog Object of this Transaction object.
    See Also:
    Dialog
  - setDialog
```
void setDialog(SIPDialog sipDialog,
             String dialogId)
```
    set the dialog object.
    
    Parameters:
    sipDialog - -- the dialog to set.
    dialogId - -- the dialog id ot associate with the dialog.s
  - getRetransmitTimer
```
int getRetransmitTimer()
```
    Returns the current value of the retransmit timer in milliseconds used to retransmit messages over unreliable transports.
    
    Specified by:
    
    getRetransmitTimer in interface Transaction
    
    Returns:
    the integer value of the retransmit timer in milliseconds.
  - getViaHost
```
String getViaHost()
```
    Get the host to assign for an outgoing Request via header.
  - getLastResponse
```
SIPResponse getLastResponse()
```
    Get the last response. This is used internally by the implementation. Dont rely on it.
    
    Returns:
    the last response received (for client transactions) or sent (for server transactions).
  - getResponse
```
Response getResponse()
```
    Get the JAIN interface response
  - getTransactionId
```
String getTransactionId()
```
    Get the transaction Id.
  - hashCode
```
int hashCode()
```
    Hashcode method for fast hashtable lookup.
    
    Overrides:
    
    hashCode in class Object
  - getViaPort
```
int getViaPort()
```
    Get the port to assign for the via header of an outgoing message.
  - doesCancelMatchTransaction
```
boolean doesCancelMatchTransaction(SIPRequest requestToTest)
```
    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.
    
    Parameters:
    requestToTest - is the request to test.
    
    Returns:
    true if the the request belongs to the transaction.
  - setRetransmitTimer
```
void setRetransmitTimer(int retransmitTimer)
```
    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 Transaction
    
    Parameters:
    retransmitTimer - - the new integer value of the retransmit timer in milliseconds.
  - close
```
void close()
```
    Close the encapsulated channel.
  - isSecure
```
boolean isSecure()
```
  - getMessageProcessor
```
MessageProcessor getMessageProcessor()
```
  - setApplicationData
```
void setApplicationData(Object applicationData)
```
    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 Transaction
    
    Parameters:
    applicationData - -- application data pointer to set. null clears the applicationd data pointer.
  - getApplicationData
```
Object getApplicationData()
```
    Get the application data associated with this transaction.
    
    Specified by:
    
    getApplicationData in interface Transaction
    
    Returns:
    stored application data.
  - setEncapsulatedChannel
```
void setEncapsulatedChannel(MessageChannel messageChannel)
```
    Set the encapsuated channel. The peer inet address and port are set equal to the message channel.
  - getSipProvider
```
SipProviderImpl getSipProvider()
```
    Return the SipProvider for which the transaction is assigned.
    
    Specified by:
    
    getSipProvider in interface TransactionExt
    
    Returns:
    the SipProvider for the transaction.
  - raiseIOExceptionEvent
```
void raiseIOExceptionEvent()
```
    Raise an IO Exception event - this is used for reporting asynchronous IO Exceptions that are attributable to this transaction.
  - acquireSem
```
boolean acquireSem()
```
    A given tx can process only a single outstanding event at a time. This semaphore gaurds re-entrancy to the transaction.
  - releaseSem
```
void releaseSem()
```
    Release the transaction semaphore.
  - passToListener
```
boolean passToListener()
```
    Set true to pass the request up to the listener. False otherwise.
  - setPassToListener
```
void setPassToListener()
```
    Set the passToListener flag to true.
  - getCipherSuite
```
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 TransactionExt
    
    Returns:
    Returns the cipher suite in use by the session which was produced by the handshake.
    
    Throws:
    
    UnsupportedOperationException
  - getLocalCertificates
```
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 TransactionExt
    
    Returns:
    the certificate(s) that were sent to the peer during handshaking.
    
    Throws:
    
    UnsupportedOperationException
  - getPeerCertificates
```
Certificate[] getPeerCertificates()
                                  throws SSLPeerUnverifiedException
```
    Specified by:
    
    getPeerCertificates in interface TransactionExt
    
    Returns:
    the identity of the peer which was identified as part of defining the session.
    
    Throws:
    
    SSLPeerUnverifiedException
  - extractCertIdentities
```
List<String> extractCertIdentities()
                                   throws SSLPeerUnverifiedException
```
    Extract identities from certificates exchanged over TLS, based on guidelines from rfc5922.
    
    Specified by:
    
    extractCertIdentities in interface TransactionExt
    
    Returns:
    list of authenticated identities
    
    Throws:
    
    SSLPeerUnverifiedException
  - isMessagePartOfTransaction
```
boolean isMessagePartOfTransaction(SIPMessage messageToTest)
```
    Tests a message to see if it is part of this transaction.
    
    Returns:
    True if the message is part of this transaction, false if not.
  - isReleaseReferences
```
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 TransactionExt
    
    Returns:
    release references value
  - setReleaseReferences
```
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 TransactionExt
  - getTimerD
```
int getTimerD()
```
    Description copied from interface: TransactionExt
    
    Sets the value of Timer D (in ms)
    
    Specified by:
    
    getTimerD in interface TransactionExt
  - getTimerT2
```
int getTimerT2()
```
    Description copied from interface: TransactionExt
    
    Retrieve the value of Timer T2 (in ms)
    
    Specified by:
    
    getTimerT2 in interface TransactionExt
    
    Returns:
    T2 value (in ms)
  - getTimerT4
```
int getTimerT4()
```
    Description copied from interface: TransactionExt
    
    Retrieve the value of Timer T4 (in ms)
    
    Specified by:
    
    getTimerT4 in interface TransactionExt
    
    Returns:
    T4 value (in ms)
  - setTimerD
```
void setTimerD(int interval)
```
    Description copied from interface: TransactionExt
    
    Sets the value of Timer D (in ms)
    
    Specified by:
    
    setTimerD in interface TransactionExt
    
    Parameters:
    interval - value of Timer D (in ms)
  - setTimerT2
```
void setTimerT2(int interval)
```
    Description copied from interface: TransactionExt
    
    Sets the value of Timer T2 (in ms)
    
    Specified by:
    
    setTimerT2 in interface TransactionExt
    
    Parameters:
    interval - value of Timer T2 (in ms)
  - setTimerT4
```
void setTimerT4(int interval)
```
    Description copied from interface: TransactionExt
    
    Sets the value of Timer T4 (in ms)
    
    Specified by:
    
    setTimerT4 in interface TransactionExt
    
    Parameters:
    interval - value of Timer T4 (in ms)
  - setForkId
```
void setForkId(String forkId)
```
    Sets the fork id for the transaction.
    
    Parameters:
    forkId -
  - getForkId
```
String getForkId()
```
    Retrieves the fork id for the transaction.
    
    Returns:
  - cancelMaxTxLifeTimeTimer
```
void cancelMaxTxLifeTimeTimer()
```
  - getMergeId
```
String getMergeId()
```
    Returns:
    the mergeId
  - getAuditTag
```
long getAuditTag()
```
  - setAuditTag
```
void setAuditTag(long auditTag)
```
  - semRelease
```
void semRelease()
```
  - isTransactionMapped
```
boolean isTransactionMapped()
```
  - setTransactionMapped
```
void setTransactionMapped(boolean transactionMapped)
```
  - fireTimeoutTimer
```
void fireTimeoutTimer()
```
    This method is called when this transaction's timeout timer has fired.
  - raiseErrorEvent
```
void raiseErrorEvent(int errorEventID)
```
    Creates a SIPTransactionErrorEvent and sends it to all of the listeners of this transaction. This method also flags the transaction as terminated.
    
    Parameters:
    errorEventID - ID of the error to raise.
  - fireTimer
```
void fireTimer()
```
    Fired after each timer tick. Checks the retransmission and timeout timers of this transaction, and fired these events if necessary.
  - isServerTransaction
```
boolean isServerTransaction()
```
    A shortcut way of telling if we are a server transaction.
  - startTransactionTimer
```
void startTransactionTimer()
```
    Start the timer that runs the transaction state machine.
  - fireRetransmissionTimer
```
void fireRetransmissionTimer()
```
    Called by the transaction stack when a retransmission timer fires. This retransmits the last response when the retransmission filter is enabled.
  - testAndSetTransactionTerminatedEvent
```
boolean testAndSetTransactionTerminatedEvent()
```
    Flag to test if the terminated event is delivered.
    
    Returns:
  - scheduleMaxTxLifeTimeTimer
```
void scheduleMaxTxLifeTimeTimer()
```
  - setCollectionTime
```
void setCollectionTime(int collectionTime)
```
  - disableRetransmissionTimer
```
void disableRetransmissionTimer()
```
    Turns off retransmission events for this transaction.
  - disableTimeoutTimer
```
void disableTimeoutTimer()
```
    Disabled the timeout timer.
  - getTimerK
```
int getTimerK()
```
  - getTimerI
```
int getTimerI()
```
  - getT2
```
int getT2()
```
  - getT4
```
int getT4()
```
  - getBaseTimerInterval
```
int getBaseTimerInterval()
```

Interface SIPTransaction

Field Summary

Method Summary

Methods inherited from interface javax.sip.Transaction

Field Detail

T1

TIMER_A

TIMER_B

TIMER_J

TIMER_F

TIMER_H

INITIAL_STATE

TRYING_STATE

CALLING_STATE

PROCEEDING_STATE

COMPLETED_STATE

CONFIRMED_STATE

TERMINATED_STATE

Method Detail

getBranchId

cleanUp

setOriginalRequest

getOriginalRequest

getRequest

isDialogCreatingTransaction

isInviteTransaction

isCancelTransaction

isByeTransaction

getMessageChannel

setBranch

getBranch

getMethod

getCSeq

setState

getInternalState

getState

isTerminated

getHost

getKey

getPort

getSIPStack

getPeerAddress

getPeerPort

getPeerProtocol

getPeerPacketSourcePort

getPeerPacketSourceAddress

getTransport

isReliable

getViaHeader

sendMessage

addEventListener

removeEventListener

getDialog

setDialog

getRetransmitTimer

getViaHost

getLastResponse

getResponse

getTransactionId

hashCode

getViaPort

doesCancelMatchTransaction

setRetransmitTimer

close

isSecure

getMessageProcessor

setApplicationData

getApplicationData

setEncapsulatedChannel

getSipProvider

raiseIOExceptionEvent

acquireSem

releaseSem

passToListener

setPassToListener

getCipherSuite

getLocalCertificates

getPeerCertificates

extractCertIdentities

isMessagePartOfTransaction