javax.sip.header

Interface AllowHeader

All Superinterfaces:

Cloneable, Header, Serializable

All Known Implementing Classes:

Allow

public interface AllowHeader
extends Header

The Allow header field lists the set of methods supported by the User Agent generating the message. All methods, including ACK and CANCEL, understood by the User Agent MUST be included in the list of methods in the Allow header field, when present. The absence of an Allow header field MUST NOT be interpreted to mean that the User Agent sending the message supports no methods. Rather, it implies that the User Agent is not providing any information on what methods it supports. Supplying an Allow header field in responses to methods other than OPTIONS reduces the number of messages needed.

For Example:
Allow: INVITE, ACK, OPTIONS, CANCEL, BYE

Version:

1.2

Author:

BEA Systems, NIST

Field Summary

Fields

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

Method Summary

Methods

Modifier and Type	Method and Description
String	getMethod() Gets the method of the AllowHeader.
void	setMethod(String method) Sets the Allow header value.

Methods inherited from interface javax.sip.header.Header

clone, equals, getName, hashCode, toString

Field Detail

NAME

static final String NAME

Name of AllowHeader

See Also:

Constant Field Values

Method Detail

setMethod

void setMethod(String method)
               throws ParseException

Sets the Allow header value. The argument may be a single method name (eg "ACK") or a comma delimited list of method names (eg "ACK, CANCEL, INVITE").

Parameters:

method - - the String defining the method supported in this AllowHeader

Throws:

ParseException - which signals that an error has been reached unexpectedly while parsing the method supported.

getMethod

String getMethod()

Gets the method of the AllowHeader. Returns null if no method is defined in this Allow Header.

Returns:

the string identifing the method of AllowHeader.