概要  パッケージ   クラス  使用  階層ツリー  索引  ヘルプ 
 前のクラス   次のクラス フレームあり    フレームなし    
概要:  入れ子 | フィールド | コンストラクタ | メソッド 詳細:  フィールド | コンストラクタ | メソッド

javax.servlet.sip
クラス SipServlet

java.lang.Object
  拡張javax.servlet.GenericServlet
      拡張javax.servlet.sip.SipServlet
すべての実装インタフェース:
java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig
public abstract class SipServlet
extends javax.servlet.GenericServlet
implements java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

SIPサーブレットを作成するためサブクラスになるアブストラクトクラスを提供します。
このクラスはServiceメソッドから受信メッセージを受け取ります。 このメソッドは、受信リクエストおよび応答のためにそれぞれ、doRequestまたはdoResponseを呼び出します。 これら２つのメソッドはさらに、リクエストメソッドまたはステータスコードで、以下のメソッドの一つにディスパッチします。
doInvite - for SIP INVITE requests
doAck - for SIP ACK requests
doOptions - for SIP OPTIONS requests
doBye - for SIP BYE requests
doCancel - for SIP CANCEL requests
doRegister - for SIP REGISTER requests
doSubscribe - for SIP SUBSCRIBE requests
doNotify - for SIP NOTIFY requests
doMessage - for SIP MESSAGE requests
doInfo - for SIP INFO requests
doPrack - for SIP PRACK requests
doProvisionalResponse - for SIP 1xx informational responses
doSuccessResponse - for SIP 2xx responses
doRedirectResponse - for SIP 3xx responses
doErrorResponse - for SIP 4xx, 5xx, and 6xx responses
doAck、doCancelおよびすべての応答処理メソッドのデフォルト実装は、空です。
つまり通常これらのメソッドの処理は不要です。 他すべてのリクエスト処理メソッドは、500エラー応答でリクエストを拒否します。 必要に応じてリクエストに対する処理を行ってください。
SipServletのサブクラスは、通常これらのメソッドの1つ以上をオーバーライドします。

関連項目:
直列化された形式

フィールドの概要
static java.lang.String SIP_FACTORY
          文字列"javax.servlet.sip.SipFactory"。
static java.lang.String SUPPORTED
          文字列 "javax.servlet.sip.supported。
static java.lang.String TIMER_SERVICE
          文字列 "javax.servlet.sip.TimerService"。
 
コンストラクタの概要
SipServlet()
           
 
メソッドの概要
protected  void doAck(SipServletRequest req)
          受信するACKリクエストを処理するため、サーバにより(サービスメソッドを介して)呼び出されます。
protected  void doBye(SipServletRequest req)
          受信するBYEリクエストを処理するため、サーバにより(サービスメソッドを介して)呼び出されます。
protected  void doCancel(SipServletRequest req)
          受信するCANCELリクエストを処理するため、サーバにより(サービスメソッドを介して)呼び出されます。
protected  void doErrorResponse(SipServletResponse resp)
          受信する4xx - 6xxクラス応答を処理するため、サーバにより(doResponseメソッドを介して)呼び出されます。　
protected  void doInfo(SipServletRequest req)
          受信するINFOリクエストを処理するため、サーバにより(サービスメソッドを介して)呼び出されます。
protected  void doInvite(SipServletRequest req)
          受信するINVITEリクエストを処理するため、サーバにより(サービスメソッドを介して)呼び出されます。
protected  void doMessage(SipServletRequest req)
          受信するMESSAGEリクエストを処理するため、サーバにより(サービスメソッドを介して)呼び出されます。
protected  void doNotify(SipServletRequest req)
          受信するNOTIFYリクエストを処理するため、サーバにより(サービスメソッドを介して)呼び出されます。
protected  void doOptions(SipServletRequest req)
          受信するOPTIONリクエストを処理するため、サーバにより(サービスメソッドを介して)呼び出されます。
protected  void doPrack(SipServletRequest req)
          受信するPRACKリクエストを処理するため、サーバにより(サービスメソッドを介して)呼び出されます。
