| javax.sip.address.TelURL
| TelURL | | public interface TelURL extends URI,Parameters(Code) | | This class represents Tel URLs, which are used for addressing. The Tel URL
starts with the scheme tel:. This tells the
local entity that what follows is a URL that should be parsed as described
in RFC2806. After that,
the URL contains the phone number of the remote entity.
Within a SIP Message, TelURLs can be used to indicate the source and intended
destination of a Request, redirection addresses and the current destination
of a Request. All these Headers may contain TelURLs.
The TelURL interface extends the generic URI interface and provides
additional convenience methods for the following components of a TelURL
address, above the generic URI class:
- ISDN Subaddress - Phone numbers can also contain subaddresses, which
are used to identify different remote entities under the same phone number.
- Post Dial - Phone numbers can also contain a post-dial sequence.
This is what is often used with voice mailboxes and other services that
are controlled by dialing numbers from your phone keypad while the call is
in progress.
- Global - Phone numbers can be either "global" or "local". Global numbers
are unambiguous everywhere. Local numbers are usable only within a certain
area.
- URL parameters - Parameters affecting a request constructed from this
URL. URL parameters are added to the end of the URL component and are
separated by semi-colons. URL parameters take the form:
parameter-name "=" parameter-value
See RFC2806 for more
information on the use of TelURL's.
author:
BEA Systems, NIST
version:
1.2 |
| getIsdnSubAddress | | public String getIsdnSubAddress()(Code) | | Returns the value of the isdnSubAddress parameter, or null
if it is not set.
the value of the isdnSubAddress parameter |
| getPhoneContext | | public String getPhoneContext()(Code) | | Returns the value of the phoneContext parameter, or null
if it is not set.
the value of the phoneContext parameter
since:
v1.2 |
| getPhoneNumber | | public String getPhoneNumber()(Code) | | Returns the value of the phoneNumber parameter. This method
will not return the "+" associated with telephone numbers.
the value of the phoneNumber parameter |
| getPostDial | | public String getPostDial()(Code) | | Returns the value of the postDial parameter, or null if it
is not set.
the value of the postDial parameter |
| isGlobal | | public boolean isGlobal()(Code) | | Returns true if this TelURL is global i.e. if the TelURI
has a global phone user.
true if this TelURL represents a global phone user,and false otherwise. |
| setGlobal | | public void setGlobal(boolean global)(Code) | | Sets phone user of this TelURL to be either global or local. The default
value is false, hence the TelURL is defaulted to local.
Parameters:
global - - the boolean value indicating if the TelURL has a globalphone user. |
| setIsdnSubAddress | | public void setIsdnSubAddress(String isdnSubAddress) throws ParseException(Code) | | Sets ISDN subaddress of this TelURL. If a subaddress is present, it is
appended to the phone number after ";isub=".
Parameters:
isdnSubAddress - - new value of the isdnSubAddressparameter
throws:
ParseException - which signals that an error has been reachedunexpectedly while parsing the isdnSubAddress value. |
| setPhoneContext | | public void setPhoneContext(String phoneContext) throws ParseException(Code) | | Sets the phone context of this TelURL.
Parameters:
phoneContext - - new value of the phoneContextparameter
throws:
ParseException - which signals that an error has been reachedunexpectedly while parsing the phoneContext value.
since:
v1.2 |
| setPhoneNumber | | public void setPhoneNumber(String phoneNumber) throws ParseException(Code) | | Sets phone number of this TelURL. The phone number may either be local or
global determined by the isGlobal method in this interface. The phoneNumber
argument should not contain the "+" associated with telephone numbers.
Parameters:
phoneNumber - - new value of the phoneNumber parameter
throws:
ParseException - which signals that an error has been reachedunexpectedly while parsing the phoneNumber value. |
| setPostDial | | public void setPostDial(String postDial) throws ParseException(Code) | | Sets post dial of this TelURL. The post-dial sequence describes what and
when the local entity should send to the phone line.
Parameters:
postDial - - new value of the postDial parameter
throws:
ParseException - which signals that an error has been reachedunexpectedly while parsing the postDial value. |
| toString | | public String toString()(Code) | | This method returns the URI as a string.
String The stringified version of the URI |
|
|