2. ライフサイクルモジュールの開発

2.1. プログラミング・開発ガイド

2.1.1. ライフサイクルリスナの開発

2.1.1.1. サーバのライフサイクル・イベント

• INIT_EVENTイベントの時、サーバは構成情報を読み込み、セキュリティやロギング・サービスのような内蔵サブシステムを初期化し、コンテナ群を生成します。
• STARTUP_EVENTイベントの時、サーバは配備済みのアプリケーションをロードし初期化します。
• READY_EVENTイベントの時、サーバはリクエストを受け入れる準備ができています。
• SHUTDOWN_EVENTイベントの時、サーバはロードしていたアプリケーションを破棄して停止します。
• TERMINATION_EVENTイベントの時、サーバはコンテナと内蔵サブシステム、サーバ実行時環境を閉じます。

2.1.1.2. LifecycleListenerインタフェース

• public void handleEvent(com.nec.webotx.appserv.server.LifecycleEvent event) throws ServerLifecycleException
  このメソッドはライフサイクル・イベントに応答し、エラーが生じた場合にcom.nec.webotx.appserv.server.ServerLifecycleException例外を送出します。

package com.nec.webotx.sample;

import java.util.Properties;
import com.nec.webotx.appserv.server.*;

/**
* LifecycleListenerImplは、LifecycleListenerインタフェースのダミー実装です。
* この実装は、ライフサイクル・インタフェースのメソッドから様々なイベントを
* 確認します。
*/

public class LifecycleListenerImpl implements LifecycleListener {

    /** サーバ・ライフサイクル・イベントを受け取ります。
    * @param event 関連付けられるイベント
    * @throws 例外条件に対応したServerLifecycleException
    *
    * domain.xmlの中にlifecycle-module要素としてこのモジュールを構成します。
    *
    * <applications>
    *     <lifecycle-module name="test"
    *                 class-name="com.nec.webotx.sample.LifecycleListenerImpl"
    *                 is-failure-fatal="false">
    *         <property name="foo" value="fooval"/>
    *     </lifecycle-module>
    * </applications>
    *
    * 致命的な条件に対しては、domain.xmlの中のis-failure-fatalにtrueを
    * 設定してください。
    */
    public void handleEvent(LifecycleEvent event) throws ServerLifecycleException
    {
        LifecycleEventContext context = event.getLifecycleEventContext();

        context.log("got event" + event.getEventType() + " event data: "
            + event.getData());

        Properties props;

        if (LifecycleEvent.INIT_EVENT == event.getEventType()) {
            context.log("LifecycleListener: INIT_EVENT");

            props = (Properties) event.getData();

            // handle INIT_EVENT
            return;
        }

        if (LifecycleEvent.STARTUP_EVENT == event.getEventType()) {
            context.log("LifecycleListener: STARTUP_EVENT");

            // handle STARTUP_EVENT
            return;
        }

        if (LifecycleEvent.READY_EVENT == event.getEventType()) {
            context.log("LifecycleListener: READY_EVENT");

            // handle READY_EVENT
            return;
        }

        if (LifecycleEvent.SHUTDOWN_EVENT== event.getEventType()) {
            context.log("LifecycleListener: SHUTDOWN_EVENT");

            // handle SHUTDOWN_EVENT
            return;
        }

        if (LifecycleEvent.TERMINATION_EVENT == event.getEventType()) {
            context.log("LifecycleListener: TERMINATE_EVENT");

            // handle TERMINATION_EVENT
            return;
        }
    }
}

2.1.1.3. LifecycleEventクラス

• public java.lang.Object getData()
  このメソッドは、イベントに関連付けられたデータを返します。
  
• public int getEventType()
  このメソッドは、INIT_EVENT、STARTUP_EVENT、READY_EVENT、SHUTDOWN_EVENT、TERMINATION_EVENTのいずれかのイベント・タイプを返します。
  
• public com.nec.webotx.appserv.server.LifecycleEventContext getLifecycleEventContext()
  このメソッドは、次の章で説明される、ライフサイクル・イベント・コンテキストを返します。

2.1.1.4. サーバのライフサイクル・イベント・コンテキスト

• public java.lang.String[] getCmdLineArgs()
  このメソッドは、サーバ開始時のコマンドライン引数を返します。
  
• public java.lang.String getInstallRoot()
  このメソッドは、サーバ・インストールのルート・ディレクトリを返します。
  
• public java.lang.String getInstanceName()
  このメソッドは、サーバ・インスタンス名を返します。
• public javax.naming.InitialContext getInitialContext()
  このメソッドは、初期JNDIネーミング・コンテキストを返します。

• public void log(java.lang.String message)
  このメソッドは、サーバ・ログファイルへ指定したメッセージを書き込みます。 messageパラメータには、String型でログファイルに書き込む文字列を指定します。
  
  
• public void log(java.lang.String message, java.lang.Throwable throwable)
  このメソッドは、サーバ・ログファイルに説明用のメッセージとThrowable例外に対するスタック・トレースを書き込みます。 messageパラメータは、エラーか例外について記述するString型です。 throwableパラメータは、Throwable型のエラーか例外です。
  

2.1.2. ライフサイクル・モジュールの作成

2.1.2.1. ライフサイクル・モジュールの作成

1. 作業用ディレクトリを作成し、その中にモジュールのコンテンツをコピーします。
   
2. JARファイルを生成するために、次のコマンドを実行します。
   

   [foo@webotx ~]$ jar -cvf moudle_name.jar * 

2.1.2.2. ライフサイクル・モジュールの配備

• otxadminコマンド
   
  
• 統合運用管理ツール (WebOTX Administrator製品に含まれます)
  

otxadmin> create-lifecycle-module --user user --classname classname [--classpath classpath] 
[--loadorder load_order_number] [--failurefatal=false] [--enabled=true] [--description 
text_description] [--property (name=value)[:name=value]*] modulename 
		

otxadmin> create-lifecycle-module --user admin --classname RMIServer MyRMIServer

otxadmin> delete-lifecycle-module --user user modulename 

otxadmin> delete-lifecycle-module --user admin MyRMIServer

otxadmin> list-lifecycle-module --user user

otxadmin> list-lifecycle-module --user admin

2.1.2.3. ライフサイクル・モジュールの構成情報

<lifecycle-module name="customStartup"
        enabled="true"
        class-name="com.acme.CustomStartup"
        classpath="/apps/customStartup"
        load-order="200"
        is-failure-fatal="true">
    <description>custom startup module to do my tasks</description>
    <property name="rmiServer" value="acme1:7070" />
    <property name="timeout" value="30" />
</lifecycle-module> 

2.1.2.4. サーバのライフサイクル・モジュールで考慮する点

2.1.2.5. APIリファレンス