javax.sip
Class TransactionTerminatedEvent

java.lang.Object
  java.util.EventObject
      javax.sip.TransactionTerminatedEvent

All Implemented Interfaces:

java.io.Serializable

public class TransactionTerminatedEvent
extends java.util.EventObject

TransactionTerminatedEvent is delivered to the Listener when the transaction transitions to the terminated state. An implementation is expected to deliver this event to the listener when it discards all internal book keeping records for a given transaction - thereby allowing the Listener to unmap its own data structures.

Since:

v1.2

Author:

BEA Systems, NIST

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

TransactionTerminatedEvent(java.lang.Object source, ClientTransaction clientTransaction)
Constructs a TransactionTerminatedEvent to indicate a client retransmission or transaction timeout.

TransactionTerminatedEvent(java.lang.Object source, ServerTransaction serverTransaction)
Constructs a TransactionTerminatedEvent to indicate a server retransmission or transaction timeout.

Method Summary

ClientTransaction	getClientTransaction() Gets the client transaction associated with this TransactionTerminatedEvent.
ServerTransaction	getServerTransaction() Gets the server transaction associated with this TransactionTerminatedEvent.
boolean	isServerTransaction() Indicates if the transaction associated with this TransactionTerminatedEvent is a server transaction.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TransactionTerminatedEvent

public TransactionTerminatedEvent(java.lang.Object source,
                                  ServerTransaction serverTransaction)

Constructs a TransactionTerminatedEvent to indicate a server retransmission or transaction timeout.

Parameters:

source - - the source of TransactionTerminatedEvent (the SipProvider associated with the transaction).

serverTransaction - - the server transaction that timed out.

TransactionTerminatedEvent

public TransactionTerminatedEvent(java.lang.Object source,
                                  ClientTransaction clientTransaction)

Constructs a TransactionTerminatedEvent to indicate a client retransmission or transaction timeout.

Parameters:

source - - source of TransactionTerminatedEvent (the SipProvider associated with the transaction).

clientTransaction - - the client transaction that timed out.

Method Detail

getServerTransaction

public ServerTransaction getServerTransaction()

Gets the server transaction associated with this TransactionTerminatedEvent.

Returns:

server transaction associated with this TransactionTerminatedEvent, or null if this event is specific to a client transaction.

getClientTransaction

public ClientTransaction getClientTransaction()

Gets the client transaction associated with this TransactionTerminatedEvent.

Returns:

client transaction associated with this TransactionTerminatedEvent, or null if this event is specific to a server transaction.

isServerTransaction

public boolean isServerTransaction()

Indicates if the transaction associated with this TransactionTerminatedEvent is a server transaction.

Returns:

returns true if a server transaction or false if a client transaction.