JSIP API v1.2
November 2006

javax.sip.header
Interface SIPETagHeader

All Superinterfaces:
java.lang.Cloneable, Header, java.io.Serializable

public interface SIPETagHeader
extends 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 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.

Since:
1.2
Author:
BEA Systems, NIST

Field Summary
static java.lang.String NAME
          Name of this header (no short form).
 
Method Summary
 java.lang.String getETag()
          Returns the value of the entity-tag.
 void setETag(java.lang.String etag)
          Sets the entity-tag value of this header.
 
Methods inherited from interface javax.sip.header.Header
clone, equals, getName, hashCode, toString
 

Field Detail

NAME

static final java.lang.String NAME
Name of this header (no short form).

See Also:
Constant Field Values
Method Detail

getETag

java.lang.String getETag()
Returns the value of the entity-tag.

Returns:
the entity-tag

setETag

void setETag(java.lang.String etag)
             throws java.text.ParseException
Sets the entity-tag value of this header.

Parameters:
etag - the new value of the entity-tag
Throws:
java.text.ParseException - if the ETag syntax is invalid (not a valid token)

JSIP API v1.2
November 2006

If you have any comments, please mail them to JAIN-SIP-INTEREST@java.sun.com after subscribing at http://archives.java.sun.com
Copyright - 2006 BEA Systems and Sun Microsystems