javax.sip.header.AllowEventsHeader Maven / Gradle / Ivy
/**
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Unpublished - rights reserved under the Copyright Laws of the United States.
* Copyright ? 2003 Sun Microsystems, Inc. All rights reserved.
* Copyright ? 2005 BEA Systems, Inc. All rights reserved.
*
* Use is subject to license terms.
*
* This distribution may include materials developed by third parties.
*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*
* Module Name : JSIP Specification
* File Name : AllowEventsHeader.java
* Author : Phelim O'Doherty
*
* HISTORY
* Version Date Author Comments
* 1.1 13/12/2002 Phelim O'Doherty Initial version, extension header to
* support RFC3265
*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/
package javax.sip.header;
import java.text.ParseException;
/**
* 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.
*
* @author BEA Systems, NIST
* @version 1.2
*/
public interface AllowEventsHeader extends Header {
/**
* Sets the eventType defined in this AllowEventsHeader.
*
* @param 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
*/
public void setEventType(String eventType) throws ParseException;
/**
* Gets the eventType of the AllowEventsHeader.
*
* @return the String object identifing the eventTypes of AllowEventsHeader.
*/
public String getEventType();
/**
* Name of AllowEventsHeader
*/
public final static String NAME = "Allow-Events";
}