Uses of Interface
javax.sip.header.Header

Packages that use Header

Package	Description
gov.nist.javax.sip.header	Contains implementations of the SIP headers as defined in JAIN-SIP 1.2 and an implementation of the JAIN-SIP header factory.
gov.nist.javax.sip.header.extensions
gov.nist.javax.sip.header.ims	NIST-SIP Specific support for IMS headers contributed by Jose Miguel Freitas (Aveiro University, Portugal) and Alexandre Miguel Silva Santos (PT Inovacau, Portugal).
gov.nist.javax.sip.message	Class definitions for SIP messages and message factory.
javax.sip.header	This package contains all the headers interfaces supported by this specification.
javax.sip.message	This package contains the interfaces representing SIP messages.
test.tck.factory

Uses of Header in gov.nist.javax.sip.header

Subinterfaces of Header in gov.nist.javax.sip.header

Modifier and Type	Interface and Description
interface	HeaderExt Extensions to the Header interface supported by the implementation and will be included in the next spec release.
interface	ViaHeaderExt

Classes in gov.nist.javax.sip.header that implement Header

Modifier and Type	Class and Description
class	Accept Accept header : The top level header is actually AcceptList which is a list of Accept headers.
class	AcceptEncoding Accept-Encoding SIP (HTTP) Header.
class	AcceptEncodingList AcceptEncodingList of AccepEncoding headers.
class	AcceptLanguage Accept Language body.
class	AcceptLanguageList AcceptLanguageList: Strings together a list of AcceptLanguage SIPHeaders.
class	AcceptList Accept List of SIP headers.
class	AddressParametersHeader An abstract class for headers that take an address and parameters.
class	AlertInfo AlertInfo SIP Header.
class	AlertInfoList AlertInfo SIPHeader - there can be several AlertInfo headers.
class	Allow Allow SIPHeader.
class	AllowEvents AllowEvents SIPHeader.
class	AllowEventsList List of AllowEvents headers.
class	AllowList List of ALLOW headers.
class	AuthenticationHeader The generic AuthenticationHeader
class	AuthenticationInfo Authentication info SIP Header.
class	AuthenticationInfoList A list of AuthenticationInfo headers (there can be multiple in a message).
class	Authorization Authorization SIP header.
class	AuthorizationList WWWAuthenticate SIPHeader (of which there can be several?)
class	CallID Call ID SIPHeader.
class	CallInfo CallInfo SIPHeader.
class	CallInfoList A list of CallInfo headers (there can be multiple in a message).
class	Contact Contact Item.
class	ContactList List of contact headers.ContactLists are also maintained in a hashtable for quick lookup.
class	ContentDisposition Content Dispositon SIP Header.
class	ContentEncoding Content encoding part of a content encoding header list.
class	ContentEncodingList Content Encoding SIP header List.
class	ContentLanguage ContentLanguage header
class	ContentLanguageList ContentLanguage list of headers.
class	ContentLength ContentLength SIPHeader (of which there can be only one in a SIPMessage).
class	ContentType ContentType SIP Header
class	CSeq CSeq SIP Header.
class	ErrorInfo ErrorInfo SIP Header.
class	ErrorInfoList Error Info sip header.
class	Event Event SIP Header.
class	Expires Expires SIP Header.
class	ExtensionHeaderImpl A generic extension header for the stack.
class	ExtensionHeaderList A generic extension header list.
class	From From SIP Header.
class	InReplyTo InReplyTo SIP Header.
class	InReplyToList In-Reply-To SIP header.
class	MaxForwards MaxForwards SIPHeader
class	MimeVersion MimeVersion SIP Header.
class	MinExpires MinExpires SIP Header.
class	Organization Organization SIP Header.
class	ParametersHeader Parameters header.
class	Priority the Priority header.
class	ProxyAuthenticate Proxy Authenticate SIP (HTTP ) header.
class	ProxyAuthenticateList List of ProxyAuthenticate headers.
class	ProxyAuthorization ProxyAuthorization Header.
class	ProxyAuthorizationList List of ProxyAuthorization headers.
class	ProxyRequire ProxyRequire Header.
class	ProxyRequireList Proxy Require SIPSIPObject (list of option tags)
class	RAck RAck SIP Header implementation
class	Reason Definition of the Reason SIP Header.
class	ReasonList List of Reason headers.
class	RecordRoute The Request-Route header is added to a request by any proxy that insists on being in the path of subsequent requests for the same call leg.
class	RecordRouteList RecordRoute List of SIP headers (a collection of Addresses)
class	ReferTo ReferTo SIP Header.
class	ReplyTo ReplyTo Header.
class	Require Require SIP Header.
class	RequireList List of Require headers.
class	RetryAfter Retry-After SIP Header.
class	Route Route SIPHeader Object
class	RouteList A list of Route Headers.
class	RSeq
class	Server Supported SIP Header.
class	SIPDateHeader Date Header.
class	SIPETag the SIP-ETag header.
class	SIPHeader Root class from which all SIPHeader objects are subclassed.
class	SIPHeaderList<HDR extends SIPHeader> This is the root class for all lists of SIP headers.
class	SIPIfMatch the SIP-If-Match header.
class	Subject Supported SIP Header.
class	SubscriptionState SubscriptionState header
class	Supported Supported SIP Header.
class	SupportedList A list of supported headers.
class	TimeStamp TimeStamp SIP Header.
class	To To SIP Header.
class	Unsupported the Unsupported header.
class	UnsupportedList List of Unsupported headers.
class	UserAgent the UserAgent SIPObject.
class	Via Via SIPHeader (these are strung together in a ViaList).
class	ViaList Keeps a list and a hashtable of via header functions.
class	Warning the WarningValue SIPObject.
class	WarningList A list of Warning headers.
class	WWWAuthenticate The WWWAuthenticate SIP header.
class	WWWAuthenticateList WWWAuthenticate SIPHeader (of which there can be several?)

