JSIP API v1.2
November 2006

javax.sip
Class TransactionState

java.lang.Object
  extended by javax.sip.TransactionState
All Implemented Interfaces:
java.io.Serializable

public final class TransactionState
extends java.lang.Object
implements java.io.Serializable

This class contains the enumerations that define the underlying state of an existing transaction. SIP defines four types of transactions, these are Invite Client transactions, Invite Server transactions, Non-Invite Client transactions and Non-Invite Server transactions. There are six explicit states for the various transactions, namely:

For each specific transaction state machine, refer to RFC3261.

Author:
BEA Systems, NIST
See Also:
Serialized Form

Field Summary
static int _CALLING
          This constant value indicates the internal value of the "Calling" constant.
static int _COMPLETED
          This constant value indicates the internal value of the "Completed" constant.
static int _CONFIRMED
          This constant value indicates the internal value of the "Confirmed" constant.
static int _PROCEEDING
          This constant value indicates the internal value of the "Proceeding" constant.
static int _TERMINATED
          This constant value indicates the internal value of the "Terminated" constant.
static int _TRYING
          This constant value indicates the internal value of the "Trying" constant.
static TransactionState CALLING
          This constant value indicates that the transaction state is "Calling".
static TransactionState COMPLETED
          This constant value indicates that the transaction state is "Completed".
static TransactionState CONFIRMED
          This constant value indicates that the transaction state is "Confirmed".
static TransactionState PROCEEDING
          This constant value indicates that the transaction state is "Proceeding".
static TransactionState TERMINATED
          This constant value indicates that the transaction state is "Terminated".
static TransactionState TRYING
          This constant value indicates that the transaction state is "Trying".
 
Method Summary
 boolean equals(java.lang.Object obj)
          Compare this transaction state for equality with another.
static TransactionState getObject(int transactionState)
          This method returns the object value of the TransactionState
 int getValue()
          This method returns the integer value of the TransactionState
 int hashCode()
          Get a hash code value for this transaction state.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

_CALLING

public static final int _CALLING
This constant value indicates the internal value of the "Calling" constant.
This constant has an integer value of 0.

See Also:
Constant Field Values

CALLING

public static final TransactionState CALLING
This constant value indicates that the transaction state is "Calling".


_TRYING

public static final int _TRYING
This constant value indicates the internal value of the "Trying" constant. This constant has an integer value of 1.

See Also:
Constant Field Values

TRYING

public static final TransactionState TRYING
This constant value indicates that the transaction state is "Trying".


_PROCEEDING

public static final int _PROCEEDING
This constant value indicates the internal value of the "Proceeding" constant.
This constant has an integer value of 2.

See Also:
Constant Field Values

PROCEEDING

public static final TransactionState PROCEEDING
This constant value indicates that the transaction state is "Proceeding".


_COMPLETED

public static final int _COMPLETED
This constant value indicates the internal value of the "Completed" constant.
This constant has an integer value of 3.

See Also:
Constant Field Values

COMPLETED

public static final TransactionState COMPLETED
This constant value indicates that the transaction state is "Completed".


_CONFIRMED

public static final int _CONFIRMED
This constant value indicates the internal value of the "Confirmed" constant.
This constant has an integer value of 4.

See Also:
Constant Field Values

CONFIRMED

public static final TransactionState CONFIRMED
This constant value indicates that the transaction state is "Confirmed".


_TERMINATED

public static final int _TERMINATED
This constant value indicates the internal value of the "Terminated" constant.
This constant has an integer value of 5.

See Also:
Constant Field Values

TERMINATED

public static final TransactionState TERMINATED
This constant value indicates that the transaction state is "Terminated".

Method Detail

getObject

public static TransactionState getObject(int transactionState)
This method returns the object value of the TransactionState

Parameters:
transactionState - The integer value of the TransactionState
Returns:
The TransactionState Object

getValue

public int getValue()
This method returns the integer value of the TransactionState

Returns:
The integer value of the TransactionState

equals

public boolean equals(java.lang.Object obj)
Compare this transaction state for equality with another.

Overrides:
equals in class java.lang.Object
Parameters:
obj - the object to compare this with.
Returns:
true if obj is an instance of this class representing the same transaction state as this, false otherwise.
Since:
1.2

hashCode

public int hashCode()
Get a hash code value for this transaction state.

Overrides:
hashCode in class java.lang.Object
Returns:
a hash code value.
Since:
1.2

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

JSIP API v1.2
November 2006

If you have any comments, please mail them to JAIN-SIP-INTEREST@java.sun.com after subscribing at http://archives.java.sun.com
Copyright - 2006 BEA Systems and Sun Microsystems