SIP 1.1 注釈
SIP 1.1 以降では、SIP サーブレット・アプリケーションで注釈を使用できます。注釈を使用すると、デプロイメント記述子を使用せずに、アプリケーションに直接データを組み込むことができます。
SIP 1.1 で使用可能な注釈
SIP 1.1 では以下の注釈を使用できます。
- @SipApplication
- @SipServlet
- @SipListener
- @SipApplicationKey
ヒント: 注釈ではなくデプロイメント記述子を使用するように選択することもできます。
デプロイメント記述子により、注釈に記述されている設定がオーバーライドされます。
@SipApplication 注釈
@SipApplication 注釈は、アプリケーションに関する一般的な構成情報を定義します。これはパッケージ・レベルの注釈で、package-info.java という名前のファイルに含まれている必要があります。
パッケージ内のすべてのサーブレットが、同じアプリケーションに属しています。
重要: デプロイメント記述子または注釈のどちらを使用する場合でも、.war ファイルまたは .sar ファイルごとにコンテナーに登録できるのは、1 つの SIP アプリケーションだけです。
| 注釈のプロパティー | デプロイメント記述子要素 | 説明 | デフォルトの注釈値 |
|---|---|---|---|
| name | <app-name> | SIP アプリケーションの名前。 | 必須フィールド |
| displayName | <display-name> | アプリケーションの表示名 | アプリケーション名 |
| description | <description> | アプリケーションの説明 | 空ストリング |
| smallicon | <small-icon> | 小アイコンの場所を示すパス | 空ストリング |
| largeicon | <large-icon> | 大アイコンの場所を示すパス | 空ストリング |
| distributable | <destributable> | アプリケーションが分散環境で機能できるかどうかを示す | False (ブール値) |
| proxyTimeout | <proxy-timeout> | すべてのプロキシー操作のデフォルト・タイムアウト | 3 分 (秒単位) |
| sessionTimeout | <session-timeout> | すべてのアプリケーション・セッション操作のデフォルト・タイムアウト | 3 分 (分単位) |
| mainServlet | <main-servlet> | メイン・サーブレットとして設計された SIP サーブレットを示す | 空ストリング |
@SipServlet 注釈
@SipServlet 注釈は、クラスが SIP サーブレットであることを示します。
| 注釈のプロパティー | デプロイメント記述子要素 | 説明 | デフォルトの注釈値 |
|---|---|---|---|
| @SipServletServlet | <servlet-class> | クラスが SIP サーブレットであることを示す | 注釈はクラスで宣言される |
| name | <servlet-name> | サーブレットの名前 | 注釈付きクラスのショート・ネーム |
| applicationName | <app-name> | アプリケーションの名前 | オプション。デプロイメント記述子に定義するか、@SipApplication を使用して定義できる |
| loadOnStartup | <load-on-startup> | サーブレット・アプリケーションの開始順序を定義する | 負数 (このサーブレットの開始時をコンテナーが選択する) |
@SipListener 注釈
@SipListener 注釈は、<listener> デプロイメント記述子要素の代わりになります。
@SipListener 注釈に必須フィールドはありませんが、オプションでアプリケーション名と説明を取得できます。@SipListener 注釈が付けられたクラスは、少なくとも 1 つのリスナー・インターフェースを実装する必要があります。
@SipApplicationKey 注釈
@SipApplicationKey 注釈は、着信要求と SipSession を特定の SipApplicationSession に関連付けられるメソッドにマークを付けます。この注釈は、セッション鍵ベースのターゲットに使用します。