Methods in gov.nist.javax.sip.header that return Header

Modifier and Type	Method and Description
Header	HeaderFactoryExt.createHeader(String header) Create a header from a string.
Header	HeaderFactoryImpl.createHeader(String headerText) Create a header from the given header text.
Header	HeaderFactoryImpl.createHeader(String headerName, String headerValue) Create and parse a header.
Header	SIPHeaderList.getFirst() Get the first element of this list.
Header	SIPHeaderList.getLast() Get the last element of this list.

Uses of Header in gov.nist.javax.sip.header.extensions

Subinterfaces of Header in gov.nist.javax.sip.header.extensions

Modifier and Type	Interface and Description
interface	JoinHeader The From header field indicates the logical identity of the initiator of the request, possibly the user's address-of-record.
interface	MinSEHeader
interface	ReferencesHeader References header: See http://tools.ietf.org/html/draft-worley-references-05
interface	ReferredByHeader This header is described in a draft RFC which has expired.
interface	ReplacesHeader The From header field indicates the logical identity of the initiator of the request, possibly the user's address-of-record.
interface	SessionExpiresHeader

Classes in gov.nist.javax.sip.header.extensions that implement Header

Modifier and Type	Class and Description
class	Join Join SIPHeader.
class	MinSE MinSE SIP Header.
class	References
class	ReferredBy ReferredBy SIP Header.
class	Replaces Replaces SIPHeader.
class	SessionExpires ReferredBy SIP Header.

Uses of Header in gov.nist.javax.sip.header.ims

Subinterfaces of Header in gov.nist.javax.sip.header.ims

Modifier and Type	Interface and Description
interface	AuthorizationHeaderIms Extension to Authorization header (3GPP TS 24299-5d0) This extension defines a new auth-param for the Authorization header used in REGISTER requests.
interface	PAccessNetworkInfoHeader P-Access-Network-Info SIP P-Header
interface	PAssertedIdentityHeader P-Asserted-Identity header Private Header: RFC 3455.
interface	PAssertedServiceHeader
interface	PAssociatedURIHeader P-Associated-URI SIP Private Header.
interface	PathHeader PATH header SIP param: RFC 3327.
interface	PCalledPartyIDHeader P-Called-Party-ID header - Private Header: RFC 3455.
interface	PChargingFunctionAddressesHeader P-Charging-Function-Addresses header - Private Header: RFC 3455.
interface	PChargingVectorHeader P-Charging-Vector header SIP Private Header.
interface	PMediaAuthorizationHeader The P-Media-Authorization SIP Private Header - RFC 3313.
interface	PPreferredIdentityHeader P-Preferred-Identity header - SIP Private Header: RFC 3325 .
interface	PPreferredServiceHeader
interface	PProfileKeyHeader
interface	PrivacyHeader Privacy Header RFC 3323.
interface	PUserDatabaseHeader
interface	PVisitedNetworkIDHeader P-Visited-Network-ID SIP Private Header: RFC 3455.
interface	SecurityAgreeHeader "Security Mechanism Agreemet for SIP Sessions" - sec-agree: RFC 3329 + 3GPP TS33.203 (Annex H).
interface	SecurityClientHeader Security-Client header - sec-agree: RFC 3329 + 3GPP TS33.203 (Annex H).
interface	SecurityServerHeader Security-Server header - sec-agree: RFC 3329 + 3GPP TS33.203 (Annex H).
interface	SecurityVerifyHeader Security-Verify header - sec-agree: RFC 3329 + 3GPP TS33.203 (Annex H).
interface	ServiceRouteHeader SERVICE-ROUTE header SIP param: RFC 3608.
interface	WWWAuthenticateHeaderIms Extension to WWW-authenticate header (3GPP TS 24229-5d0).

