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 : SIPIfMatchHeader.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-If-Match header, as defined by
29: * <a href = "http://www.ietf.org/rfc/rfc3903.txt">RFC3903</a>.
30: * <p>
31: * The SIP-If-Match header is used by a client (event state publisher) in
32: * a PUBLISH request, to update previously published event state. The value is
33: * obtained from the server in a {@link javax.sip.header.SIPETagHeader} in a
34: * 2xx response to a previous PUBLISH.
35: * <p>
36: * Sample syntax:<br><code>SIP-If-Match: dx200xyz</code>
37: *
38: * <p>
39: * A server must ignore Headers that it does not understand. A proxy must not
40: * remove or modify Headers that it does not understand.
41: *
42: * @author BEA Systems, NIST
43: * @since 1.2
44: */
45: public interface SIPIfMatchHeader extends Header {
46:
47: /**
48: * Name of this header (no short form.
49: */
50: public static final String NAME = "SIP-If-Match";
51:
52: /**
53: * Returns the value of the entity-tag.
54: *
55: * @return the entity-tag
56: */
57: public String getETag();
58:
59: /**
60: * Sets the entity-tag
61: * @param etag the new value of the entity-tag.
62: *
63: * @throws ParseException if the ETag syntax is invalid (not a valid token)
64: */
65: public void setETag(String etag) throws ParseException;
66: }
|