protected  void doProvisionalResponse(SipServletResponse resp)
          受信する1xx クラス応答を処理するため、サーバにより(doResponseメソッドを介して)呼び出されます。
protected  void doRedirectResponse(SipServletResponse resp)
          受信する3xxクラス応答をサーブレットに通知するため、サーバにより呼び出されます。
protected  void doRegister(SipServletRequest req)
          受信するREGISTERリクエストを処理するため、サーバにより(サービスメソッドを介して)呼び出されます。
protected  void doRequest(SipServletRequest req)
          受信リクエストを処理するために呼び出されます。
protected  void doResponse(SipServletResponse resp)
          受信するリクエストを処理するため呼び出されます。
protected  void doSubscribe(SipServletRequest req)
          受信するSUBSCRIBEリクエストを処理するため、サーバにより(サービスメソッドを介して)呼び出されます。
protected  void doSuccessResponse(SipServletResponse resp)
          受信する2xx クラス応答を処理するため、サーバにより(doResponseメソッドを介して)呼び出されます。
 void log(java.lang.String message)
          指定されたメッセージをサーブレットログファイルに書き込む。
 void log(java.lang.String message, java.lang.Throwable t)
          所定のThrowableエクセプションに対する説明メッセージとスタックトレースを、サーブレットログファイルに書き込みます。
 void service(javax.servlet.ServletRequest req, javax.servlet.ServletResponse res)
          受信SIPメッセージ（リクエストまたは応答）を処理するために起動されます。
 
クラス javax.servlet.GenericServlet から継承したメソッド
destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
インタフェース javax.servlet.Servlet から継承したメソッド
destroy, getServletConfig, getServletInfo, init
 
インタフェース javax.servlet.ServletConfig から継承したメソッド
getInitParameter, getInitParameterNames, getServletContext, getServletName
 

フィールドの詳細

SIP_FACTORY

public static final java.lang.String SIP_FACTORY
文字列"javax.servlet.sip.SipFactory"。これは、その値がSipFactoryインターフェースのインスタンスであるServletContext属性の名前です。

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

SUPPORTED

public static final java.lang.String SUPPORTED
文字列 "javax.servlet.sip.supported。これは、その値がコンテナによってサポートされるSIP拡張の名前を含むListである、ServletContext属性の名前です。

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

TIMER_SERVICE

public static final java.lang.String TIMER_SERVICE
文字列 "javax.servlet.sip.TimerService"。これは、その値がTimerServiceインターフェースのインスタンスであるServletContext属性の名前です

関連項目:
定数フィールド値
コンストラクタの詳細

SipServlet

public SipServlet()
メソッドの詳細

doAck

protected void doAck(SipServletRequest req)
              throws javax.servlet.ServletException,
                     java.io.IOException
受信するACKリクエストを処理するため、サーバにより(サービスメソッドを介して)呼び出されます。

パラメータ:
req - 受信したSIP ACKリクエストを表します。
例外:
javax.servlet.ServletException - サーブレットの通常オペレーションに障害を与えるエクセプションが発生する場合、javax.servlet.ServletExceptionをスローします。
java.io.IOException - 入力または出力エクセプションが発生する場合は、java.io.IOExceptionをスローします。

doBye

protected void doBye(SipServletRequest req)
              throws javax.servlet.ServletException,
                     java.io.IOException
受信するBYEリクエストを処理するため、サーバにより(サービスメソッドを介して)呼び出されます。
デフォルト実装は空で、また、何か有効なことを行うにはサブクラスによってオーバーライドされなければなりません。

パラメータ:
req - 受信したSIP BYEリクエストを表します。
例外:
javax.servlet.ServletException - サーブレットの通常オペレーションに障害を与えるエクセプションが発生する場合、javax.servlet.ServletExceptionをスローします。
java.io.IOException - 入力または出力エクセプションが発生する場合は、java.io.IOExceptionをスローします。

doCancel

protected void doCancel(SipServletRequest req)
                 throws javax.servlet.ServletException,
                        java.io.IOException
受信するCANCELリクエストを処理するため、サーバにより(サービスメソッドを介して)呼び出されます。
デフォルト実装は空で、また、何か有効なことを行うにはサブクラスによってオーバーライドされなければなりません。