Classes in gov.nist.javax.sip.header.ims that implement Header

Modifier and Type	Class and Description
class	AddressHeaderIms AddressHeader base class.
class	PAccessNetworkInfo P-Access-Network-Info SIP Private Header
class	PAssertedIdentity P-Asserted-Identity SIP Private Header.
class	PAssertedIdentityList List of P-Asserted-Identity headers
class	PAssertedService
class	PAssociatedURI P-Associated-URI SIP Private Header.
class	PAssociatedURIList List of P-Associated-URI headers
class	Path
class	PathList
class	PCalledPartyID P-Called-Party-ID SIP Private Header.
class	PChargingFunctionAddresses P-Charging-Function-Addresses SIP Private Header.
class	PChargingVector P-Charging-Vector header SIP Private Header: RFC 3455.
class	PMediaAuthorization P-Media-Authorization SIP Private Header - RFC 3313.
class	PMediaAuthorizationList List of P-Media-Authorization headers.
class	PPreferredIdentity P-Preferred-Identity SIP Private Header - RFC 3325.
class	PPreferredService
class	PProfileKey
class	Privacy Privacy SIP header - RFC 3323.
class	PrivacyList List of Privacy headers.
class	PServedUser
class	PUserDatabase
class	PVisitedNetworkID P-Visited-Network-ID SIP Private Header: RFC 3455.
class	PVisitedNetworkIDList List of P-Visited-Network-ID headers.
class	SecurityAgree "Security Mechanism Agreemet for SIP Sessions" - sec-agree: RFC 3329 + 3GPP TS33.203 (Annex H).
class	SecurityClient Security-Client header - sec-agree: RFC 3329 + 3GPP TS33.203 (Annex H).
class	SecurityClientList List of Security-Client headers.
class	SecurityServer Security-Server header - sec-agree: RFC 3329 + 3GPP TS33.203 (Annex H).
class	SecurityServerList List of Security-Server headers.
class	SecurityVerify Security-Verify header - sec-agree: RFC 3329 + 3GPP TS33.203 (Annex H).
class	SecurityVerifyList List of Security-Verify headers.
class	ServiceRoute SERVICE-ROUTE header SIP param: RFC 3608.
class	ServiceRouteList

Uses of Header in gov.nist.javax.sip.message

Methods in gov.nist.javax.sip.message that return Header

Modifier and Type	Method and Description
Header	SIPMessage.getHeader(String headerName) Get the first header of the given name.
protected Header	SIPMessage.getHeaderLowerCase(String lowerCaseHeaderName)

Methods in gov.nist.javax.sip.message that return types with arguments of type Header

Modifier and Type	Method and Description
Iterator<Header>	Content.getExtensionHeaders()
Iterator<Header>	ContentImpl.getExtensionHeaders()

Methods in gov.nist.javax.sip.message with parameters of type Header

Modifier and Type	Method and Description
void	ContentImpl.addExtensionHeader(Header header)
void	SIPMessage.addFirst(Header header)
void	SIPMessage.addHeader(Header sipHeader) Add a SIP header.
void	SIPMessage.addLast(Header header)
void	SIPMessage.setHeader(Header sipHeader) Attach a header (replacing the original header).

Uses of Header in javax.sip.header

Subinterfaces of Header in javax.sip.header

