javax.servlet.sip
インタフェース SipURI

すべてのスーパーインタフェース:

java.lang.Cloneable, URI

public interface SipURI

extends URI

sipおよびsip URIを表します。
SIPおよびSIPS URIはアドレス指定に使用されます。それらは電子メールアドレスに似ており、 user@host 形式で、userはユーザ名か電話番号の何れかであり、hostはホスト名もしくはドメイン名、または数字のIPアドレスです。 また、SIPおよびSIPS URIには、パラメータやヘッダ(しかしヘッダはどんなコンテクストでもリーガルでない)が含まれるかもしれません。
構文的には、SIPおよびSIPS URIは、URIスキームの名前を除いて同じです。セマンティクスについては、SIPSスキームが特定されたリソースはTLSを使ってコンタクトされることを意味する、という点で異なる。以下はRFC3261からの引用です。

"A SIPS URI specifies that the resource be contacted securely. This means, in particular, that TLS is to be used between the UAC and the domain that owns the URI. From there, secure communications are used to reach the user, where the specific security mechanism depends on the policy of the domain. Any resource described by a SIP URI can be "upgraded" to a SIPS URI by just changing the scheme, if it is desired to communicate with that resource securely."

SIPおよびSIPS URIの文字列フォームには、除外文字が含まれるかもしれません。 SIPサーブレットコンテナは、サーブレットにURI表示する前にそれら文字を除外解除しなければなりません。同様に様々なSIP(S)URIコンポーネントのためにsetterに渡された文字列値 には、使用前に除外する必要がある予約文字または除外文字が含まれるかもしれません。 コンテナはそれら値を除外しなければなりません。

メソッドの概要

java.lang.String	getHeader(java.lang.String name) "lr"フラグパラメータが設定されるか(true)、削除されるか(false)を指定します。
java.util.Iterator	getHeaderNames() このSipURIに存在するすべてのヘッダ名を、Iteratorのデータとして返します。
java.lang.String	getHost() このSipURIのホスト部分を返します。
boolean	getLrParam() "lr"フラグパラメータが設定されている場合はtrueを戻し、そうでない場合はfalseを返します。
java.lang.String	getMAddrParam() "maddr"パラメータの値を返します。
java.lang.String	getMethodParam() "method"パラメータの値を返します。
java.lang.String	getParameter(java.lang.String name) 指定されたパラメータの値を返します。
java.util.Iterator	getParameterNames() このSipURLに存在するすべてのパラメータの名前(Strings)を、Iteratorのデータとして返します。
int	getPort() このSipURLのポート番号を返します。
java.lang.String	getTransportParam() "transport"パラメータの値を返します。
int	getTTLParam() "ttl"パラメータの値を返します。
java.lang.String	getUser() このSipURIのユーザパートを返します。
java.lang.String	getUserParam() "user"パラメータの値を返します。
java.lang.String	getUserPassword() このSipURIのパスワードを返します。
boolean	isSecure() このSipURIがsecureである場合、つまりこれがsips URIを表す場合にはtrueを返します。"
void	removeParameter(java.lang.String name) 指定されたパラメータを削除します。
void	setHeader(java.lang.String name, java.lang.String value) このSipURIで指定されたヘッダの値を 設定します。
void	setHost(java.lang.String host) このSipURIのホスト部分を設定します。
void	setLrParam(boolean flag) フラグの値に応じて、"lr"パラメータを設定／削除します。
void	setMAddrParam(java.lang.String maddr) "maddr"パラメータの値を設定します。
void	setMethodParam(java.lang.String method) "method"パラメータの値を設定します。
void	setParameter(java.lang.String name, java.lang.String value) 指定されたパラメータの値を設定します。
void	setPort(int port) このSipURIのポート番号を設定します。
void	setSecure(boolean b) このURIのスキームを、引数がtrueか否かに応じてsipまたはsipsに設定します。
void	setTransportParam(java.lang.String transport) "transport"パラメータの値を設定します。
void	setTTLParam(int ttl) "ttl"パラメータの値を設定します。
void	setUser(java.lang.String user) このSipURIのユーザパートを設定します。
void	setUserParam(java.lang.String user) "user"パラメータの値を設定します。
void	setUserPassword(java.lang.String password) のSipURIのパスワードを設定します。
java.lang.String	toString() このSipURIのString表記を返します。

