Skip navigation links

com.convergin.common.sal.ext.api
Interface SipURI

All Superinterfaces:

java.lang.Cloneable, URI

public interface SipURI

extends URI

Method Summary

java.lang.String	getHeader(java.lang.String name) Returns the value of the specified header.
java.util.Iterator<java.lang.String>	getHeaderNames() Returns an Iterator over the names of all headers present in this SipURI.
java.lang.String	getHost() Returns the host part of this SipURI.
boolean	getLrParam() Returns true if the "lr" flag parameter is set, and false otherwise.
int	getPort() Returns the port number of this SipURI, or -1 if this is not set.
java.lang.String	getUser() Returns the user part of this SipURI.
java.lang.String	getUserParam() Returns the value of the "user" parameter, or null if this is not set.
void	removeHeader(java.lang.String name) Removes the specified Header
void	setHeader(java.lang.String name, java.lang.String value) Sets the value of the specified header in this SipURI.
void	setHost(java.lang.String host) Sets the host part of this SipURI.
void	setLrParam(boolean lr) Sets or removes the "lr" parameter depending on the value of the flag.
void	setPort(int port) Sets the port number of this SipURI.
void	setUser(java.lang.String user) Sets the user part of this SipURI.
void	setUserParam(java.lang.String userParam) ets the value of the "user" parameter.
java.lang.String	toString() Returns the String representation of this SipURI.

Methods inherited from interface com.convergin.common.sal.ext.api.URI

clone, equals, getParameter, getParameterNames, getScheme, isSipURI, removeParameter, setParameter

Method Detail

getUser

java.lang.String getUser()

Returns the user part of this SipURI.

Returns:

the user part of this SipURI

setUser

void setUser(java.lang.String user)

Sets the user part of this SipURI.

Parameters:

user - - the new user part

getHost

java.lang.String getHost()

Returns the host part of this SipURI.

Returns:

the host part of this SipURI

setHost

void setHost(java.lang.String host)

Sets the host part of this SipURI. This should be a fully qualified domain name or a numeric IP address.

Parameters:

host - - the new host name

getPort

int getPort()

Returns the port number of this SipURI, or -1 if this is not set.

Returns:

the port number of this SipURI

setPort

void setPort(int port)

Sets the port number of this SipURI.

Parameters:

port - - the new port number. A negative value means the port number is not set and a subsequent call to getPort() should return -1.

getUserParam

java.lang.String getUserParam()

Returns the value of the "user" parameter, or null if this is not set. This is equivalent to getParameter("user").

Returns:

the value of the "user" parameter

setUserParam

void setUserParam(java.lang.String userParam)

ets the value of the "user" parameter. This is equivalent to setParameter("user", user).

Parameters:

userParam - new value for the "user" parameter

getLrParam

boolean getLrParam()

Returns true if the "lr" flag parameter is set, and false otherwise. This is equivalent to "".equals(getParameter("lr")).

Returns:

true if the "lr" flag parameter is set, and false otherwise

setLrParam

void setLrParam(boolean lr)

Sets or removes the "lr" parameter depending on the value of the flag.

Parameters:

lr - specifies that the "lr" flag parameter is to be set (true) or removed (false)

getHeader

java.lang.String getHeader(java.lang.String name)

Returns the value of the specified header. SIP/SIPS URIs may specify headers. As an example, the URI sip:joe@example.com?Priority=emergency has a header "Priority" whose value is "emergency".

Parameters:

name - the header name

Returns:

the value of the specified header in this SipURI

setHeader

void setHeader(java.lang.String name,
               java.lang.String value)

Sets the value of the specified header in this SipURI.

Parameters:

name - header name

value - header value

removeHeader

void removeHeader(java.lang.String name)

Removes the specified Header

Parameters:

name - Header name

getHeaderNames

java.util.Iterator<java.lang.String> getHeaderNames()

Returns an Iterator over the names of all headers present in this SipURI.

Returns:

an Iterator over all header names

toString

java.lang.String toString()

Returns the String representation of this SipURI.

Specified by:

toString in interface URI

Overrides:

toString in class java.lang.Object

Returns:

this sip or sips URI as a String

Skip navigation links