org.restlet.ext.sip
Class OptionTag

java.lang.Object
  extended by org.restlet.ext.sip.OptionTag

public class OptionTag
extends Object

Describes SIP agent capabilities. Used by the SIP "supported", "unsupported", "proxy-require", "require" headers.

Author:
Thierry Boileau

Field Summary
static OptionTag ANSWER_MODE
          Indicates support of the "Answer mode" extension.
static OptionTag EARLY_SESSION
          "Early session" content-disposition type.
static OptionTag EVENT_LIST
          Extension for the registry to allow subscriptions to lists of resources.
static OptionTag FROM_CHANGE
          Used to indicate that a UA supports changes to URIs in From and To header fields during a dialog.
static OptionTag GRUU
          Used to identify the Globally Routable User Agent URI (GRUU) extension.
static OptionTag HIST_INFO
          When used with the Supported header, indicates support for the History Information to be captured for requests and returned in subsequent responses.
static OptionTag ICE
          Used to identify the Interactive Connectivity Establishment (ICE) extension.
static OptionTag JOIN
          Support for the SIP Join Header.
static OptionTag MULTIPLE_REFER
          Indicates support for REFER requests that contain a resource list document describing multiple REFER targets.
static OptionTag NO_REFER_SUB
          Specifies a User Agent ability of accepting a REFER request without establishing an implicit subscription
static OptionTag OUTBOUND
          Used to identify UAs and Registrars which support extensions for Client Initiated Connections
static OptionTag PATH
          Indicates the support of the Path extension.
static OptionTag PRECONDITION
          An offerer MUST include this tag in the Require header field if the offer contains one or more "mandatory" strength-tags.
static OptionTag PREF
          Used to ensure that a server understands the callee capabilities parameters used in the request.
static OptionTag PRIVACY
          Indicates support for the Privacy mechanism.
static OptionTag RECIPIENT_LIST_INVITE
          The body contains a list of URIs that indicates the recipients of the SIP INVITE request.
static OptionTag RECIPIENT_LIST_MESSAGE
          The body contains a list of URIs that indicates the recipients of the SIP MESSAGE request.
static OptionTag RECIPIENT_LIST_SUBSCRIBE
          Used to ensurethat a server can process the recipient-list body used in a SUBSCRIBE request.
static OptionTag REPLACES
          Indicates support for the SIP Replaces header.
static OptionTag RESOURCE_PRIORITY
          Indicates or requests support for the resource priority mechanism.
static OptionTag SDP_ANAT
          When used in a Supported header field it indicates the support of the ANAT semantics.
static OptionTag SEC_AGREE
          Indicates support for the Security Agreement mechanism.
static OptionTag T_DIALOG
          Used to identify the target dialog header field extension.
static OptionTag TAG_100REL
          Used for reliability of provisional responses.
static OptionTag TIMER
          Indicates the support of the session timer extension.
 
Constructor Summary
OptionTag(String tag)
          Constructor.
 
Method Summary
 String getTag()
          Returns the tag value.
static OptionTag register(String name)
          Register an option tag that can later be retrieved using valueOf(String).
 void setTag(String tag)
          Sets the tag value.
static OptionTag valueOf(String name)
          Returns the option tag associated to a name.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ANSWER_MODE

public static final OptionTag ANSWER_MODE
Indicates support of the "Answer mode" extension.

See Also:
Requesting Answering Modes for SIP

EARLY_SESSION

public static final OptionTag EARLY_SESSION
"Early session" content-disposition type.

See Also:
The Early Session Disposition Type for SIP

EVENT_LIST

public static final OptionTag EVENT_LIST
Extension for the registry to allow subscriptions to lists of resources.

See Also:
A Session Initiation Protocol (SIP) Event Notification Extension for Resource Lists

FROM_CHANGE

public static final OptionTag FROM_CHANGE
Used to indicate that a UA supports changes to URIs in From and To header fields during a dialog.

See Also:
Connected Identity in the SIP

GRUU

public static final OptionTag GRUU
Used to identify the Globally Routable User Agent URI (GRUU) extension.

See Also:
Obtaining and Using Globally Routable User Agent URIs (GRUUs) in the SIP

HIST_INFO

public static final OptionTag HIST_INFO
When used with the Supported header, indicates support for the History Information to be captured for requests and returned in subsequent responses.

See Also:
An Extension to the SIP for Request History Information

ICE

