javax.sip.header

Interface AllowEventsHeader

All Superinterfaces:

Cloneable, Header, Serializable

All Known Implementing Classes:

AllowEvents

public interface AllowEventsHeader
extends Header

This interface represents the AllowEvents SIP header, as defined by RFC3265, this header is not part of RFC3261.

The AllowEventsHeader includes a list of tokens which indicates the event packages supported by the client (if sent in a request) or server (if sent in a response). In other words, a node sending an AllowEventsHeader is advertising that it can process SUBSCRIBE requests and generate NOTIFY requests for all of the event packages listed in that header.

Any node implementing one or more event packages SHOULD include an appropriate AllowEventsHeader indicating all supported events in all methods which initiate dialogs and their responses (such as INVITE) and OPTIONS responses. This information is very useful, for example, in allowing user agents to render particular interface elements appropriately according to whether the events required to implement the features they represent are supported by the appropriate nodes.

Note that "Allow-Events" headers MUST NOT be inserted by proxies.

Version:

1.2

Author:

BEA Systems, NIST

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME Name of AllowEventsHeader

Method Summary

Methods

Modifier and Type	Method and Description
String	getEventType() Gets the eventType of the AllowEventsHeader.
void	setEventType(String eventType) Sets the eventType defined in this AllowEventsHeader.

Methods inherited from interface javax.sip.header.Header

clone, equals, getName, hashCode, toString

Field Detail

NAME

static final String NAME

Name of AllowEventsHeader

See Also:

Constant Field Values

Method Detail

setEventType

void setEventType(String eventType)
                  throws ParseException

Sets the eventType defined in this AllowEventsHeader.

Parameters:

eventType - - the String defining the method supported in this AllowEventsHeader

Throws:

ParseException - which signals that an error has been reached unexpectedly while parsing the Strings defining the eventType supported

getEventType

String getEventType()

Gets the eventType of the AllowEventsHeader.

Returns:

the String object identifing the eventTypes of AllowEventsHeader.