インタフェース javax.servlet.sip.URI から継承したメソッド

clone, getScheme, isSipURI

メソッドの詳細

getHeader

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

"lr"フラグパラメータが設定されるか(true)、削除されるか(false)を指定します。

パラメータ:

name - ヘッダ名

戻り値:

このSipURIで指定されたヘッダの値を戻します。

getHeaderNames

public java.util.Iterator getHeaderNames()

このSipURIに存在するすべてのヘッダ名を、Iteratorのデータとして返します。

戻り値:

すべてのヘッダ名を、Iteratorのデータとして返します。

getHost

public java.lang.String getHost()

このSipURIのホスト部分を返します。

戻り値:

このSipURIのホスト部分を返します。

getLrParam

public boolean getLrParam()

"lr"フラグパラメータが設定されている場合はtrueを戻し、そうでない場合はfalseを返します。 これは、 setParameter.equals(getParameter("lr"))に等しいです。

戻り値:

"user"パラメータの新しい値

getMAddrParam

public java.lang.String getMAddrParam()

"maddr"パラメータの値を返します。これが設定されていない場合はnullを返します。これは、getParameter("maddr")に等しい。

戻り値:

"maddr"パラメータの値を返します。

getMethodParam

public java.lang.String getMethodParam()

"method"パラメータの値を返します。これが設定されていない場合にはnullを返します。これは、getParameter("method")に等しいです。

戻り値:

"method"パラメータの値を返します。

getParameter

public java.lang.String getParameter(java.lang.String name)

指定されたパラメータの値を返します。設定されていない場合はnullを返します。長さがゼロのStringは、フラグパラメータを示します。

パラメータ:

name - パラメータ名を指定するString

戻り値:

指定されたパラメータの値を戻す

getParameterNames

public java.util.Iterator getParameterNames()

このSipURLに存在するすべてのパラメータの名前(Strings)を、Iteratorのデータとして返します。

戻り値:

すべてのパラメータの名前を、Iteratorのデータとして返します。

getPort

public int getPort()

このSipURLのポート番号を返します。これが設定されていなければ-1を返します。

戻り値:

このSipURLのポート番号を返します。

getTransportParam

public java.lang.String getTransportParam()

"transport"パラメータの値を返します。これが設定されていない場合はnullを返します。これは、getParameter("transport")に等しいです。

戻り値:

"transport"パラメータの値を返します。

getTTLParam

public int getTTLParam()

"ttl"パラメータの値を返します。これが設定されていない場合は-1を返します。このメソッドは、getParameter("ttl")に等しいです。

戻り値:

"ttl"パラメータの値を返します。これが設定されていない場合は-1を返します。このメソッドは、getParameter("ttl")に等しいです。

getUser

public java.lang.String getUser()

このSipURIのユーザパートを返します。

戻り値:

このSipURIのユーザパートを返します

getUserParam

public java.lang.String getUserParam()

"user"パラメータの値を返します。これが設定されていない場合はnullを返します。これは、getParameter("user")に等しいです。

戻り値:

"user"パラメータの値を返します。

getUserPassword

public java.lang.String getUserPassword()

このSipURIのパスワードを返します。これが設定されていない場合はnullを返します。

戻り値:

このSipURIのパスワードを返します。

isSecure

public boolean isSecure()

このSipURIがsecureである場合、つまりこれがsips URIを表す場合にはtrueを返します。"通常の"sip URIsの場合には、falseを返します。

戻り値:

このSipURIがsips URIを表す場合にはtrueを戻し、sip URIを表す場合にはfalseを返します。

removeParameter

public void removeParameter(java.lang.String name)

指定されたパラメータを削除します。

パラメータ:

name - パラメータ名

setHeader

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

このSipURIで指定されたヘッダの値を 設定します。

パラメータ:

name - ヘッダ名

value - ヘッダの値

setHost

public void setHost(java.lang.String host)

このSipURIのホスト部分を設定します。 これは、完全に記述されたドメイン名または数字のIPアドレスであるべきです。

パラメータ:

host - 新しいホスト名

setLrParam

public void setLrParam(boolean flag)

フラグの値に応じて、"lr"パラメータを設定／削除します。

パラメータ:

flag - "lr"フラグパラメータが設定されるか(true)、削除されるか(false)を指定します。

setMAddrParam

public void setMAddrParam(java.lang.String maddr)

"maddr"パラメータの値を設定します。これは、setParameter("maddr", maddr)に等しいです。

パラメータ:

maddr - "maddr"パラメータの新しい値

setMethodParam

public void setMethodParam(java.lang.String method)

"method"パラメータの値を設定します。これは、このSIP/SIPS URIに宛てられるリクエストでどのSIPメソッドを使用するべきかを指定します。
このメソッドは、 setParameter("method", method)に等しいです。

パラメータ:

method - "method"パラメータの新しい値

setParameter

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

指定されたパラメータの値を設定します。パラメータがすでに値を持っている場合は、上書きされます。長さがゼロのStringはフラグパラメータを示します。

パラメータ:

name - パラメータ名

value - 新しいパラメータ値

setPort

public void setPort(int port)

このSipURIのポート番号を設定します。

パラメータ:

port - 新しいポート番号。負の値は、ポート番号が設定されていないことを意味し、またgetPort()への後続の呼は-1を戻すべきです。

setSecure

public void setSecure(boolean b)

このURIのスキームを、引数がtrueか否かに応じてsipまたはsipsに設定します。

パラメータ:

b - このSipURIのスキームを、sipに設定するかsipsに設定するかを決定します。

setTransportParam

public void setTransportParam(java.lang.String transport)

"transport"パラメータの値を設定します。このパラメータは、このエンティティにリクエストや応答を送るためにどのトランスポートプロトコルを使用するべきかを指定します。 以下の値が定義されます。 "udp", "tcp", "sctp", "tls"　しかし、他の値も使用されるかもしれません。
このメソッドは、setParameter("transport", transport)に等しいです。
WebOTX SIP Application Serverは現在"sctp"をサポートしていません。

パラメータ:

transport - "transport"パラメータの新しい値

setTTLParam

public void setTTLParam(int ttl)

"ttl"パラメータの値を設定します。ttlパラメータは、UDPマルチキャストを使用してパケットを送る場合にtime-to-liveの値を指定します。
これは、setParameter("ttl", ttl)に等しいです。

パラメータ:

ttl - "ttl"パラメータの新しい値

setUser

public void setUser(java.lang.String user)

このSipURIのユーザパートを設定します。

パラメータ:

user - 新しいユーザパート

setUserParam

public void setUserParam(java.lang.String user)

"user"パラメータの値を設定します。 これは、 setParameter("user", user)に等しいです。

パラメータ:

user - "user"パラメータの新しい値

setUserPassword

public void setUserPassword(java.lang.String password)

のSipURIのパスワードを設定します。 SIPまたはSIPS URIでのパスワードの使用は、 クリアテキストでパスワードを送ることがセキュリティリスクを招く要因になるので、推奨しない。

パラメータ:

password - 新しいパスワード

toString

public java.lang.String toString()

このSipURIのString表記を返します。
クラスjava.lang.ObjectでtoStringをオーバーライドします。

定義:

インタフェース URI 内の toString

戻り値:

このsipまたはsips URIをStringとして返します。