Skip navigation links

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

All Superinterfaces:

java.lang.Cloneable

All Known Subinterfaces:

SipURI, TelURL

public interface URI

extends java.lang.Cloneable

Base interface for any type of URI. These are used in the request line of SAL requests to identify the callee and also in Contact, From, and To headers. The only feature common to all URIs is that they can be represented as strings beginning with a token identifying the scheme of the URI followed by a colon followed by a scheme-specific part. The generic syntax of URIs is defined in RFC 2396.

Method Summary

URI	clone() Returns a clone of this URI.
boolean	equals(java.lang.Object o)
java.lang.String	getParameter(java.lang.String key) Returns the value of the named parameter, or null if it is not set.
java.util.Iterator<java.lang.String>	getParameterNames() Returns an Iterator over the names (Strings) of all parameters present in this SipURI.
java.lang.String	getScheme() Returns the scheme of this URI, for example "sip", "sips" or "tel".
boolean	isSipURI() Returns true if the scheme is "sip" or "sips", false otherwise.
void	removeParameter(java.lang.String name) Removes the specified parameter.
void	setParameter(java.lang.String name, java.lang.String value) Sets the value of the specified parameter.
java.lang.String	toString() Returns the value of this URI as a String.

Method Detail

equals

boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

getParameter

java.lang.String getParameter(java.lang.String key)

Returns the value of the named parameter, or null if it is not set. A zero-length String indicates flag parameter.

Parameters:

key - a String specifying the parameter name

Returns:

value of the specified parameter

Throws:

java.lang.NullPointerException - - if the key is null.

getParameterNames

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

Returns an Iterator over the names (Strings) of all parameters present in this SipURI.

Returns:

an Iterator over all parameter names

removeParameter

void removeParameter(java.lang.String name)

Removes the specified parameter.

Parameters:

name - parameter name

setParameter

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

Sets the value of the specified parameter. If the parameter already had a value it will be overwritten. A zero-length String indicates flag parameter.

Parameters:

name - - parameter name

value - - new parameter value

getScheme

java.lang.String getScheme()

Returns the scheme of this URI, for example "sip", "sips" or "tel".

Returns:

the scheme of this URI

toString

java.lang.String toString()

Returns the value of this URI as a String. The result must be appropriately URL escaped.

Overrides:

toString in class java.lang.Object

Returns:

String value of this URI

isSipURI

boolean isSipURI()

Returns true if the scheme is "sip" or "sips", false otherwise.

Returns:

true if the scheme is "sip" or "sips", false otherwise

clone

URI clone()

Returns a clone of this URI.

Returns:

a clone of this URI

Skip navigation links