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 : SIPETagHeader.java
15: * Author : Jeroen van Bemmel
16: *
17: * HISTORY
18: * Version Date Author Comments
19: * 1.1 27/10/2005 Jeroen van Bemmel Initial version, header to support RFC3903.
20: *~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
21: */package javax.sip.header;
22:
23: import java.text.ParseException;
24:
25: import javax.sip.header.Header;
26:
27: /**
28: * This interface represents the SIP-ETag header, as defined by
29: * <a href = "http://www.ietf.org/rfc/rfc3903.txt">RFC3903</a>.
30: * <p>
31: * The SIP-ETag header is used by a server (event state collector) in a 2xx
32: * response to PUBLISH in order to convey a unique entity tag for the published
33: * state. The client may then use this tag in a
34: * {@link javax.sip.header.SIPIfMatchHeader} to update previously published
35: * state.
36: * <p>
37: * Sample syntax:<br><code>SIP-ETag: dx200xyz</code>
38: *
39: * <p>
40: * A server must ignore Headers that it does not understand. A proxy must not
41: * remove or modify Headers that it does not understand.
42: *
43: * @author BEA Systems, NIST
44: * @since 1.2
45: */
46: public interface SIPETagHeader extends Header {
47:
48: /**
49: * Name of this header (no short form).
50: */
51: public static final String NAME = "SIP-ETag";
52:
53: /**
54: * Returns the value of the entity-tag.
55: *
56: * @return the entity-tag
57: */
58: public String getETag();
59:
60: /**
61: * Sets the entity-tag value of this header.
62: *
63: * @param etag the new value of the entity-tag
64: * @throws ParseException if the ETag syntax is invalid (not a valid token)
65: */
66: public void setETag(String etag) throws ParseException;
67: }
|