io.pkts.packet.sip.header

Interface ContactHeader

All Superinterfaces:

AddressParametersHeader, Cloneable, HeaderAddress, Parameters, SipHeader

All Known Implementing Classes:

ContactHeaderImpl

public interface ContactHeader
extends AddressParametersHeader

Author:

jonas@jonasborjesson.com

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ContactHeader.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static Buffer	COMPACT_NAME
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
ContactHeader	clone()
ContactHeader.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 ContactHeader	frame(Buffer buffer) Frame the value as a ContactHeader.
default boolean	isContactHeader() Check whether this is a contact header.
default ContactHeader	toContactHeader()
static ContactHeader.Builder	with()
static ContactHeader.Builder	withAddress(Address address)
static ContactHeader.Builder	withHost(Buffer host)
static ContactHeader.Builder	withHost(String host)
static ContactHeader.Builder	withSipURI(SipURI uri)

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, isContentLengthHeader, isContentTypeHeader, isCSeqHeader, isExpiresHeader, isFromHeader, isMaxForwardsHeader, isRecordRouteHeader, isRouteHeader, isSubjectHeader, isSystemHeader, isToHeader, isViaHeader, toCallIdHeader, toContentLengthHeader, toContentTypeHeader, toCSeqHeader, toExpiresHeader, toFromHeader, toMaxForwardsHeader, toRecordRouteHeader, toRouteHeader, toToHeader, toViaHeader, verify

Field Detail

NAME

static final Buffer NAME

COMPACT_NAME

static final Buffer COMPACT_NAME

Method Detail

clone

ContactHeader clone()

Specified by:

clone in interface SipHeader

with

static ContactHeader.Builder with()

withAddress

static ContactHeader.Builder withAddress(Address address)
                                  throws SipParseException

Throws:

SipParseException

withHost

static ContactHeader.Builder withHost(Buffer host)
                               throws SipParseException

Throws:

SipParseException

withHost

static ContactHeader.Builder withHost(String host)
                               throws SipParseException

Throws:

SipParseException

withSipURI

static ContactHeader.Builder withSipURI(SipURI uri)
                                 throws SipParseException

Throws:

SipParseException

frame

static ContactHeader frame(Buffer buffer)
                    throws SipParseException

Frame the value as a ContactHeader.

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

ContactHeader.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:

isContactHeader

default boolean isContactHeader()

Description copied from interface: SipHeader

Check whether this is a contact header. Note: if this is true you MUST still do SipHeader.ensure().SipHeader.toContactHeader() because the way this method works is that if the header hasn't been fully framed then the default method, which is on the SipHeader itself, will check the method name if it "spells" "Contact". However, if the header you have really has been parsed into a ContactHeader then this method will be overridden to return true right away but since you cannot know that you must force it to be framed (if you actually want to work with the ContactHeader interface i.e.), which is done by calling SipHeader.ensure().

Specified by:

isContactHeader in interface SipHeader

Returns:

toContactHeader

default ContactHeader toContactHeader()

Specified by:

toContactHeader in interface SipHeader