NIST-SIP: The Reference Implementation for JAIN-SIP 1.2

javax.sip.header
Interface SIPETagHeader

All Superinterfaces:
Cloneable, Header, Serializable
All Known Implementing Classes:
SIPETag

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 String NAME
          Name of this header (no short form).
 
Method Summary
 String getETag()
          Returns the value of the entity-tag.
 void setETag(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 String NAME
Name of this header (no short form).

See Also:
Constant Field Values
Method Detail

getETag

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

Returns:
the entity-tag

setETag

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

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

NIST-SIP: The Reference Implementation for JAIN-SIP 1.2

A product of the NIST/ITL Advanced Networking Technologies Division.
See conditions of use.
Submit a bug report or feature request.