io.pkts.packet.sip.header

Interface RecordRouteHeader

All Superinterfaces:

AddressParametersHeader, Cloneable, HeaderAddress, Parameters, SipHeader

All Known Implementing Classes:

RecordRouteHeaderImpl

public interface RecordRouteHeader
extends AddressParametersHeader

Source: RFC 3261 section 20.30

The Record-Route header field is inserted by proxies in a request to force future requests in the dialog to be routed through the proxy.

Examples of its use with the Route header field are described in Sections 16.12.1.

Example:

    Record-Route: <sip:server10.biloxi.com;lr>,
                  <sip:bigbox3.site3.atlanta.com;lr>
 

Author:

jonas@jonasborjesson.com

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RecordRouteHeader.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static Buffer	NAME

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

CANNOT_CAST_HEADER_OF_TYPE, UNABLE_TO_PARSE_OUT_THE_HEADER_NAME_DUE_TO_UNDERLYING_IO_EXCEPTION

Method Summary

Modifier and Type	Method and Description
RecordRouteHeader	clone()
RecordRouteHeader.Builder	copy() Everything within the pkts.io SIP module are immutable so if you actually want to change anything you have to create a copy, which will return a specific Builder for that header.
static RecordRouteHeader	frame(Buffer buffer) Frame the value as a RecordRouteHeader.
default boolean	isRecordRouteHeader()
default RecordRouteHeader	toRecordRouteHeader()
static RecordRouteHeader.Builder	withAddress(Address address)
static RecordRouteHeader.Builder	withHost(Buffer host)
static RecordRouteHeader.Builder	withHost(String host)
static RecordRouteHeader.Builder	withUser(Buffer user)
static RecordRouteHeader.Builder	withUser(String user)

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

isAddressParametersHeader, toAddressParametersHeader, with

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

getAddress

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

getParameter, getParameter, setParameter, setParameter

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

create, ensure, frame, getBufferSize, getBytes, getName, getNameStr, getValue, is, is, isCallIdHeader, isContactHeader, isContentLengthHeader, isContentTypeHeader, isCSeqHeader, isExpiresHeader, isFromHeader, isMaxForwardsHeader, isRouteHeader, isSubjectHeader, isSystemHeader, isToHeader, isViaHeader, toCallIdHeader, toContactHeader, toContentLengthHeader, toContentTypeHeader, toCSeqHeader, toExpiresHeader, toFromHeader, toMaxForwardsHeader, toRouteHeader, toToHeader, toViaHeader, verify

Field Detail

NAME

static final Buffer NAME

Method Detail

clone

RecordRouteHeader clone()

Specified by:

clone in interface SipHeader

frame

static RecordRouteHeader frame(Buffer buffer)
                        throws SipParseException

Frame the value as a RecordRouteHeader.

Specified by:

frame in interface AddressParametersHeader

Specified by:

frame in interface SipHeader

Parameters:

value -

Returns:

Throws:

SipParseException - in case anything goes wrong while parsing.

copy

RecordRouteHeader.Builder copy()

Description copied from interface: SipHeader

Everything within the pkts.io SIP module are immutable so if you actually want to change anything you have to create a copy, which will return a specific Builder for that header.

Specified by:

copy in interface AddressParametersHeader

Specified by:

copy in interface SipHeader

Returns:

isRecordRouteHeader

default boolean isRecordRouteHeader()

Specified by:

isRecordRouteHeader in interface SipHeader

toRecordRouteHeader

default RecordRouteHeader toRecordRouteHeader()

Specified by:

toRecordRouteHeader in interface SipHeader

withUser

static RecordRouteHeader.Builder withUser(Buffer user)

withUser

static RecordRouteHeader.Builder withUser(String user)

withHost

static RecordRouteHeader.Builder withHost(Buffer host)

withHost

static RecordRouteHeader.Builder withHost(String host)

withAddress

static RecordRouteHeader.Builder withAddress(Address address)
                                      throws SipParseException

Throws:

SipParseException