November 2006

Package javax.sip.header

This package contains all the headers interfaces supported by this specification.


Interface Summary
AcceptEncodingHeader This interface represents the Accept-Encoding request-header.
AcceptHeader This interface represents an Accept request-header.
AcceptLanguageHeader The Accept-Language header field is used in requests to indicate the preferred languages for reason phrases, session descriptions, or status responses carried as message bodies in the response.
AlertInfoHeader When present in an INVITE request, the Alert-Info header field specifies an alternative ring tone to the UAS.
AllowEventsHeader This interface represents the AllowEvents SIP header, as defined by RFC3265, this header is not part of RFC3261.
AllowHeader The Allow header field lists the set of methods supported by the User Agent generating the message.
AuthenticationInfoHeader The Authentication-Info header field provides for mutual authentication with HTTP Digest.
AuthorizationHeader The Authorization header is used when a user agent wishes to authenticate itself with a server - usually, but not necessarily, after receiving an UNAUTHORIZED Response - by including an AuthorizationHeader with the Request.
CallIdHeader The Call-ID header field uniquely identifies a particular invitation or all registrations of a particular client.
CallInfoHeader The Call-Info header field provides additional information about the caller or callee, depending on whether it is found in a request or response.
ContactHeader A Contact header field value provides a URI whose meaning depends on the type of request or response it is in.
ContentDispositionHeader The Content-Disposition header field describes how the message body or, for multipart messages, a message body part is to be interpreted by the UAC or UAS.
ContentEncodingHeader A ContentEncodingHeader is used as a modifier to the "media-type".
ContentLanguageHeader The Content-Language header field is used to indicate the language of the message body.
ContentLengthHeader The Content-Length header field indicates the size of the message-body, in decimal number of octets, sent to the recipient.
ContentTypeHeader The Content-Type header field indicates the media type of the message-body sent to the recipient.
CSeqHeader A CSeq header field in a request contains a single decimal sequence number and the request method.
DateHeader The Date header field reflects the time when the request or response is first sent.
Encoding This interface represents encoding methods for any header that contains an encoding value.
ErrorInfoHeader The Error-Info header field provides a pointer to additional information about the error status response.
EventHeader This interface represents the Event SIP header, as defined by RFC3265, this header is not part of RFC3261.
ExpiresHeader The Expires header field gives the relative time after which the message (or content) expires.
ExtensionHeader This interface represents an Extension SIP header that was not defined at the baseline of this specification.
FromHeader The From header field indicates the logical identity of the initiator of the request, possibly the user's address-of-record.
Header This interface is the super interface of all SIP headers supported explicitly by this specification.
HeaderAddress This interface represents methods for manipulating Address object values for any header that contains a Address value.
HeaderFactory This interface provides factory methods that allow an application to create Header object from a particular implementation of JAIN SIP.
InReplyToHeader The In-Reply-To header field enumerates the Call-IDs that this call references or returns.
MaxForwardsHeader The Max-Forwards header field must be used with any SIP method to limit the number of proxies or gateways that can forward the request to the next downstream server.
MediaType This interface represents media type methods for any header that contain content type and content sub-type values.
MimeVersionHeader SIP messages MAY include a single MIME-Version general-header field to indicate what version of the MIME protocol was used to construct the message.
MinExpiresHeader The Min-Expires header field conveys the minimum refresh interval supported for soft-state elements managed by that server.
OptionTag This interface represents methods for manipulating OptionTags values for any header that contains an OptionTag value.
OrganizationHeader The OrganizationHeader conveys the name of the organization to which the entity issuing the Request or Response belongs.
Parameters This interface defines methods for accessing generic parameters for Headers that contain generic parameter values.
PriorityHeader The Priority header field indicates the urgency of the request as perceived by the client.
ProxyAuthenticateHeader A Proxy-Authenticate header field value contains an authentication challenge.
ProxyAuthorizationHeader The Proxy-Authorization header field allows the client to identify itself (or its user) to a proxy that requires authentication.
ProxyRequireHeader The Proxy-Require header field is used to indicate proxy-sensitive features that must be supported by the proxy.
RAckHeader This interface represents the RAck header, as defined by RFC3262, this header is not part of RFC3261.
ReasonHeader This interface represents the Reason header, as defined by RFC3326, this header is not part of RFC3261.
RecordRouteHeader The Record-Route header field is inserted by proxies in a request to force future requests in the dialog to be routed through the proxy.
ReferToHeader This interface represents the ReferTo SIP header, as defined by RFC3515, this header is not part of RFC3261.
ReplyToHeader The Reply-To header field contains a logical return URI that may be different from the From header field.
RequireHeader The Require header field is used by UACs to tell UASs about options that the UAC expects the UAS to support in order to process the request.
RetryAfterHeader The Retry-After header field identifies the time to retry the request after recipt of the response.
RouteHeader The Route header field is used to force routing for a request through the listed set of proxies.
RSeqHeader This interface represents the RSeq header, as defined by RFC3262, this header is not part of RFC3261.
ServerHeader The Server header field contains information about the software used by the UAS to handle the request.
SIPETagHeader This interface represents the SIP-ETag header, as defined by RFC3903.
SIPIfMatchHeader This interface represents the SIP-If-Match header, as defined by RFC3903.
SubjectHeader The Subject header field provides a summary or indicates the nature of the call, allowing call filtering without having to parse the session description.
SubscriptionStateHeader This interface represents the Subscription State header, as defined by RFC3265, this header is not part of RFC3261.
SupportedHeader The Supported header field enumerates all the extensions supported by the UAC or UAS.
TimeStampHeader The Timestamp header field describes when the UAC sent the request to the UAS.
ToHeader The To header field first and foremost specifies the desired "logical" recipient of the request, or the address-of-record of the user or resource that is the target of this request.
UnsupportedHeader The Unsupported header field lists the features not supported by the UAS.
UserAgentHeader The User-Agent header field contains information about the UAC originating the request.
ViaHeader The Via header field indicates the transport used for the transaction and identifies the location where the response is to be sent.
WarningHeader The Warning header field is used to carry additional information about the status of a response.
WWWAuthenticateHeader This interface represents the WWW-Authenticate response-header.

Exception Summary
TooManyHopsException This Exception is thrown when a user attempts decrement the Hop count when the message as already reached its max number of forwards.

Package javax.sip.header Description

This package contains all the headers interfaces supported by this specification. SIP header fields are similar to HTTP header fields in both syntax and semantics. This specification models each SIP header as a specific interface as opposed to have a single generic interface to handle all header information. It is deemed more explicit for protocol support to define protocol characteristics as opposed to generic interfaces. This specification supports all the headers defined in RFC 3261 and other headers introduced by supporting the following additional RFC's:

This specification also provides a mechanism to support other extension Headers. If a SIP stack vendor supports such extension headers these must extend the ExtensionHeader interface, which contains header name and header value attributes.

Additionally this package contains a HeaderFactory class that defines methods for creating new headers. The HeaderFactory is a singleton object, which can be obtained from the javax.sip.SipFactory.

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