パラメータ:
req - 受信したSIP CANCELリクエストを表します。
例外:
javax.servlet.ServletException - サーブレットの通常オペレーションに障害を与えるエクセプションが発生する場合、javax.servlet.ServletExceptionをスローします。
java.io.IOException - 入力または出力エクセプションが発生する場合は、java.io.IOExceptionをスローします。

doErrorResponse

protected void doErrorResponse(SipServletResponse resp)
                        throws javax.servlet.ServletException,
                               java.io.IOException
受信する4xx - 6xxクラス応答を処理するため、サーバにより(doResponseメソッドを介して)呼び出されます。　
デフォルト実装は空で、また、何か有効なことを行うにはサブクラスによってオーバーライドされなければなりません。

パラメータ:
resp - 応答オブジェクトを表します。
例外:
javax.servlet.ServletException - サーブレットの通常オペレーションに障害を与えるエクセプションが発生する場合、javax.servlet.ServletExceptionをスローします。
java.io.IOException - 入力または出力エクセプションが発生する場合は、java.io.IOExceptionをスローします。

doInfo

protected void doInfo(SipServletRequest req)
               throws javax.servlet.ServletException,
                      java.io.IOException
受信するINFOリクエストを処理するため、サーバにより(サービスメソッドを介して)呼び出されます。
デフォルト実装は空で、また、何か有効なことを行うにはサブクラスによってオーバーライドされなければなりません。

パラメータ:
req - 受信したSIP INFOリクエストを表します。
例外:
javax.servlet.ServletException - サーブレットの通常オペレーションに障害を与えるエクセプションが発生する場合、javax.servlet.ServletExceptionをスローします。
java.io.IOException - 入力または出力エクセプションが発生する場合は、java.io.IOExceptionをスローします。

doInvite

protected void doInvite(SipServletRequest req)
                 throws javax.servlet.ServletException,
                        java.io.IOException
受信するINVITEリクエストを処理するため、サーバにより(サービスメソッドを介して)呼び出されます。
デフォルト実装は空で、また、何か有効なことを行うにはサブクラスによってオーバーライドされなければなりません。

パラメータ:
req - 受信したSIP INVITEリクエストを表します。
例外:
javax.servlet.ServletException - サーブレットの通常オペレーションに障害を与えるエクセプションが発生する場合、javax.servlet.ServletExceptionをスローします。
java.io.IOException - 入力または出力エクセプションが発生する場合は、java.io.IOExceptionをスローします。

doMessage

protected void doMessage(SipServletRequest req)
                  throws javax.servlet.ServletException,
                         java.io.IOException
受信するMESSAGEリクエストを処理するため、サーバにより(サービスメソッドを介して)呼び出されます。
デフォルト実装は空で、また、何か有効なことを行うにはサブクラスによってオーバーライドされなければなりません。

パラメータ:
req - 受信したSIP MESSAGEリクエストを表します。
例外:
javax.servlet.ServletException - サーブレットの通常オペレーションに障害を与えるエクセプションが発生する場合、javax.servlet.ServletExceptionをスローします。
java.io.IOException - 入力または出力エクセプションが発生する場合は、java.io.IOExceptionをスローします。

doNotify

protected void doNotify(SipServletRequest req)
                 throws javax.servlet.ServletException,
                        java.io.IOException
受信するNOTIFYリクエストを処理するため、サーバにより(サービスメソッドを介して)呼び出されます。
デフォルト実装は空で、また、何か有効なことを行うにはサブクラスによってオーバーライドされなければなりません。

パラメータ:
req - 受信したSIP NOTIFYリクエストを表します。
例外:
javax.servlet.ServletException - サーブレットの通常オペレーションに障害を与えるエクセプションが発生する場合、javax.servlet.ServletExceptionをスローします。
java.io.IOException - 入力または出力エクセプションが発生する場合は、java.io.IOExceptionをスローします。

doOptions

protected void doOptions(SipServletRequest req)
                  throws javax.servlet.ServletException,
                         java.io.IOException