Modifier and Type	Interface and Description
interface	AcceptEncodingHeader This interface represents the Accept-Encoding request-header.
interface	AcceptHeader This interface represents an Accept request-header.
interface	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.
interface	AlertInfoHeader When present in an INVITE request, the Alert-Info header field specifies an alternative ring tone to the UAS.
interface	AllowEventsHeader This interface represents the AllowEvents SIP header, as defined by RFC3265, this header is not part of RFC3261.
interface	AllowHeader The Allow header field lists the set of methods supported by the User Agent generating the message.
interface	AuthenticationInfoHeader The Authentication-Info header field provides for mutual authentication with HTTP Digest.
interface	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.
interface	CallIdHeader The Call-ID header field uniquely identifies a particular invitation or all registrations of a particular client.
interface	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.
interface	ContactHeader A Contact header field value provides a URI whose meaning depends on the type of request or response it is in.
interface	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.
interface	ContentEncodingHeader A ContentEncodingHeader is used as a modifier to the "media-type".
interface	ContentLanguageHeader The Content-Language header field is used to indicate the language of the message body.
interface	ContentLengthHeader The Content-Length header field indicates the size of the message-body, in decimal number of octets, sent to the recipient.
interface	ContentTypeHeader The Content-Type header field indicates the media type of the message-body sent to the recipient.
interface	CSeqHeader A CSeq header field in a request contains a single decimal sequence number and the request method.
interface	DateHeader The Date header field reflects the time when the request or response is first sent.
interface	ErrorInfoHeader The Error-Info header field provides a pointer to additional information about the error status response.
interface	EventHeader This interface represents the Event SIP header, as defined by RFC3265, this header is not part of RFC3261.
interface	ExpiresHeader The Expires header field gives the relative time after which the message (or content) expires.
interface	ExtensionHeader This interface represents an Extension SIP header that was not defined at the baseline of this specification.
interface	FromHeader The From header field indicates the logical identity of the initiator of the request, possibly the user's address-of-record.
interface	InReplyToHeader The In-Reply-To header field enumerates the Call-IDs that this call references or returns.
interface	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.
interface	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.
interface	MinExpiresHeader The Min-Expires header field conveys the minimum refresh interval supported for soft-state elements managed by that server.
interface	OrganizationHeader The OrganizationHeader conveys the name of the organization to which the entity issuing the Request or Response belongs.
interface	PriorityHeader The Priority header field indicates the urgency of the request as perceived by the client.
interface	ProxyAuthenticateHeader A Proxy-Authenticate header field value contains an authentication challenge.
interface	ProxyAuthorizationHeader The Proxy-Authorization header field allows the client to identify itself (or its user) to a proxy that requires authentication.
interface	ProxyRequireHeader The Proxy-Require header field is used to indicate proxy-sensitive features that must be supported by the proxy.
interface	RAckHeader This interface represents the RAck header, as defined by RFC3262, this header is not part of RFC3261.
interface	ReasonHeader This interface represents the Reason header, as defined by RFC3326, this header is not part of RFC3261.
interface	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.
interface	ReferToHeader This interface represents the ReferTo SIP header, as defined by RFC3515, this header is not part of RFC3261.
interface	ReplyToHeader The Reply-To header field contains a logical return URI that may be different from the From header field.
interface	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.
interface	RetryAfterHeader The Retry-After header field identifies the time to retry the request after recipt of the response.
interface	RouteHeader The Route header field is used to force routing for a request through the listed set of proxies.
interface	RSeqHeader This interface represents the RSeq header, as defined by RFC3262, this header is not part of RFC3261.
interface	ServerHeader The Server header field contains information about the software used by the UAS to handle the request.
interface	SIPETagHeader This interface represents the SIP-ETag header, as defined by RFC3903.
interface	SIPIfMatchHeader This interface represents the SIP-If-Match header, as defined by RFC3903.
interface	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.
interface	SubscriptionStateHeader This interface represents the Subscription State header, as defined by RFC3265, this header is not part of RFC3261.
interface	SupportedHeader The Supported header field enumerates all the extensions supported by the UAC or UAS.
interface	TimeStampHeader The Timestamp header field describes when the UAC sent the request to the UAS.
interface	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.
interface	UnsupportedHeader The Unsupported header field lists the features not supported by the UAS.
interface	UserAgentHeader The User-Agent header field contains information about the UAC originating the request.
interface	ViaHeader The Via header field indicates the transport used for the transaction and identifies the location where the response is to be sent.
interface	WarningHeader The Warning header field is used to carry additional information about the status of a response.
interface	WWWAuthenticateHeader This interface represents the WWW-Authenticate response-header.

Methods in javax.sip.header that return Header

Modifier and Type	Method and Description
Header	HeaderFactory.createHeader(String name, String value) Creates a new Header based on the newly supplied name and value values.

Uses of Header in javax.sip.message

Methods in javax.sip.message that return Header

Modifier and Type	Method and Description
Header	Message.getHeader(String headerName) Gets the Header of the specified name in this Message.

Methods in javax.sip.message with parameters of type Header

Modifier and Type	Method and Description
void	Message.addFirst(Header header) Adds the new Header to the head of the existing list of Headers contained in this Message.
void	Message.addHeader(Header header) Adds the new Header to the existing list of Headers contained in this Message.
void	Message.addLast(Header header) Adds the new Header to the end of existing list of Headers contained in this Message.
void	Message.setHeader(Header header) Sets the new Header to replace existings Header of that type in the message.

Uses of Header in test.tck.factory

Methods in test.tck.factory that return Header

Modifier and Type	Method and Description
protected Header	FactoryTestHarness.createRiHeaderFromString(String hdr)