io.pkts.packet.sip.header

Interface FromHeader

All Superinterfaces:

Cloneable, HeaderAddress, Parameters, SipHeader

All Known Implementing Classes:

FromHeaderImpl

public interface FromHeader
extends SipHeader, HeaderAddress, Parameters

Source: RFC 3261 section 8.1.1.3

The From header field indicates the logical identity of the initiator of the request, possibly the user's address-of-record. Like the To header field, it contains a URI and optionally a display name. It is used by SIP elements to determine which processing rules to apply to a request (for example, automatic call rejection). As such, it is very important that the From URI not contain IP addresses or the FQDN of the host on which the UA is running, since these are not logical names.

The From header field allows for a display name. A UAC SHOULD use the display name "Anonymous", along with a syntactically correct, but otherwise meaningless URI (like sip:[email protected]), if the identity of the client is to remain hidden.

Usually, the value that populates the From header field in requests generated by a particular UA is pre-provisioned by the user or by the administrators of the user's local domain. If a particular UA is used by multiple users, it might have switchable profiles that include a URI corresponding to the identity of the profiled user. Recipients of requests can authenticate the originator of a request in order to ascertain that they are who their From header field claims they are (see Section 22 for more on authentication).

The From field MUST contain a new "tag" parameter, chosen by the UAC. See Section 19.3 for details on choosing a tag.

For further information on the From header field, see Section 20.20. Examples:

    From: "Bob" <sips:[email protected]>tag=a48s
    From: sip:[email protected];tag=887s
    From: Anonymous <sip:[email protected]>;tag=hyh8
 

Author:

[email protected]

Field Summary

Fields

Modifier and Type	Field and Description
static Buffer	NAME

Method Summary

Methods

Modifier and Type	Method and Description
FromHeader	clone()
Buffer	getTag() Get the tag parameter.

Methods inherited from interface io.pkts.packet.sip.header.HeaderAddress

getAddress

Methods inherited from interface io.pkts.packet.sip.header.Parameters

getParameter, getParameter, setParameter

Methods inherited from interface io.pkts.packet.sip.header.SipHeader

getBytes, getName, getValue, verify

Field Detail

NAME

static final Buffer NAME

Method Detail

getTag

Buffer getTag()
              throws SipParseException

Get the tag parameter.

Returns:

the tag or null if it hasn't been set.

Throws:

SipParseException - in case anything goes wrong while extracting tag.

clone

FromHeader clone()

Specified by:

clone in interface SipHeader