sip.header.SIPETagHeader 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 : SIPETagHeader.java
* Author : Jeroen van Bemmel
*
* HISTORY
* Version Date Author Comments
* 1.1 27/10/2005 Jeroen van Bemmel Initial version, header to support RFC3903.
*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/
package javax.sip.header;
import java.text.ParseException;
import javax.sip.header.Header;
/**
* This interface represents the SIP-ETag header, as defined by
* RFC3903.
*
* The SIP-ETag header is used by a server (event state collector) in a 2xx
* response to PUBLISH in order to convey a unique entity tag for the published
* state. The client may then use this tag in a
* {@link javax.sip.header.SIPIfMatchHeader} to update previously published
* state.
*
* Sample syntax:
SIP-ETag: dx200xyz
*
*
* A server must ignore Headers that it does not understand. A proxy must not
* remove or modify Headers that it does not understand.
*
* @author BEA Systems, NIST
* @since 1.2
*/
public interface SIPETagHeader extends Header {
/**
* Name of this header (no short form).
*/
public static final String NAME = "SIP-ETag";
/**
* Returns the value of the entity-tag.
*
* @return the entity-tag
*/
public String getETag();
/**
* Sets the entity-tag value of this header.
*
* @param etag the new value of the entity-tag
* @throws ParseException if the ETag syntax is invalid (not a valid token)
*/
public void setETag( String etag ) throws ParseException;
}