受信するOPTIONリクエストを処理するため、サーバにより(サービスメソッドを介して)呼び出されます。
デフォルト実装は空で、また、何か有効なことを行うにはサブクラスによってオーバーライドされなければなりません。

パラメータ:
req - 受信したSIP OPTIONSリクエストを表します。
例外:
javax.servlet.ServletException - サーブレットの通常オペレーションに障害を与えるエクセプションが発生する場合、javax.servlet.ServletExceptionをスローします。
java.io.IOException - 入力または出力エクセプションが発生する場合は、java.io.IOExceptionをスローします。

doPrack

protected void doPrack(SipServletRequest req)
                throws javax.servlet.ServletException,
                       java.io.IOException
受信するPRACKリクエストを処理するため、サーバにより(サービスメソッドを介して)呼び出されます。
デフォルト実装は空で、また、何か有効なことを行うにはサブクラスによってオーバーライドされなければなりません。

パラメータ:
req - 受信したSIP PRACKリクエストを表します。
例外:
javax.servlet.ServletException - サーブレットの通常オペレーションに障害を与えるエクセプションが発生する場合、javax.servlet.ServletExceptionをスローします。
java.io.IOException - 入力または出力エクセプションが発生する場合は、java.io.IOExceptionをスローします。

doProvisionalResponse

protected void doProvisionalResponse(SipServletResponse resp)
                              throws javax.servlet.ServletException,
                                     java.io.IOException
受信する1xx クラス応答を処理するため、サーバにより(doResponseメソッドを介して)呼び出されます。
デフォルト実装は空で、また、何か有効なことを行うにはサブクラスによってオーバーライドされなければなりません。

パラメータ:
resp - 応答オブジェクトを表します。
例外:
javax.servlet.ServletException - サーブレットの通常オペレーションに障害を与えるエクセプションが発生する場合、javax.servlet.ServletExceptionをスローします。
java.io.IOException - 入力または出力エクセプションが発生する場合は、java.io.IOExceptionをスローします。

doRedirectResponse

protected void doRedirectResponse(SipServletResponse resp)
                           throws javax.servlet.ServletException,
                                  java.io.IOException
受信する3xxクラス応答をサーブレットに通知するため、サーバにより呼び出されます。
デフォルト実装は空で、また、何か有効なことを行うにはサブクラスによってオーバーライドされなければなりません。

パラメータ:
resp - 応答オブジェクトを表します。
例外:
javax.servlet.ServletException - サーブレットの通常オペレーションに障害を与えるエクセプションが発生する場合、javax.servlet.ServletExceptionをスローします。
java.io.IOException - 入力または出力エクセプションが発生する場合は、java.io.IOExceptionをスローします。

doRegister

protected void doRegister(SipServletRequest req)
                   throws javax.servlet.ServletException,
                          java.io.IOException
受信するREGISTERリクエストを処理するため、サーバにより(サービスメソッドを介して)呼び出されます。
デフォルト実装は空で、また、何か有効なことを行うにはサブクラスによってオーバーライドされなければなりません。

パラメータ:
req - 受信したSIP REGISTERリクエストを表します。
例外:
javax.servlet.ServletException - サーブレットの通常オペレーションに障害を与えるエクセプションが発生する場合、javax.servlet.ServletExceptionをスローします。
java.io.IOException - 入力または出力エクセプションが発生する場合は、java.io.IOExceptionをスローします。

doRequest

protected void doRequest(SipServletRequest req)
                  throws javax.servlet.ServletException,
                         java.io.IOException
受信リクエストを処理するために呼び出されます。このメソッドは、リクエストで使用されたSIPメソッドがXxxである場合、doXxxの一つにリクエストをディスパッチします。 サーブレットは通常このメソッドをオーバーライドする必要はありません。

パラメータ:
req - 受信SIPリクエストを表します。
例外:
javax.servlet.ServletException - サーブレットの通常オペレーションに障害を与えるエクセプションが発生する場合、javax.servlet.ServletExceptionをスローします。
java.io.IOException - 入力または出力エクセプションが発生する場合は、java.io.IOExceptionをスローします。

doResponse

protected void doResponse(SipServletResponse resp)
                   throws javax.servlet.ServletException,
                          java.io.IOException
