javax.sip.header

Interface SIPIfMatchHeader

All Superinterfaces:

Cloneable, Header, Serializable

All Known Implementing Classes:

SIPIfMatch

public interface SIPIfMatchHeader
extends Header

This interface represents the SIP-If-Match header, as defined by RFC3903.

The SIP-If-Match header is used by a client (event state publisher) in a PUBLISH request, to update previously published event state. The value is obtained from the server in a SIPETagHeader in a 2xx response to a previous PUBLISH.

Sample syntax:
SIP-If-Match: 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

Fields

Modifier and Type	Field and Description
static String	NAME Name of this header (no short form.

Method Summary

Methods

Modifier and Type	Method and Description
String	getETag() Returns the value of the entity-tag.
void	setETag(String etag) Sets the entity-tag

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

Parameters:

etag - the new value of the entity-tag.

Throws:

ParseException - if the ETag syntax is invalid (not a valid token)