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

すべてのスーパーインタフェース:
javax.servlet.ServletResponse, SipServletMessage

public interface SipServletResponse
extends javax.servlet.ServletResponse, SipServletMessage

SIP応答を表します。 このクラスのインスタンスは、コンテナが受信したSIP応答を受け取るときにサーブレットに渡されます。 また、UAサーバまたはプロキシとしてとして機能するサーブレットは、SipServletResponseを作成することにより自らのSIP応答を生成します。
SIP応答は、対応するリクエストの結果を示す3桁のステータスコードを持っています。 ステータスコードが100-199(1xx's)の範囲の応答は、暫定または情報応答と呼ばれ、リクエスト処理の進捗状況を示します。 ステータスコードが200以上の応答は、最終応答です。UAサーバはリクエストごとに1つしか最終応答を送らないかもしれないが、この前には、 多数の暫定応答が先行しているかもしれません。
2xx応答は成功の結果を示す一方、3xx-6xxは、さまざまな失敗の状況を示します。
ステータスコードの概要はRFC3261です。


フィールドの概要
static int SC_ACCEPTED
          リクエストは処理のためにを受け入れられているが、処理が完了していないことを示すステータスコード(202)。
static int SC_ADDRESS_INCOMPLETE
          サーバが、不完全なTo(Section6.37)アドレスまたはRequest-URIを持つリクエストを受け取ったことを示すステータスコード(484)。
static int SC_ALTERNATIVE_SERVICE
          代替えのサービスを示すステータスコード(380)。
static int SC_AMBIGUOUS
          リクエストで提供された着呼側のアドレスが不明瞭であったことを示すステータスコード(485)。
static int SC_BAD_EXTENSION
          サーバがRequire(Section 6.30) ヘッダフィールドに指定されたプロトコル拡張を理解しなかったことを示すステータスコード(420)。
static int SC_BAD_GATEWAY
          サーバが、ゲートウェイまたはプロキシとして機能している間に、 リクエストを実行しようとしてアクセスしたダウンストリームのサーバから無効な応答を受け取ったことを示すステータスコード(502)。
static int SC_BAD_REQUEST
          Bad Requestを示すステータスコード(400)。
static int SC_BUSY_EVERYWHERE
          着呼側のエンドシステムとは問題なくコンタクトをとったが、着呼側がビジーで、今回は呼を取らないということを示すステータスコード(600)。
static int SC_BUSY_HERE
          着呼側のエンドシステムとは問題なくコンタクトをとったが、着呼側は現在は追加の呼を取らない、または取ることができないということを示すステータスコード(486)。
static int SC_CALL_BEING_FORWARDED
          呼が転送されてていることを示すステータスコード(181)。
static int SC_CALL_LEG_DONE
          Call Leg/Transactionが存在しないことを示すステータスコード(481)。
static int SC_CALL_QUEUED
          呼がキューに入れられていることを示すステータスコード(182)。
static int SC_DECLINE
          着呼側のマシンとは問題なくコンタクトをとったが、ユーザが明確に参加しないか、または参加できないことを示すステータスコード(603)。
static int SC_DOES_NOT_EXIT_ANYWHERE
          サーバが、Toリクエストフィールドに示されたユーザがどこにも存在しないという正式な情報を持っていることを示すステータスコード(604)。
static int SC_EXTENSION_REQUIRED
          UASが、リクエストを処理するために特定の拡張を必要とするが、この拡張はリクエストのSupportedヘッダフィールドに載っていないことを示すステータスコード(421)。
static int SC_FORBIDDEN
          発呼側がそのようなリクエストを行うことを禁止されていることを示すステータスコード(403)。
static int SC_GONE
          リクエストされたリソースは、サーバで利用不可となっており、転送先アドレスは不明であることを示すステータスコード(410)。
static int SC_INTERVAL_TOO_BRIEF
          リクエストによって更新されたリソースの期限切れ時間が短すぎるため、サーバがリクエストを拒否していることを示すステータスコード(423)。
static int SC_LOOP_DETECTED
          サーバが、自らを含むVia(Section 6.40)パスでリクエストを受け取ったことを示すステータスコード(482)。
static int SC_MESSAGE_TOO_LARGE
          メッセージの長さがその機能を超過したため、サーバがリクエスト処理することができなかったことを示すステータスコード(513)。
static int SC_METHOD_NOT_ALLOWED
          Request-Lineで指定されたメソッドが、Request-URIによって特定されたアドレスに対して許可されていないことを示すステータスコード(405)。
static int SC_MOVED_PERMANENTLY
          着呼側が永久的に移動していることを示すステータスコード(301)。
static int SC_MOVED_TEMPORARILY
          着呼側が一時的に移動していることを示すステータスコード(302)。
static int SC_MULTIPLE_CHOICES
          Multiple Choicesを示すステータスコード(300)。
static int SC_NOT_ACCEPTABLE
          リクエストにより特定されたリソースが、リクエストで送られた受け入れヘッダに応じて、内容の特性を受け入れ不可とする応答エンティティを生成することのみ可能であることを示すステータスコード(406)。
static int SC_NOT_ACCEPTABLE_ANYWHERE
          ユーザのエージェントとは問題なくコンタクトをとったが、リクエストされたメディア、 帯域幅またアドレス指定スタイルなどのセッション説明のいくつかのアスペクトが受け入れできなかったことを示すステータスコード(606)。
static int SC_NOT_ACCEPTABLE_HERE
          応答は、606(Not Acceptable)と同じ意味をもつが、Request-URIによってアドレス指定された特定のリソースにのみ適用され、またリクエストは他の場所で成功する可能性があることを示すステータスコード(488)。
static int SC_NOT_FOUND
          サーバは、ユーザがRequest-URIに指定されたドメインに存在しないという確実な情報を持っていたこと示すステータスコード(404)。
static int SC_NOT_IMPLEMENTED
          サーバが、リクエストを実現するために要求される機能をサポートしないことを示すステータスコード(501)。
static int SC_OK
          .リクエストが正常に成功したことを示すステータスコード(200)。
static int SC_PAYMENT_REQUIRED
          発呼側が支払いをする必要があることを示すステータスコード(402)。
static int SC_PROXY_AUTHENTICATION_REQUIRED
          クライアントがますプロキシで自らを認証しなければならないことを示すステータスコード(407)。
static int SC_REQUEST_ENTITY_TOO_LARGE
          リクエストエンティティが、サーバが処理する/できるより大きいため、サーバはリクエストの処理を拒否していることを示すステータスコード(413)。
static int SC_REQUEST_PENDING
          リクエストが、同じダイアログ内で保留リクエストを所有していたUASによって受信されたことを示すステータスコード(491)。
static int SC_REQUEST_TERMINATED
          リクエストがBYEまたはCANCELリクエストによって終了されたことを示すステータスコード(487)。
static int SC_REQUEST_TIMEOUT
          サーバが、ユーザロケーションなどの応答を、Expiresリクエストヘッダフィールドに示された時間内に生成できなかったことを示すステータスコード(408)。
static int SC_REQUEST_URI_TOO_LONG
          サーバが解釈するよりRequest-URIが長いため、サーバがリクエストをサービスすることを拒否していることを示すステータスコード(414)。.
static int SC_RINGING
          サーバが着呼側の所在を特定し、着呼側ユーザエージェントが着呼側を呼び出していることを示すステータスコード(180)。
static int SC_SERVER_INTERNAL_ERROR
          サーバで、リクエストを実現できない予測不能な状態が発生したことを示すステータスコード(500)。
static int SC_SERVER_TIMEOUT
          サーバが、リクエスト処理しようとしてアクセスした外部のサーバからタイムリーな応答を受信しなかったことを示すステータスコード(504)。
static int SC_SERVICE_UNAVAILABLE
          サーバが、一時的なオーバーロードまたはメンテナンスにより、現在リクエストを処理できないことを示すステータスコード(503)。
static int SC_SESSION_PROGRESS
          いろいろな呼の進捗情報をもつステータスコード(183)。
static int SC_TEMPORARLY_UNAVAILABLE
          着呼側のエンドシステムとは問題なくコンタクトをとったが、着呼側が現在利用できないこと(例えば、ログインされていない、 または着呼側とのコミュニケーションを排除するような方法でログインされているなど)を示すステータスコード(480)。
static int SC_TOO_MANY_HOPS
          Max-Forwards ヘッダフィールドによって許可される以上のViaエントリ(hops)(Sectopm6.40)を含むリクエストを、 サーバが受け取ったことを示すステータスコード(483)。
static int SC_TRYING
          サーバが着呼側の所在を特定しようとしていることを示すステータスコード(100)。
static int SC_UNAUTHORIZED
          発呼側がこのリクエストを行うことを許可されていないことを示すステータスコード(401)。
static int SC_UNDECIPHERABLE
          受領者が処理しないか、または適切な復号化キーを提供しない、暗号化されたMIMEボディを含んだUASによって、リクエストが受信されたことを示すステータスコード(493)。
static int SC_UNSUPPORTED_MEDIA_TYPE
          リクエストのメッセージボディが、リクエストされたメソッドに対してリクエストされたリソースがサポートしない形式であるために、 サーバーがリクエストをサービスすることを拒否していることを示すステータスコード(415)。
static int SC_UNSUPPORTED_URI_SCHEME
          Request-URIのURIのスキームがサーバには不明であるため、サーバがリクエストを処理できないことを示すステータスコード(416)。
static int SC_USE_PROXY
          その呼は、指定されたプロキシサーバによってよりうまく処理されることが可能であることを示すステータスコード(305)。
static int SC_VERSION_NOT_SUPPORTED
          サーバが、リクエストメッセージで使用されたSIPプロトコルバージョンをサポートしないことを示すステータスコード(505)。
 
メソッドの概要
 SipServletRequest createAck()
          この応答に対応するACKリクエストオブジェクトを返します。
 javax.servlet.ServletOutputStream getOutputStream()
          常にnullを返します。
 Proxy getProxy()
          このSIP応答オブジェクトのトランザクションに関連づけられたProxyオブジェクトを返します。
 java.lang.String getReasonPhrase()
          この応答オブジェクトの理由フレーズを返します。
 SipServletRequest getRequest()
          この応答に関連付けられたリクエストを返します。
 int getStatus()
          この応答オブジェクトのステータスコードを返します。
 java.io.PrintWriter getWriter()
          常にnullを返します。
 void send()
          この応答を送ります。
 void sendReliably()
          RFC3262で定義された100rel extensionを使ってこの応答が確実に送られるようにします。
 void setStatus(int statusCode)
          この応答オブジェクトのステータスコードおよび理由フレーズを設定します。
 void setStatus(int statusCode, java.lang.String reasonPhrase)
          この応答オブジェクトのステータスコードおよび理由フレーズを設定します。
 
インタフェース javax.servlet.ServletResponse から継承したメソッド
flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentType, setLocale
 
インタフェース javax.servlet.sip.SipServletMessage から継承したメソッド
addAcceptLanguage, addAddressHeader, addHeader, getAcceptLanguage, getAcceptLanguages, getAddressHeader, getAddressHeaders, getApplicationSession, getApplicationSession, getAttribute, getAttributeNames, getCallId, getCharacterEncoding, getContent, getContentLanguage, getContentLength, getContentType, getExpires, getFrom, getHeader, getHeaderNames, getHeaders, getLocalAddr, getLocalPort, getMethod, getProtocol, getRawContent, getRemoteAddr, getRemotePort, getRemoteUser, getSession, getSession, getTo, getTransport, getUserPrincipal, isCommitted, isSecure, isUserInRole, removeHeader, setAcceptLanguage, setAddressHeader, setAttribute, setCharacterEncoding, setContent, setContentLanguage, setContentLength, setContentType, setExpires, setHeader
 

フィールドの詳細

SC_ACCEPTED

public static final int SC_ACCEPTED
リクエストは処理のためにを受け入れられているが、処理が完了していないことを示すステータスコード(202)。 リクエストは、実際に処理が行われる時に許可されないかもしれないので、 最終的に実行されるかどうかわからありません。このような非同期オペレーションからステータスコードを再送信する機能はありません。

関連項目:
定数フィールド値

SC_ADDRESS_INCOMPLETE

public static final int SC_ADDRESS_INCOMPLETE
サーバが、不完全なTo(Section6.37)アドレスまたはRequest-URIを持つリクエストを受け取ったことを示すステータスコード(484)。 追加の情報が提供されるべきです。
注意: このステータスコードは、重複ダイアルを認めます。 重複ダイアログでは、クライアントはダイアル文字列の長さを知りません。 484ステータス応答を受け取らなくなるまで、ユーザにもっとインプットするよう促しながら、増大する長さの文字列を送ります。

関連項目:
定数フィールド値

SC_ALTERNATIVE_SERVICE

public static final int SC_ALTERNATIVE_SERVICE
代替えのサービスを示すステータスコード(380)。

関連項目:
定数フィールド値

SC_AMBIGUOUS

public static final int SC_AMBIGUOUS
リクエストで提供された着呼側のアドレスが不明瞭であったことを示すステータスコード(485)。応答は、Contactヘッダに、可能性のある不明瞭なアドレスのリストを含むかもしれません。
選択肢を明らかにすることにより、 ユーザまたは組織のプライバシーを侵害する恐れがあります。 ステータス404(Not Found)で応答するサーバ、または可能性のある選択肢の一覧表示を抑制するサーバを設定することが可能でなければなりません。
URL lee@example.comでのリクエストの場合:
 485 Ambiguous SIP/2.0
 Contact: Carol Lee 
 Contact: Ping Lee 
 Contact: Lee M. Foote 
 
電子メールおよびボイスメールのシステムによっては、この機能を提供するものもあります。 セマンティックスが異なるので、3xxとは別のステータスコードが使用されます。 つまり、300の場合、提供された選択肢によって同じ人物またはサービスに至るものと想定されます。 自動化された選択肢またはシーケンシャルな検索は3xx応答に対して意味をなすが、485応答にはユーザ介入が必要になります。

関連項目:
定数フィールド値

SC_BAD_EXTENSION

public static final int SC_BAD_EXTENSION
サーバがRequire(Section 6.30) ヘッダフィールドに指定されたプロトコル拡張を理解しなかったことを示すステータスコード(420)。

関連項目:
定数フィールド値

SC_BAD_GATEWAY

public static final int SC_BAD_GATEWAY
サーバが、ゲートウェイまたはプロキシとして機能している間に、 リクエストを実行しようとしてアクセスしたダウンストリームのサーバから無効な応答を受け取ったことを示すステータスコード(502)。

関連項目:
定数フィールド値

SC_BAD_REQUEST

public static final int SC_BAD_REQUEST
Bad Requestを示すステータスコード(400)。

関連項目:
定数フィールド値

SC_BUSY_EVERYWHERE

public static final int SC_BUSY_EVERYWHERE
着呼側のエンドシステムとは問題なくコンタクトをとったが、着呼側がビジーで、今回は呼を取らないということを示すステータスコード(600)。

関連項目:
定数フィールド値

SC_BUSY_HERE

public static final int SC_BUSY_HERE
着呼側のエンドシステムとは問題なくコンタクトをとったが、着呼側は現在は追加の呼を取らない、または取ることができないということを示すステータスコード(486)。

関連項目:
定数フィールド値

SC_CALL_BEING_FORWARDED

public static final int SC_CALL_BEING_FORWARDED
呼が転送されてていることを示すステータスコード(181)。

関連項目:
定数フィールド値

SC_CALL_LEG_DONE

public static final int SC_CALL_LEG_DONE
Call Leg/Transactionが存在しないことを示すステータスコード(481)。
このステータスは、2つの条件下で戻されます。サーバが、既存の何れのコールレグにも一致しないBYEリクエストを受け取った、 またはサーバが、既存の何れのトランザクションにも一致しないCANCELリクエストを受け取った。(サーバは不明なトランザクションを示してACKを単に廃棄します。)

関連項目:
定数フィールド値

SC_CALL_QUEUED

public static final int SC_CALL_QUEUED
呼がキューに入れられていることを示すステータスコード(182)。

関連項目:
定数フィールド値

SC_DECLINE

public static final int SC_DECLINE
着呼側のマシンとは問題なくコンタクトをとったが、ユーザが明確に参加しないか、または参加できないことを示すステータスコード(603)。 応答はRetry-Afterヘッダでより適切な呼出時間を示すかもしれません。

関連項目:
定数フィールド値

SC_DOES_NOT_EXIT_ANYWHERE

public static final int SC_DOES_NOT_EXIT_ANYWHERE
サーバが、Toリクエストフィールドに示されたユーザがどこにも存在しないという正式な情報を持っていることを示すステータスコード(604)。 他の場所でユーザを検索しても結果はありません。

関連項目:
定数フィールド値

SC_EXTENSION_REQUIRED

public static final int SC_EXTENSION_REQUIRED
UASが、リクエストを処理するために特定の拡張を必要とするが、この拡張はリクエストのSupportedヘッダフィールドに載っていないことを示すステータスコード(421)。

関連項目:
定数フィールド値

SC_FORBIDDEN

public static final int SC_FORBIDDEN
発呼側がそのようなリクエストを行うことを禁止されていることを示すステータスコード(403)。

関連項目:
定数フィールド値

SC_GONE

public static final int SC_GONE
リクエストされたリソースは、サーバで利用不可となっており、転送先アドレスは不明であることを示すステータスコード(410)。 この状況は、永続的であると想定されます。サーバが、状況が永続的であるかどうか分からない場合、またはそれを判断する機能を有しない場合には、代わりにステータスコード404(Not Found)が使用されます。

関連項目:
定数フィールド値

SC_INTERVAL_TOO_BRIEF

public static final int SC_INTERVAL_TOO_BRIEF
リクエストによって更新されたリソースの期限切れ時間が短すぎるため、サーバがリクエストを拒否していることを示すステータスコード(423)。

関連項目:
定数フィールド値

SC_LOOP_DETECTED

public static final int SC_LOOP_DETECTED
サーバが、自らを含むVia(Section 6.40)パスでリクエストを受け取ったことを示すステータスコード(482)。

関連項目:
定数フィールド値

SC_MESSAGE_TOO_LARGE

public static final int SC_MESSAGE_TOO_LARGE
メッセージの長さがその機能を超過したため、サーバがリクエスト処理することができなかったことを示すステータスコード(513)。

関連項目:
定数フィールド値

SC_METHOD_NOT_ALLOWED

public static final int SC_METHOD_NOT_ALLOWED
Request-Lineで指定されたメソッドが、Request-URIによって特定されたアドレスに対して許可されていないことを示すステータスコード(405)。 応答には、示されたアドレスに対する有効なメソッドの一覧を含むAllowヘッダフィールドがなければなりません。

関連項目:
定数フィールド値

SC_MOVED_PERMANENTLY

public static final int SC_MOVED_PERMANENTLY
着呼側が永久的に移動していることを示すステータスコード(301)。

関連項目:
定数フィールド値

SC_MOVED_TEMPORARILY

public static final int SC_MOVED_TEMPORARILY
着呼側が一時的に移動していることを示すステータスコード(302)。

関連項目:
定数フィールド値

SC_MULTIPLE_CHOICES

public static final int SC_MULTIPLE_CHOICES
Multiple Choicesを示すステータスコード(300)。すなわち、ユーザは複数のロケーションに 達するかもしれません。

関連項目:
定数フィールド値

SC_NOT_ACCEPTABLE

public static final int SC_NOT_ACCEPTABLE
リクエストにより特定されたリソースが、リクエストで送られた受け入れヘッダに応じて、内容の特性を受け入れ不可とする応答エンティティを生成することのみ可能であることを示すステータスコード(406)。

関連項目:
定数フィールド値

SC_NOT_ACCEPTABLE_ANYWHERE

public static final int SC_NOT_ACCEPTABLE_ANYWHERE
ユーザのエージェントとは問題なくコンタクトをとったが、リクエストされたメディア、 帯域幅またアドレス指定スタイルなどのセッション説明のいくつかのアスペクトが受け入れできなかったことを示すステータスコード(606)。

関連項目:
定数フィールド値

SC_NOT_ACCEPTABLE_HERE

public static final int SC_NOT_ACCEPTABLE_HERE
応答は、606(Not Acceptable)と同じ意味をもつが、Request-URIによってアドレス指定された特定のリソースにのみ適用され、またリクエストは他の場所で成功する可能性があることを示すステータスコード(488)。

関連項目:
定数フィールド値

SC_NOT_FOUND

public static final int SC_NOT_FOUND
サーバは、ユーザがRequest-URIに指定されたドメインに存在しないという確実な情報を持っていたこと示すステータスコード(404)。 このステータスはまた、Reequest-URIのドメインが、リクエストの受信者によって処理されるドメインの何れにも一致しない場合に戻されます。

関連項目:
定数フィールド値

SC_NOT_IMPLEMENTED

public static final int SC_NOT_IMPLEMENTED
サーバが、リクエストを実現するために要求される機能をサポートしないことを示すステータスコード(501)。

関連項目:
定数フィールド値

SC_OK

public static final int SC_OK
.リクエストが正常に成功したことを示すステータスコード(200)。

関連項目:
定数フィールド値

SC_PAYMENT_REQUIRED

public static final int SC_PAYMENT_REQUIRED
発呼側が支払いをする必要があることを示すステータスコード(402)。

関連項目:
定数フィールド値

SC_PROXY_AUTHENTICATION_REQUIRED

public static final int SC_PROXY_AUTHENTICATION_REQUIRED
クライアントがますプロキシで自らを認証しなければならないことを示すステータスコード(407)。 プロキシは、リクエストされたリソースに対するプロキシに適用されるチャレンジを含むProxy-Authenticateヘッダフィールドを戻さなければなりません。クライアントは、適切なProxy-Authorizationヘッダフィールド(セクション6.27) でリクエストをリピートするかもしれません。 SIPアクセス認証は、SIP Servlet API 1.0 セクション13.2および14で説明します。
このステータスコードは、着呼側ではなくコミュニケーションチャンネル(例えば電話通信のゲートウェイ)へのアクセスが認証を必要とする場合に、アプリケーションのために使用されます。

関連項目:
定数フィールド値

SC_REQUEST_ENTITY_TOO_LARGE

public static final int SC_REQUEST_ENTITY_TOO_LARGE
リクエストエンティティが、サーバが処理する/できるより大きいため、サーバはリクエストの処理を拒否していることを示すステータスコード(413)。サーバは、クライアントがリクエストを継続できないようにするため接続を終了するかもしれません。
状況が一時的である場合、サーバには、状況が一時的であり、どれくらい後に再度クライアントがリクエストを行うのかを示すためのRetry-Afterヘッダフィールドがなければなりません。

関連項目:
定数フィールド値

SC_REQUEST_PENDING

public static final int SC_REQUEST_PENDING
リクエストが、同じダイアログ内で保留リクエストを所有していたUASによって受信されたことを示すステータスコード(491)。

関連項目:
定数フィールド値

SC_REQUEST_TERMINATED

public static final int SC_REQUEST_TERMINATED
リクエストがBYEまたはCANCELリクエストによって終了されたことを示すステータスコード(487)。

関連項目:
定数フィールド値

SC_REQUEST_TIMEOUT

public static final int SC_REQUEST_TIMEOUT
サーバが、ユーザロケーションなどの応答を、Expiresリクエストヘッダフィールドに示された時間内に生成できなかったことを示すステータスコード(408)。 クライアントは後に、修正することなくリクエストをリピートするかもしれません。

関連項目:
定数フィールド値

SC_REQUEST_URI_TOO_LONG

public static final int SC_REQUEST_URI_TOO_LONG
サーバが解釈するよりRequest-URIが長いため、サーバがリクエストをサービスすることを拒否していることを示すステータスコード(414)。.

関連項目:
定数フィールド値

SC_RINGING

public static final int SC_RINGING
サーバが着呼側の所在を特定し、着呼側ユーザエージェントが着呼側を呼び出していることを示すステータスコード(180)。

関連項目:
定数フィールド値

SC_SERVER_INTERNAL_ERROR

public static final int SC_SERVER_INTERNAL_ERROR
サーバで、リクエストを実現できない予測不能な状態が発生したことを示すステータスコード(500)。

関連項目:
定数フィールド値

SC_SERVER_TIMEOUT

public static final int SC_SERVER_TIMEOUT
サーバが、リクエスト処理しようとしてアクセスした外部のサーバからタイムリーな応答を受信しなかったことを示すステータスコード(504)。

関連項目:
定数フィールド値

SC_SERVICE_UNAVAILABLE

public static final int SC_SERVICE_UNAVAILABLE
サーバが、一時的なオーバーロードまたはメンテナンスにより、現在リクエストを処理できないことを示すステータスコード(503)。

関連項目:
定数フィールド値

SC_SESSION_PROGRESS

public static final int SC_SESSION_PROGRESS
いろいろな呼の進捗情報をもつステータスコード(183)。理由フレーズは、呼の進捗状況についての詳細を伝えるかもしれません。

関連項目:
定数フィールド値

SC_TEMPORARLY_UNAVAILABLE

public static final int SC_TEMPORARLY_UNAVAILABLE
着呼側のエンドシステムとは問題なくコンタクトをとったが、着呼側が現在利用できないこと(例えば、ログインされていない、 または着呼側とのコミュニケーションを排除するような方法でログインされているなど)を示すステータスコード(480)。 応答は、Retry-Afterヘッダでより適切な呼出時間を示すかもしれません。 ユーザは、どこか他のところ(このホストは知らない場所)では利用できる可能性があるので、よってこの応答は一切の検索を終了しません。 理由フレーズは、ユーザエージェントが設定できるべきです。ステータス486(ここはビジー)は、呼が失敗した特定の理由をもっと正確に示すために使用されるかもしれません。
このステータスはまたRequest-URIによって特定されたユーザを認識するリダイレクトサーバによって戻されるが、現在のところそのユーザに対する有効な転送場所はありません。

関連項目:
定数フィールド値

SC_TOO_MANY_HOPS

public static final int SC_TOO_MANY_HOPS
Max-Forwards ヘッダフィールドによって許可される以上のViaエントリ(hops)(Sectopm6.40)を含むリクエストを、 サーバが受け取ったことを示すステータスコード(483)。

関連項目:
定数フィールド値

SC_TRYING

public static final int SC_TRYING
サーバが着呼側の所在を特定しようとしていることを示すステータスコード(100)。

関連項目:
定数フィールド値

SC_UNAUTHORIZED

public static final int SC_UNAUTHORIZED
発呼側がこのリクエストを行うことを許可されていないことを示すステータスコード(401)。

関連項目:
定数フィールド値

SC_UNDECIPHERABLE

public static final int SC_UNDECIPHERABLE
受領者が処理しないか、または適切な復号化キーを提供しない、暗号化されたMIMEボディを含んだUASによって、リクエストが受信されたことを示すステータスコード(493)。

関連項目:
定数フィールド値

SC_UNSUPPORTED_MEDIA_TYPE

public static final int SC_UNSUPPORTED_MEDIA_TYPE
リクエストのメッセージボディが、リクエストされたメソッドに対してリクエストされたリソースがサポートしない形式であるために、 サーバーがリクエストをサービスすることを拒否していることを示すステータスコード(415)。 サーバは、Accept、Accept-EncodingおよびAcceptーLanguageの各ヘッダフィールドを使用して受け入れ可能なフォーマットの一覧を戻すべきです。

関連項目:
定数フィールド値

SC_UNSUPPORTED_URI_SCHEME

public static final int SC_UNSUPPORTED_URI_SCHEME
Request-URIのURIのスキームがサーバには不明であるため、サーバがリクエストを処理できないことを示すステータスコード(416)。

関連項目:
定数フィールド値

SC_USE_PROXY

public static final int SC_USE_PROXY
その呼は、指定されたプロキシサーバによってよりうまく処理されることが可能であることを示すステータスコード(305)。

関連項目:
定数フィールド値

SC_VERSION_NOT_SUPPORTED

public static final int SC_VERSION_NOT_SUPPORTED
サーバが、リクエストメッセージで使用されたSIPプロトコルバージョンをサポートしないことを示すステータスコード(505)。

関連項目:
定数フィールド値
メソッドの詳細

createAck

public SipServletRequest createAck()
この応答に対応するACKリクエストオブジェクトを返します。このメソッドは、UACとして機能するサーブレットが、INVITEリクエストに対する2xx最終応答を確認するために使用します。
アプリケーションは非2xx応答に対してACKを生成しないことに注意します。これはコンテナ自体が行うものです。

戻り値:
この応答に対応するACKリクエストを返します。
例外:
java.lang.IllegalStateException - トランザクションステートが、ACKが現在送られることを許可しないステートである場合(例えばオリジナルリクエストがINVITEでなかった場合、 この応答が暫定応答に限られる場合、またはACKがすでに作成されている場合など)には、java.lang.IllegalStateException をスローします。

getOutputStream

public javax.servlet.ServletOutputStream getOutputStream()
                                                  throws java.io.IOException
常にnullを返します。
メッセージ内容はSipServletMessage.setContent(java.lang.Object, java.lang.String)メソッドを使って設定できます。

定義:
インタフェース javax.servlet.ServletResponse 内の getOutputStream
戻り値:
nullを返します。
例外:
java.io.IOException

getProxy

public Proxy getProxy()
このSIP応答オブジェクトのトランザクションに関連づけられたProxyオブジェクトを返します。 このようなProxyオブジェクトは、これが以前にプロキシされたリクエストに対する応答である場合に存在します。 そうでない場合には、Proxyオブジェクトは存在せず、nullが戻されます。
サーブレットが同じトランザクションに属するメッセージでgetProxyを呼び出す時には必ず、コンテナは同じProxyインスタンスを戻さなければならないことに注意します。 特に、プロキシされたリクエストに対する応答は、オリジナルリクエストと同じProxyオブジェクト関連付けられます。

戻り値:
この応答のトランザクションに関連づけられたProxyオブジェクトを返します。 この応答が以前にプロキシされたリクエストのために受け取られたものでない場合には、nullを返します。

getReasonPhrase

public java.lang.String getReasonPhrase()
この応答オブジェクトの理由フレーズを返します。

戻り値:
この応答の理由フレーズ

getRequest

public SipServletRequest getRequest()
この応答に関連付けられたリクエストを返します。 プロキシされたリクエストに対して受け取った応答について、 このメソッドは、ダウンストリームに送られたリクエストを表すリクエストオブジェクトを返します。
プロキシするアプリケーションは、リクエストオブジェクトから入手したリクエストURIを使用して、 プロキシされたいくつかの宛先のうち1つに受信応答をコリレートすることができます。

戻り値:
この応答が生成されたリクエストを返します。

getStatus

public int getStatus()
この応答オブジェクトのステータスコードを返します。
ステータスコードは3桁の整数結果コードで、リクエストを解釈しそれに応えようとした結果を示します。

戻り値:
この応答のステータスコードを返します。

getWriter

public java.io.PrintWriter getWriter()
                              throws java.io.IOException
常にnullを返します。
メッセージ内容はSipServletMessage.setContent(java.lang.Object, java.lang.String)メソッドを使って設定できます。

定義:
インタフェース javax.servlet.ServletResponse 内の getWriter
戻り値:
nullを返します。
例外:
java.io.IOException

send

public void send()
          throws java.io.IOException
この応答を送ります。これは、UASとして機能するサーブレットが、暫定応答および最終応答を送るために使用し、 またプロキシが暫定応答を作成するときに使用します。

定義:
インタフェース SipServletMessage 内の send
例外:
java.io.IOExceptio - この応答を送ろうとして転送エラーが発生するとjava.io.IOExceptionをスローします。
java.lang.IllegalStateException - この応答がダウンストリームから受け取られた場合、またはすでに送られていた場合には、java.lang.IllegalStateExceptionをスローします。
java.io.IOException - このリクエストを送ろうとして転送エラーが発生すると、java.io.IOExceptionをスローします。

sendReliably

public void sendReliably()
                  throws Rel100Exception
RFC3262で定義された100rel extensionを使ってこの応答が確実に送られるようにします。 このメソッドは、 100以外の1xx応答のために限って、またUACがリクエストで100rel拡張に対するサポートを示し、コンテナがそれをサポートする場合に限り、 呼び出されなければなりません。
アプリケーションは、"javax.servlet.sip.100rel" という名前の属性がServletContextに存在し、またBoolean.TRUEに等しい値をもつかどうか確認することにより、コンテナが100rel extensionをサポートするかどうかテストすることができます。

例外:
Rel100Exception - 100rel extensionを使用するための条件のいずれかが満たされない場合には、Rel100Exceptionをスローします。

setStatus

public void setStatus(int statusCode)
この応答オブジェクトのステータスコードおよび理由フレーズを設定します。

パラメータ:
statusCode - この応答のステータスコード

setStatus

public void setStatus(int statusCode,
                      java.lang.String reasonPhrase)
この応答オブジェクトのステータスコードおよび理由フレーズを設定します。

パラメータ:
statusCode - この応答のステータスコード
reasonPhrase - ステータスコードの短いテキスト説明