Java Doc for SipURI.java in  » 6.0-JDK-Modules » Java-Advanced-Imaging » javax » sip » address » Java Source Code / Java DocumentationJava Source Code and Java Documentation

SIP and SIPS URIs are used for addressing. They are similar to email addresses in that they are of the form user@host where user is either a user name or telephone number, and host is a host or domain name, or a numeric IP address. Additionally, SIP and SIPS URIs may contain parameters and headers (although headers are not legal in all contexts). A SipURI can be embedded in web pages, business cards or other hyperlinks to indicate that a particular user or service can be called via SIP.

Within a SIP Message, SipURIs are used to indicate the source and intended destination of a Request, redirection addresses and the current destination of a Request. Normally all these Headers will contain SipURIs.

Syntactically, SIP and SIPS URIs are identical except for the name of the URI scheme. The semantics differs in that the SIPS scheme implies that the identified resource is to be contacted using TLS. Because SIP and SIPS URIs are syntactically identical and because they're used the same way, they're both represented by the SipURI interface.

The SipURI interface extends the generic URI interface and provides additional convenience methods for the following components of a SipURI address, above the generic URI interface:

• User - The set of valid telephone-subscriber strings is a subset of valid user strings. The user URI parameter exists to distinguish telephone numbers from user names that happen to look like telephone numbers. If the user string contains a telephone number formatted as a telephone-subscriber, the user parameter value "phone" SHOULD be present. Even without this parameter, recipients of SIP and SIPS URIs MAY interpret the pre-@ part as a telephone number if local restrictions on the name space for user name allow it.
• UserPassword - A password associated with the user. While the SIP and SIPS URI syntax allows this field to be present, its use is NOT RECOMMENDED, because the passing of authentication information in clear text (such as URIs) has proven to be a security risk in almost every case where it has been used. For instance, transporting a PIN number in this field exposes the PIN.
• URI parameters - Parameters affecting a request constructed from this URI. URI parameters are added after the hostport component and are separated by semi-colons. URI parameters take the form:
  parameter-name "=" parameter-value
  Even though an arbitrary number of URI parameters may be included in a URI, any given parameter-name MUST NOT appear more than once. The SipURI interface also provides convenience methods for the manipulation of popular parameters in a SipURI address, namely:
  • Lr Parameter - the element responsible for this resource implements the routing mechanisms specified in RFC 3261.
  • Method - The method of the SIP request constructed from the URI.
  • MAddr Parameter - the server address to be contacted for this user.
  • TTL Parameter - the time-to-live value when packets are sent using UDP multicast.
  • User Parameter - the set of valid telephone-subscriber strings.
  • Transport Parameter - specifies which transport protocol to use for sending requests and responses to this entity
• URI Headers - Header fields to be included in a request constructed from the URI. Headers fields in the SIP request can be specified with the "?" mechanism within a URI. The header names and values are encoded in ampersand separated 'hname = hvalue' pairs. The special hname "body" indicates that the associated hvalue is the message-body of the SIP request.
• Secure - This determines if the scheme of this URI is either sip: or sips:, where sips: is secure.

This is equivalent to getParameter("user"). the value of the userParam of the SipURI