javax.sip
Class DialogState

java.lang.Object
  |
  +--javax.sip.DialogState

All Implemented Interfaces:

java.io.Serializable

public final class DialogState

extends java.lang.Object

implements java.io.Serializable

This class contains the enumerations that define the underlying state of an existing dialog. There are four explicit states for a dialog, namely:

• Early - A dialog is in the "early" state, which occurs when it is created when a provisional response is recieved to the INVITE Request.
• Confirmed - A dialog transitions to the "confirmed" state when a 2xx final response is received to the INVITE Request.
• Completed - A dialog transitions to the "completed" state when a BYE request is sent or received by the User Agent Client.
• Terminated - A dialog transitions to the "terminated" state when it is completed and ready for garbage collection.

Since:

1.1

See Also:

Serialized Form

Field Summary

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	_EARLY This constant value indicates the internal value of the "Early" constant.
static int	_TERMINATED This constant value indicates the internal value of the "Terminated" constant.
static DialogState	COMPLETED This constant value indicates that the dialog state is "Completed".
static DialogState	CONFIRMED This constant value indicates that the dialog state is "Confirmed".
static DialogState	EARLY This constant value indicates that the dialog state is "Early".
static DialogState	TERMINATED This constant value indicates that the dialog state is "Terminated".

Method Summary

static DialogState	getObject(int dialogState) This method returns the object value of the DialogState
int	getValue() This method returns the integer value of the DialogState
java.lang.String	toString() This method returns a string version of this class.

Methods inherited from class java.lang.Object

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

Field Detail

_EARLY

public static final int _EARLY

This constant value indicates the internal value of the "Early" constant.
This constant has an integer value of 0.

See Also:

Constant Field Values

EARLY

public static final DialogState EARLY

This constant value indicates that the dialog state is "Early".

_CONFIRMED

public static final int _CONFIRMED

This constant value indicates the internal value of the "Confirmed" constant.
This constant has an integer value of 1.

See Also:

Constant Field Values

CONFIRMED

public static final DialogState CONFIRMED

This constant value indicates that the dialog state is "Confirmed".

_COMPLETED

public static final int _COMPLETED

This constant value indicates the internal value of the "Completed" constant.
This constant has an integer value of 2.

See Also:

Constant Field Values

COMPLETED

public static final DialogState COMPLETED

This constant value indicates that the dialog state is "Completed".

_TERMINATED

public static final int _TERMINATED

This constant value indicates the internal value of the "Terminated" constant.
This constant has an integer value of 3.

See Also:

Constant Field Values

TERMINATED

public static final DialogState TERMINATED

This constant value indicates that the dialog state is "Terminated".

Method Detail

getObject

public static DialogState getObject(int dialogState)

This method returns the object value of the DialogState

Returns:

The DialogState Object

getValue

public int getValue()

This method returns the integer value of the DialogState

Returns:

The integer value of the DialogState

toString

public java.lang.String toString()

This method returns a string version of this class.

Overrides:

toString in class java.lang.Object

Returns:

The string version of the DialogState