アプリケーションイベントとリスナ

ドキュメントのダウンロード

サイトマップ

Glossary

検索

e-docs > WebLogic Server > Web アプリケーションのアセンブルとコンフィグレーション > アプリケーションイベントとリスナ

Web アプリケーションのアセンブルとコンフィグレーション

アプリケーションイベントとリスナ

この章では、Web アプリケーションのイベントとリスナをコンフィグレーションおよび使用する方法について説明します。

アプリケーションイベントとリスナの概要

アプリケーションイベントとは、サーブレットコンテキストのステートの変更 (各 Web アプリケーションは独自のサーブレットコンテキストを使用する)、または HTTP セッションオブジェクトのステートの変更を通知するものです。これらのステートの変更に応答するイベントリスナクラスを作成して、Web アプリケーションでアプリケーションイベントとリスナクラスをコンフィグレーションおよびデプロイします。

サーブレットコンテキストイベントの場合、イベントリスナクラスは、Web アプリケーションがデプロイされるときやアンデプロイされているとき (または WebLogic Server が停止するとき)、および、属性が追加、削除、置換されたときに、通知を受け取ることができます。

HTTP セッションイベントの場合、イベントリスナクラスは、HTTP セッションがアクティブ化されたかパッシベーションされようとしているとき、および、HTTP セッション属性が追加、削除、置換されたときに、通知を受け取ることができます。

Web アプリケーションイベントは次の目的で使用します。

Web アプリケーションがデプロイされるときや停止されるときにデータベース接続を管理する
カウンタを作成する
HTTP セッションとその属性のステートをモニタする

サーブレットコンテキストイベント

次の表は、サーブレットコンテキストイベントのタイプ、イベントリスナクラスがイベントに応答するために実装すべきインタフェース、およびイベントが発生したときに起動されるメソッドを示しています。

イベントのタイプ	インタフェース	メソッド
サーブレットコンテキストが作成された。	javax.servlet.ServletContextListener	contextInitialized()
サーブレットコンテキストが停止されようとしている。	javax.servlet.ServletContextListener	contextDestroyed()
属性が追加された。	javax.servlet. ServletContextAttributesListener	attributeAdded()
属性が削除された。	javax.servlet. ServletContextAttributesListener	attributeRemoved()
属性が置き換えられた。	javax.servlet. ServletContextAttributesListener	attributeReplaced()

HTTP セッションイベント

次の表は、HTTP セッションイベントのタイプ、イベントリスナクラスがイベントへの応答に実装すべきインタフェース、およびイベントが発生したときに起動されるメソッドを示しています。

イベントのタイプ	インタフェース	メソッド
HTTP セッションがアクティブ化された。	javax.servlet.http. HttpSessionListener	sessionCreated()
HTTP セッションがパッシベーションされようとしている。	javax.servlet.http. HttpSessionListener	sessionDestroyed()
属性が追加された。	javax.servlet.http. HttpSessionAttributeListener	attributeAdded()
属性が削除された。	javax.servlet.http. HttpSessionAttributeListener	attributeRemoved()
属性が置き換えられた。	javax.servlet.http. HttpSessionAttributeListener	attributeReplaced()

注意: サーブレット 2.3 仕様にも javax.servlet.http.HttpSessionBindingListener インタフェースと javax.servlet.http.HttpSessionActivationListener インタフェースが含まれています。これらのインタフェースは、セッション属性として格納されるオブジェクトによって実装され、web.xml へのイベントリスナの登録を必要としません。詳細については、これらのインタフェースの Javadoc を参照してください。

イベントリスナのコンフィグレーション

イベントリスナをコンフィグレーションするには、次の手順に従います。

イベントリスナを作成する Web アプリケーションの web.xml デプロイメント記述子をテキストエディタで開くか、Administration Console に統合されている Web アプリケーションデプロイメント記述子エディタを使います (「Web アプリケーションデプロイメント記述子エディタ (war)」を参照)。web.xml ファイルは、Web アプリケーションの WEB-INF ディレクトリにあります。
<listener> 要素を使ってイベント宣言を追加します。イベント宣言は、イベントが発生するときに起動されるリスナクラスを定義します。<listener> 要素は、<filter> 要素と <filter-mapping> 要素のすぐ後ろで、<servlet> 要素のすぐ前に指定します。それぞれのイベントタイプに複数のリスナクラスを指定できます。WebLogic Server は、デプロイメント記述子に記述されている順にイベントリスナを起動します (停止イベントだけは、逆順で起動されます)。次に例を示します。
```
<listener>
  <listener-class>myApp.myContextListenerClass</listener-class>
</listener>
```
```
<listener>
  <listener-class>myApp.mySessionAttributeListenerClass</listener-class>
</listener>
```
リスナクラスを作成し、デプロイします。詳細については、次のリスナクラスの作成,を参照してください。

リスナクラスの作成

リスナクラスを作成するには、次の手順に従います。

クラスが応答するイベントのタイプに対して適切なインタフェースを実装する新しいクラスを作成します。これらのインタフェースのリストについては、サーブレットコンテキストイベントまたはHTTP セッションイベントを参照してください。作業の開始に利用できるサンプルのテンプレートについては、リスナクラスのテンプレートを参照してください。
引数をとらないパブリックコンストラクタを作成します。
インタフェースの必須メソッドを実装します。詳細については、J2EE API リファレンス (Javadoc) を参照してください。
コンパイル済みのイベントリスナクラスを Web アプリケーションの WEB-INF/classes ディレクトリにコピーするか、または、それらを jar ファイルにパッケージ化してからその jar ファイルを Web アプリケーションの WEB-INF/lib ディレクトリにコピーします。

次の便利なクラスは、リスナクラスのリスナメソッドに渡されます。

javax.servlet.http.HttpSessionEvent

HTTP セッションオブジェクトへのアクセスを提供します。

javax.servlet.ServletContextEvent

サーブレットコンテキストオブジェクトへのアクセスを提供します。

javax.servlet.ServletContextAttributeEvent

サーブレットコンテキストとその属性へのアクセスを提供します。

javax.servlet.http.HttpSessionBindingEvent

HTTP セッションとその属性へのアクセスを提供します。

リスナクラスのテンプレート

次の例は、リスナクラスの基本的なテンプレートです。

サーブレットコンテキストリスナの例

package myApp;
import javax.servlet.*;

public final class myContextListenerClass implements
   ServletContextListener {
    public void contextInitialized(ServletContextEvent event) {

      /* このメソッドは、サーブレット コンテキストが初期化されたとき
          (Web アプリケーションがデプロイされたとき) に呼び出される。 
         この時点で、サーブレット コンテキストに関連するデータを初期化できる
      */ 

    }

    public void contextDestroyed(ServletContextEvent event) {

      /* このメソッドは、サーブレット コンテキスト (Web アプリケーション) が
         アンデプロイされたとき、または WebLogic Server が
         シャットダウンしたときに呼び出される
      */			    

    }
}

HTTP セッション属性リスナの例

package myApp;
import javax.servlet.*;

public final class mySessionAttributeListenerClass implements
   HttpSessionAttributeListener {

    public void attributeAdded(HttpSessionBindingEvent sbe) {
      /* このメソッドは、属性がセッションから削除されたときに
         呼び出される
      */
    }

    public void attributeRemoved(HttpSessionBindingEvent sbe) {
      /* このメソッドは、属性がセッションから削除されたときに
         呼び出される
      */
    }

    public void attributeReplaced(HttpSessionBindingEvent sbe) {
      /* このメソッドは、属性がセッションで置き換えられたときに
         呼び出される
      */
    }
}

その他の情報源