public static final OptionTag ICE
Used to identify the Interactive Connectivity Establishment (ICE) extension. When present in a Require header field, it indicates that ICE is required by an agent.

See Also:
An Extension to the SIP for Request History Information

JOIN

public static final OptionTag JOIN
Support for the SIP Join Header.

See Also:
The SIP "Join" Header

MULTIPLE_REFER

public static final OptionTag MULTIPLE_REFER
Indicates support for REFER requests that contain a resource list document describing multiple REFER targets.

See Also:
Referring to Multiple Resources in the SIP

NO_REFER_SUB

public static final OptionTag NO_REFER_SUB
Specifies a User Agent ability of accepting a REFER request without establishing an implicit subscription

See Also:
Suppression of SIP REFER Method Implicit Subscription

OUTBOUND

public static final OptionTag OUTBOUND
Used to identify UAs and Registrars which support extensions for Client Initiated Connections

See Also:
Managing Client-Initiated Connections in the SIP

PATH

public static final OptionTag PATH
Indicates the support of the Path extension.

See Also:
SIP Extension Header Field for Registering Non-Adjacent Contacts

PRECONDITION

public static final OptionTag PRECONDITION
An offerer MUST include this tag in the Require header field if the offer contains one or more "mandatory" strength-tags.

See Also:
Integration of Resource Management and SIP

PREF

public static final OptionTag PREF
Used to ensure that a server understands the callee capabilities parameters used in the request.

See Also:
Indicating User Agent Capabilities in the SIP

PRIVACY

public static final OptionTag PRIVACY
Indicates support for the Privacy mechanism.

See Also:
A Privacy Mechanism for the SIP

RECIPIENT_LIST_INVITE

public static final OptionTag RECIPIENT_LIST_INVITE
The body contains a list of URIs that indicates the recipients of the SIP INVITE request.

See Also:
Conference Establishment Using Request-Contained Lists in the SIP

RECIPIENT_LIST_MESSAGE

public static final OptionTag RECIPIENT_LIST_MESSAGE
The body contains a list of URIs that indicates the recipients of the SIP MESSAGE request.

See Also:
Multiple-Recipient MESSAGE Requests in the SIP

RECIPIENT_LIST_SUBSCRIBE

public static final OptionTag RECIPIENT_LIST_SUBSCRIBE
Used to ensurethat a server can process the recipient-list body used in a SUBSCRIBE request.

See Also:
Subscriptions to Request-Contained Resource Lists

REPLACES

public static final OptionTag REPLACES
Indicates support for the SIP Replaces header.

See Also:
the SIP "Replaces" Header

RESOURCE_PRIORITY

public static final OptionTag RESOURCE_PRIORITY
Indicates or requests support for the resource priority mechanism.

See Also:
Communications Resource Priority for the SIP

SDP_ANAT

public static final OptionTag SDP_ANAT
When used in a Supported header field it indicates the support of the ANAT semantics.

See Also:
Usage of the Session Description Protocol (SDP) Alternative Network Address Types (ANAT) Semantics in the SIP

SEC_AGREE

public static final OptionTag SEC_AGREE
Indicates support for the Security Agreement mechanism.

See Also:
Security Mechanism Agreement for the SIP

T_DIALOG

public static final OptionTag T_DIALOG
Used to identify the target dialog header field extension.

See Also:
Request Authorization through Dialog Identification in the SIP

TAG_100REL

public static final OptionTag TAG_100REL
Used for reliability of provisional responses.

See Also:
Reliability of Provisional Responses in the SIP

TIMER

public static final OptionTag TIMER
Indicates the support of the session timer extension.

See Also:
Session Timers in the SIP
Constructor Detail

OptionTag

public OptionTag(String tag)
Constructor.

Parameters:
tag - The tag value.
Method Detail

register

public static OptionTag register(String name)
Register an option tag that can later be retrieved using valueOf(String). If the option tag already exists, the existing tag is returned, otherwise a new instance is created.

Parameters:
name - The name.
Returns:
The registered option tag.

valueOf

public static OptionTag valueOf(String name)
Returns the option tag associated to a name. If an existing constant exists then it is returned, otherwise a new instance is created.

Parameters:
name - The name.
Returns:
The associated option tag.

getTag

public String getTag()
Returns the tag value.

Returns:
The tag value.

setTag

public void setTag(String tag)
Sets the tag value.

Parameters:
tag - The tag value.


Copyright © 2005-2013 Restlet.