public interface Address
Address
is an opaque object to represents SIP addresses, ie the
content of SIP's 'from' and 'to' headers. A SIP address is made of display
name, username, domain name, port, and various uri headers (such as tags). It
looks like 'Alice Address
has methods to
extract and manipulate all parts of the address. When some part of the address
(for example the username) is empty, the accessor methods return null.Modifier and Type | Method and Description |
---|---|
java.lang.String |
asString()
Returns the address as a string.
|
java.lang.String |
asStringUriOnly()
Returns the SIP uri only as a string, that is display name is removed.
|
void |
clean()
Removes address's tags and uri headers so that it is displayable to the user.
|
Address |
clone()
Clones a
Address object. |
boolean |
equal(Address address2)
Compare two
Address taking the tags and headers into account. |
java.lang.String |
getDisplayName()
Returns the display name.
|
java.lang.String |
getDomain()
Returns the domain name.
|
java.lang.String |
getHeader(java.lang.String headerName)
Get the header encoded in the address.
|
java.lang.String |
getMethodParam()
Get the value of the method parameter.
|
java.lang.String |
getParam(java.lang.String paramName)
Get the value of a parameter of the address.
|
java.lang.String |
getPassword()
Get the password encoded in the address.
|
int |
getPort()
Get port number as an integer value, 0 if not present.
|
java.lang.String |
getScheme()
Returns the address scheme, normally "sip".
|
boolean |
getSecure()
Returns true if address refers to a secure location (sips)
|
TransportType |
getTransport()
Get the transport.
|
java.lang.String |
getUriParam(java.lang.String uriParamName)
Get the value of a parameter of the URI of the address.
|
java.lang.Object |
getUserData()
Gets the object stored in this object user's data
|
java.lang.String |
getUsername()
Returns the username.
|
boolean |
hasParam(java.lang.String paramName)
Tell whether a parameter is present in the address.
|
boolean |
hasUriParam(java.lang.String uriParamName)
Tell whether a parameter is present in the URI of the address.
|
boolean |
isSip()
returns true if address is a routable sip address
|
void |
removeUriParam(java.lang.String uriParamName)
Removes the value of a parameter of the URI of the address.
|
int |
setDisplayName(java.lang.String displayName)
Sets the display name.
|
int |
setDomain(java.lang.String domain)
Sets the domain.
|
void |
setHeader(java.lang.String headerName,
java.lang.String headerValue)
Set a header into the address.
|
void |
setMethodParam(java.lang.String methodParam)
Set the value of the method parameter.
|
void |
setParam(java.lang.String paramName,
java.lang.String paramValue)
Set the value of a parameter of the address.
|
void |
setPassword(java.lang.String password)
Set the password encoded in the address.
|
int |
setPort(int port)
Sets the port number.
|
void |
setSecure(boolean enabled)
Make the address refer to a secure location (sips scheme)
|
int |
setTransport(TransportType transport)
Set a transport.
|
void |
setUriParam(java.lang.String uriParamName,
java.lang.String uriParamValue)
Set the value of a parameter of the URI of the address.
|
void |
setUserData(java.lang.Object data)
Sets the object to store in this object user's data
|
int |
setUsername(java.lang.String username)
Sets the username.
|
boolean |
weakEqual(Address address2)
Compare two
Address ignoring tags and headers, basically just domain,
username, and port. |
java.lang.String getDisplayName()
int setDisplayName(java.lang.String displayName)
java.lang.String getDomain()
int setDomain(java.lang.String domain)
boolean isSip()
java.lang.String getMethodParam()
void setMethodParam(java.lang.String methodParam)
java.lang.String getPassword()
void setPassword(java.lang.String password)
password
- the password to set.int getPort()
int setPort(int port)
java.lang.String getScheme()
boolean getSecure()
void setSecure(boolean enabled)
enabled
- if address is requested to be secure.TransportType getTransport()
int setTransport(TransportType transport)
java.lang.String getUsername()
int setUsername(java.lang.String username)
java.lang.String asString()
java.lang.String asStringUriOnly()
void clean()
boolean equal(Address address2)
Address
taking the tags and headers into account.address2
- Address
objectAddress
objects are equal.
See also: weakEqual(org.linphone.core.Address)
java.lang.String getHeader(java.lang.String headerName)
headerName
- the header namejava.lang.String getParam(java.lang.String paramName)
paramName
- The name of the parameterjava.lang.String getUriParam(java.lang.String uriParamName)
uriParamName
- The name of the parameterboolean hasParam(java.lang.String paramName)
paramName
- The name of the parameterboolean hasUriParam(java.lang.String uriParamName)
uriParamName
- The name of the parametervoid removeUriParam(java.lang.String uriParamName)
uriParamName
- The name of the parametervoid setHeader(java.lang.String headerName, java.lang.String headerValue)
headerValue
- the header valuevoid setParam(java.lang.String paramName, java.lang.String paramValue)
paramValue
- The new value of the parametervoid setUriParam(java.lang.String uriParamName, java.lang.String uriParamValue)
uriParamValue
- The new value of the parameterboolean weakEqual(Address address2)
Address
ignoring tags and headers, basically just domain,
username, and port.address2
- Address
objectAddress
objects are equal.
See also: equal(org.linphone.core.Address)
void setUserData(java.lang.Object data)
data
- the object to storejava.lang.Object getUserData()