org.mjsip.sip.header

Class ViaHeader

java.lang.Object

org.mjsip.sip.header.Header

org.mjsip.sip.header.ParametricHeader

org.mjsip.sip.header.ViaHeader

public class ViaHeader
extends ParametricHeader

SIP Header Via. The Via header field indicates the transport used for the transaction and identifies the location where the response is to be sent.
When the UAC creates a request, it MUST insert a Via into that request. The protocol name and protocol version in the header field is SIP and 2.0, respectively.
The Via header field value MUST contain a branch parameter. This parameter is used to identify the transaction created by that request. This parameter is used by both the client and the server.
The branch parameter value MUST be unique across space and time for all requests sent by the UA. The exceptions to this rule are CANCEL and ACK for non-2xx responses. A CANCEL request will have the same value of the branch parameter as the request it cancels. An ACK for a non-2xx response will also have the same branch ID as the INVITE whose response it acknowledges.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	branch_param "branch" parameter
protected static java.lang.String	maddr_param "maddr" parameter
static java.lang.String	MAGIC_COOKIE "z9hG4bK" magic cookie
protected static java.lang.String	received_param "received" parameter
protected static java.lang.String	rport_param "rport" parameter
protected static java.lang.String	ttl_param "maddr" parameter

Fields inherited from class org.mjsip.sip.header.Header

name, value

Constructor Summary

Constructors

Constructor and Description
ViaHeader(Header hd) Creates a new ViaHeader.
ViaHeader(java.lang.String hvalue) Creates a new ViaHeader.
ViaHeader(java.lang.String host, int port) Creates a new ViaHeader.
ViaHeader(java.lang.String proto, java.lang.String host, int port) Creates a new ViaHeader.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBranch() Gets "branch" parameter.
java.lang.String	getHost() Gets host of ViaHeader.
java.lang.String	getMaddr() Gets "maddr" parameter.
int	getPort() Gets port of ViaHeader.
java.lang.String	getProtocol() Gets the transport protocol.
java.lang.String	getReceived() Gets "received" parameter.
int	getRport() Gets "rport" parameter.
java.lang.String	getSentBy() Gets "sent-by" parameter.
SipURI	getSipURI() Makes a SipURI from ViaHeader.
int	getTtl() Gets "ttl" parameter.
boolean	hasBranch() Checks if "branch" parameter is present.
boolean	hasMaddr() Checks if "maddr" parameter is present.
boolean	hasPort() Returns boolean value indicating if ViaHeader has port.
boolean	hasReceived() Checks if "received" parameter is present.
boolean	hasRport() Checks if "rport" parameter is present.
boolean	hasTtl() Checks if "ttl" parameter is present
void	setBranch(java.lang.String value) Sets "branch" parameter.
void	setMaddr(java.lang.String value) Sets "maddr" parameter
void	setProtocol(java.lang.String proto) Sets the transport protocol.
void	setReceived(java.lang.String value) Sets "received" parameter.
void	setRport() Sets "rport" parameter.
void	setRport(int port) Sets "rport" parameter.
void	setTtl(int ttl) Sets "ttl" parameter.

Methods inherited from class org.mjsip.sip.header.ParametricHeader

getParameter, getParameterNames, getParameters, hasParameter, hasParameters, indexOfFirstSemi, removeParameter, removeParameters, setParameter

Methods inherited from class org.mjsip.sip.header.Header

clone, equals, getName, getValue, setValue, toString

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

MAGIC_COOKIE

public static final java.lang.String MAGIC_COOKIE

"z9hG4bK" magic cookie

See Also:

Constant Field Values

received_param

protected static final java.lang.String received_param

"received" parameter

See Also:

Constant Field Values

rport_param

protected static final java.lang.String rport_param

"rport" parameter

See Also:

Constant Field Values

branch_param

protected static final java.lang.String branch_param

"branch" parameter

See Also:

Constant Field Values

maddr_param

protected static final java.lang.String maddr_param

"maddr" parameter

See Also:

Constant Field Values

ttl_param

protected static final java.lang.String ttl_param

"maddr" parameter

See Also:

Constant Field Values

Constructor Detail

ViaHeader

public ViaHeader(java.lang.String hvalue)

Creates a new ViaHeader.

ViaHeader

public ViaHeader(Header hd)

Creates a new ViaHeader.

ViaHeader

public ViaHeader(java.lang.String host,
                 int port)

Creates a new ViaHeader.

ViaHeader

public ViaHeader(java.lang.String proto,
                 java.lang.String host,
                 int port)

Creates a new ViaHeader.

Method Detail

getProtocol

public java.lang.String getProtocol()

Gets the transport protocol.

setProtocol

public void setProtocol(java.lang.String proto)

Sets the transport protocol.

getSentBy

public java.lang.String getSentBy()

Gets "sent-by" parameter.

getHost

public java.lang.String getHost()

Gets host of ViaHeader.

hasPort

public boolean hasPort()

Returns boolean value indicating if ViaHeader has port.

getPort

public int getPort()

Gets port of ViaHeader.

getSipURI

public SipURI getSipURI()

Makes a SipURI from ViaHeader.

hasBranch

public boolean hasBranch()

Checks if "branch" parameter is present.

getBranch

public java.lang.String getBranch()

Gets "branch" parameter.

setBranch

public void setBranch(java.lang.String value)

Sets "branch" parameter.

hasReceived

public boolean hasReceived()

Checks if "received" parameter is present.

getReceived

public java.lang.String getReceived()

Gets "received" parameter.

setReceived

public void setReceived(java.lang.String value)

Sets "received" parameter.

hasRport

public boolean hasRport()

Checks if "rport" parameter is present.

getRport

public int getRport()

Gets "rport" parameter.

setRport

public void setRport()

Sets "rport" parameter.

setRport

public void setRport(int port)

Sets "rport" parameter.

hasMaddr

public boolean hasMaddr()

Checks if "maddr" parameter is present.

getMaddr

public java.lang.String getMaddr()

Gets "maddr" parameter.

setMaddr

public void setMaddr(java.lang.String value)

Sets "maddr" parameter

hasTtl

public boolean hasTtl()

Checks if "ttl" parameter is present

getTtl

public int getTtl()

Gets "ttl" parameter.

setTtl

public void setTtl(int ttl)

Sets "ttl" parameter.