受信するリクエストを処理するため呼び出されます。
このメソッドは、doProvisionalResponse(), doErrorResponse(), doSuccessResponse()の１つに応答をディスパッチします。
サーブレットは通常このメソッドをオーバーライドする必要はありません。

パラメータ:
resp - 応答オブジェクトを表します。
例外:
javax.servlet.ServletException - サーブレットの通常オペレーションに障害を与えるエクセプションが発生する場合、javax.servlet.ServletExceptionをスローします。
java.io.IOException - 入力または出力エクセプションが発生する場合は、java.io.IOExceptionをスローします。

doSubscribe

protected void doSubscribe(SipServletRequest req)
                    throws javax.servlet.ServletException,
                           java.io.IOException
受信するSUBSCRIBEリクエストを処理するため、サーバにより(サービスメソッドを介して)呼び出されます。
デフォルト実装は空で、また、何か有効なことを行うにはサブクラスによってオーバーライドされなければなりません。

パラメータ:
req - 受信したSIP SUBSCRIBEリクエストを表します。
例外:
javax.servlet.ServletException - サーブレットの通常オペレーションに障害を与えるエクセプションが発生する場合、javax.servlet.ServletExceptionをスローします。
java.io.IOException - 入力または出力エクセプションが発生する場合は、java.io.IOExceptionをスローします。

doSuccessResponse

protected void doSuccessResponse(SipServletResponse resp)
                          throws javax.servlet.ServletException,
                                 java.io.IOException
受信する2xx クラス応答を処理するため、サーバにより(doResponseメソッドを介して)呼び出されます。
デフォルト実装は空で、また、何か有効なことを行うにはサブクラスによってオーバーライドされなければなりません。

パラメータ:
resp - 応答オブジェクトを表します。
例外:
javax.servlet.ServletException - サーブレットの通常オペレーションに障害を与えるエクセプションが発生する場合、javax.servlet.ServletExceptionをスローします。
java.io.IOException - 入力または出力エクセプションが発生する場合は、java.io.IOExceptionをスローします。

log

public void log(java.lang.String message)
指定されたメッセージをサーブレットログファイルに書き込む。 ServletContext.log(String)を参照のこと。
クラス javax.servlet.GenericServletでログをオーバーライドします。

パラメータ:
message - ログファイルに書き込みされるメッセージを指定するString

log

public void log(java.lang.String message,
                java.lang.Throwable t)
所定のThrowableエクセプションに対する説明メッセージとスタックトレースを、サーブレットログファイルに書き込みます。
ServletContext.log(String, Throwable)を参照のこと。
クラス javax.servlet.GenericServletでログをオーバーライドします。

パラメータ:
message - エラーまたはエクセプションを説明するString
t - java.lang.Throwableエラーまたはエクセプション

service

public void service(javax.servlet.ServletRequest req,
                    javax.servlet.ServletResponse res)
             throws javax.servlet.ServletException,
                    java.io.IOException
受信SIPメッセージ（リクエストまたは応答）を処理するために起動されます。 当然引数の１つはnullになります。 つまり、イベントがリクエストの場合、応答の引数はnullです。逆もまた同様で、イベントが応答であれば、リクエストの引数はnullです。
クラスjavax.servlet.GenericServletのサービスをオーバーライドします。

定義:
インタフェース javax.servlet.Servlet 内の service
パラメータ:
req - 処理するリクエスト。トリガーイベントが受信応答であった場合はnull。
res - 受信応答。トリガーイベントが受信リクエストであった場合はnull。
例外:
javax.servlet.ServletException - サーブレットの通常オペレーションに障害を与えるエクセプションが発生する場合、javax.servlet.ServletExceptionをスローします。
java.io.IOException - 入力または出力エクセプションが発生する場合は、java.io.IOExceptionをスローします。
概要  パッケージ   クラス  使用  階層ツリー  索引  ヘルプ 
 前のクラス   次のクラス フレームあり    フレームなし    
概要:  入れ子 | フィールド | コンストラクタ | メソッド 詳細:  フィールド | コンストラクタ | メソッド