|
NIST SIP Parser and Stack (v1.2) API | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--gov.nist.core.GenericObject | +--gov.nist.javax.sip.header.SIPObject | +--gov.nist.javax.sip.header.SIPHeader | +--gov.nist.javax.sip.header.ParametersHeader | +--gov.nist.javax.sip.header.Via
Via SIPHeader (these are strung together in a ViaList).
ViaList
,
Serialized FormField Summary | |
static String |
BRANCH
The branch parameter is included by every forking proxy. |
static String |
MADDR
The "maddr" paramter is designating the multicast address. |
static String |
RECEIVED
The "received" parameter is added only for receiver-added Via Fields. |
static String |
TTL
The "TTL" parameter is designating the time-to-live value. |
Fields inherited from interface javax.sip.header.ViaHeader |
NAME |
Fields inherited from interface gov.nist.javax.sip.header.SIPHeaderNames |
ACCEPT, ACCEPT_ENCODING, ACCEPT_LANGUAGE, ALERT_INFO, ALLOW, ALLOW_EVENTS, AUTHENTICATION_INFO, AUTHORIZATION, CALL_ID, CALL_INFO, CONTACT, CONTENT_DISPOSITION, CONTENT_ENCODING, CONTENT_LANGUAGE, CONTENT_LENGTH, CONTENT_TYPE, CSEQ, DATE, ERROR_INFO, EVENT, EXPIRES, FROM, IN_REPLY_TO, MAX_FORWARDS, MIME_VERSION, MIN_EXPIRES, ORGANIZATION, PRIORITY, PROXY_AUTHENTICATE, PROXY_AUTHORIZATION, PROXY_REQUIRE, RACK, REASON, RECORD_ROUTE, REPLY_TO, REQUIRE, RETRY_AFTER, ROUTE, RSEQ, SERVER, SUBJECT, SUBSCRIPTION_STATE, SUPPORTED, TIMESTAMP, TO, UNSUPPORTED, USER_AGENT, VIA, WARNING, WWW_AUTHENTICATE |
Constructor Summary | |
Via()
Default constructor |
Method Summary | |
boolean |
equals(Object other)
Compare two via headers for equaltiy. |
String |
getBranch()
Gets the branch paramater of the ViaHeader. |
String |
getComment()
Accessor for the comment field. |
String |
getHost()
Returns the host part of this ViaHeader. |
Host |
getMaddr()
Get the maddr parameter if it exists. |
String |
getMAddr()
Returns the value of the maddr parameter, or null if this
is not set. |
int |
getPort()
Returns the port part of this ViaHeader. |
String |
getProtocol()
Returns the value of the protocol used. |
String |
getProtocolVersion()
get the Protocol Version |
String |
getReceived()
Gets the received paramater of the ViaHeader. |
HostPort |
getSentBy()
Accessor for the sentBy field |
Protocol |
getSentProtocol()
Accessor for the sentProtocol field. |
String |
getTransport()
Returns the value of the transport parameter. |
int |
getTTL()
Returns the value of the ttl parameter, or -1 if this is not set. |
NameValueList |
getViaParms()
Accessor for the parameters field |
boolean |
hasComment()
comment of the Via Header. |
boolean |
hasPort()
port of the Via Header. |
void |
removeComment()
remove the comment field. |
void |
removePort()
remove the port. |
void |
setBranch(String branch)
Sets the branch parameter of the ViaHeader to the newly supplied branch value. |
void |
setComment(String c)
Set the comment member |
void |
setHost(Host host)
set the Host of the Via Header |
void |
setHost(String host)
Set the host part of this ViaHeader to the newly supplied host
parameter. |
void |
setMAddr(String mAddr)
Sets the value of the maddr parameter of this ViaHeader. |
void |
setPort(int port)
Set the port part of this ViaHeader to the newly supplied port
parameter. |
void |
setProtocol(String protocol)
Sets the value of the protocol parameter. |
void |
setProtocolVersion(String protocolVersion)
set the Protocol Version |
void |
setReceived(String received)
Sets the received parameter of ViaHeader. |
void |
setSentBy(HostPort s)
Set the sentBy member |
void |
setSentProtocol(Protocol s)
Set the sentProtocol member |
void |
setTransport(String transport)
Sets the value of the transport. |
void |
setTTL(int ttl)
Sets the value of the ttl parameter. |
Methods inherited from class gov.nist.javax.sip.header.ParametersHeader |
getParameter, getParameterNames, getParameters, getParameterValue, hasParameter, hasParameters, removeParameter, removeParameters, setParameter, setParameter, setParameters, setQuotedParameter |
Methods inherited from class gov.nist.javax.sip.header.SIPHeader |
encode, getHeaderName, getHeaderValue, getName, getValue, isHeaderList, setHeaderName |
Methods inherited from class gov.nist.javax.sip.header.SIPObject |
clone, dbgPrint, debugDump, debugDump, match, merge, replace, replace, replace, replace, toString |
Methods inherited from class gov.nist.core.GenericObject |
getClassFromName, getMatcher, isMySubclass, setMatcher |
Methods inherited from class java.lang.Object |
getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface javax.sip.header.Parameters |
getParameter, getParameterNames, removeParameter, setParameter |
Methods inherited from interface javax.sip.header.Header |
clone, getName, toString |
Field Detail |
public static final String BRANCH
public static final String RECEIVED
public static final String MADDR
public static final String TTL
Constructor Detail |
public Via()
Method Detail |
public boolean equals(Object other)
equals
in interface Header
equals
in class SIPObject
other
- Object to set.
public String getProtocolVersion()
public Protocol getSentProtocol()
public HostPort getSentBy()
public NameValueList getViaParms()
public String getComment()
public Host getMaddr()
public boolean hasPort()
public boolean hasComment()
public void removePort()
public void removeComment()
public void setProtocolVersion(String protocolVersion)
protocolVersion
- String to setpublic void setHost(Host host)
host
- String to setpublic void setSentProtocol(Protocol s)
s
- Protocol to set.public void setSentBy(HostPort s)
s
- HostPort to set.public void setComment(String c)
c
- String to set.public void setHost(String host) throws ParseException
host
parameter.
setHost
in interface ViaHeader
ParseException
- which signals that an error has been reached
unexpectedly while parsing the host value.public String getHost()
getHost
in interface ViaHeader
public void setPort(int port)
port
parameter.
setPort
in interface ViaHeader
port
- - the new interger value of the port of this ViaHeaderpublic int getPort()
getPort
in interface ViaHeader
public String getTransport()
getTransport
in interface ViaHeader
public void setTransport(String transport) throws ParseException
setTransport
in interface ViaHeader
transport
- - new value for the transport parameter
ParseException
- which signals that an error has been reached
unexpectedly while parsing the transport value.public String getProtocol()
getProtocol
in interface ViaHeader
public void setProtocol(String protocol) throws ParseException
setProtocol
in interface ViaHeader
protocol
- - new value for the protocol parameter
ParseException
- which signals that an error has been reached
unexpectedly while parsing the protocol value.public int getTTL()
getTTL
in interface ViaHeader
ttl
parameterpublic void setTTL(int ttl) throws InvalidArgumentException
setTTL
in interface ViaHeader
ttl
- - new value of the ttl parameter
InvalidArgumentException
- if supplied value is less than zero or
greater than 255, excluding -1 the default not set value.public String getMAddr()
maddr
parameter, or null if this
is not set.
getMAddr
in interface ViaHeader
public void setMAddr(String mAddr) throws ParseException
maddr
parameter of this ViaHeader. The
maddr parameter indicates the server address to be contacted for this
user, overriding any address derived from the host field.
setMAddr
in interface ViaHeader
ParseException
- which signals that an error has been reached
unexpectedly while parsing the mAddr value.public String getReceived()
getReceived
in interface ViaHeader
public void setReceived(String received) throws ParseException
setReceived
in interface ViaHeader
received
- - the newly supplied received parameter.
ParseException
- which signals that an error has been reached
unexpectedly while parsing the received value.public String getBranch()
getBranch
in interface ViaHeader
public void setBranch(String branch) throws ParseException
setBranch
in interface ViaHeader
branch
- - the new string branch parmameter of the ViaHeader.
ParseException
- which signals that an error has been reached
unexpectedly while parsing the branch value.
|
NIST SIP Parser and Stack (v1.2) API | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |