01: /**
02: * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
03: * Unpublished - rights reserved under the Copyright Laws of the United States.
04: * Copyright © 2003 Sun Microsystems, Inc. All rights reserved.
05: * Copyright © 2005 BEA Systems, Inc. All rights reserved.
06: *
07: * Use is subject to license terms.
08: *
09: * This distribution may include materials developed by third parties.
10: *
11: * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12: *
13: * Module Name : JSIP Specification
14: * File Name : AllowEventsHeader.java
15: * Author : Phelim O'Doherty
16: *
17: * HISTORY
18: * Version Date Author Comments
19: * 1.1 13/12/2002 Phelim O'Doherty Initial version, extension header to
20: * support RFC3265
21: *~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22: */package javax.sip.header;
23:
24: import java.text.ParseException;
25:
26: /**
27: * This interface represents the AllowEvents SIP header, as defined by
28: * <a href = "http://www.ietf.org/rfc/rfc3265.txt">RFC3265</a>, this header is
29: * not part of RFC3261.
30: * <p>
31: * The AllowEventsHeader includes a list of tokens which indicates the event
32: * packages supported by the client (if sent in a request) or server (if sent
33: * in a response). In other words, a node sending an AllowEventsHeader is
34: * advertising that it can process SUBSCRIBE requests and generate NOTIFY
35: * requests for all of the event packages listed in that header.
36: * <p>
37: * Any node implementing one or more event packages SHOULD include an appropriate
38: * AllowEventsHeader indicating all supported events in all methods which
39: * initiate dialogs and their responses (such as INVITE) and OPTIONS responses.
40: * This information is very useful, for example, in allowing user agents to
41: * render particular interface elements appropriately according to whether the
42: * events required to implement the features they represent are supported by
43: * the appropriate nodes.
44: * <p>
45: * Note that "Allow-Events" headers MUST NOT be inserted by proxies.
46: *
47: * @author BEA Systems, NIST
48: * @version 1.2
49: */
50:
51: public interface AllowEventsHeader extends Header {
52:
53: /**
54: * Sets the eventType defined in this AllowEventsHeader.
55: *
56: * @param eventType - the String defining the method supported
57: * in this AllowEventsHeader
58: * @throws ParseException which signals that an error has been reached
59: * unexpectedly while parsing the Strings defining the eventType supported
60: */
61: public void setEventType(String eventType) throws ParseException;
62:
63: /**
64: * Gets the eventType of the AllowEventsHeader.
65: *
66: * @return the String object identifing the eventTypes of AllowEventsHeader.
67: */
68: public String getEventType();
69:
70: /**
71: * Name of AllowEventsHeader
72: */
73: public final static String NAME = "Allow-Events";
74:
75: }
|