6. asantユーティリティ (Antタスク)

WebOTXでは、Apache Ant を提供しており、install-dir/bin ディレクトリに配置されるコマンド「asant」を使用してAntを起動することができます。 さらにWebOTXでは、配備などのWebOTX固有のタスクも提供しています。

Antに関する詳細については、Apache Software FoundationのWebサイト http://ant.apache.org/ を参照してください。

6.1. asantを用いたアセンブリ、配備

asantコマンドは、WebOTX動作に必要な設定を加えてオリジナルのApache antコマンドを実行するラッパー・スクリプトです。 このスクリプトでは、WebOTX固有のタスクを実行するために必要なWebOTXのJARファイルをクラスパスに加えて、適切なJavaシステム・プロパティを設定しています。

6.2. WebOTXのAntタスク

WebOTXでは、モジュールやアプリケーションのアセンブリ、配備、配備解除や、サーバの構成を行うためのAntタスクを提供しています。 そのタスクには、次のものがあります。

6.2.1. webotx-deploy

このタスクは、以下のコンポーネントの配備を行います。

6.2.1.1. サブ要素

次の表は、webotx-deployタスクのサブ要素を示しています。 これらは、タスクが作用する対象のものです。

要素 説明
component 配備するコンポーネント
fileset 指定されたパラメータに対応するコンポーネント・ファイルのセット

これらは、以降の [ 6.3. 再利用可能なサブ要素 ] で後述します。

6.2.1.2. 属性

次の表は、webotx-deployタスクの属性を示しています。

属性 既定値 説明
file なし (componentfilesetサブ要素が存在する場合はオプション、それ以外は必須) 配備するコンポーネント。 この属性がファイルを参照する場合、それは有効なアーカイブでなければなりません。 この属性がディレクトリを示している場合は、全てのコンポーネントが展開されている有効なアーカイブを含んでいなければなりません。 uploadfalseに設定される場合、サーバ・マシン上の絶対パスである必要があります。
name 拡張子を除いたファイル名 (オプション) 配備するコンポーネントの名前。
type なし (オプション) 配備されるコンポーネントの種類を指定します。指定可能な値はosgiのみです。OSGiバンドルを配備する際にosgiを指定します。それ以外の種類のコンポーネントは自動的に判別されます。
force true (オプション) trueの場合、既にサーバに存在すればコンポーネントを上書きします。 falseの場合、コンポーネントが存在していれば、webotx-deployは失敗します。
retrievestubs クライアント・スタブは保存されない (オプション) クライアント・スタブが保存されるディレクトリ。
precompilejsp false (オプション) trueの場合、Java EE Enterprise Application (.ear) かWebアプリケーション (.war) で見つかった全てのJSPファイルを事前コンパイルします。 この属性は、他のコンポーネント・タイプに対しては無視されます。
verify false (オプション) trueの場合、全ての配備記述子の構文とセマンティクスが自動的に正確に定義されているかを検証します。
contextroot 拡張子を除いたファイル名 (オプション) Webモジュール (WARファイル) のコンテキスト・ルート。 コンポーネントがWARファイルでない場合、この属性は無視されます。
dbvendorname nec-ejb-jar.xmlのエントリ (オプション) テーブルが作成されるデータベース・ベンダ名。 指定可能な値は、oraclepointbasesybasedb2mssqlsql92です。 それらは大文字/小文字の区別をしません。
 
指定されない場合、nec-ejb-jar.xmlの中のdatabase-vendor-name属性値が使用されます。
 
値が未指定の場合は、nec-ejb-jar.xmlファイルの中に定義されたcmp-resource要素のjndi-nameサブ要素で与えられたリソースにより接続し、データベース・ベンダ名を認識します。 接続を確立できなかった場合、または、認識されない値であった場合は、SQL-92準拠に相当するものが仮定されます。
createtables nec-ejb-jar.xmlのエントリ (オプション) trueの場合、必要とするEnterprise Bean用のデータベース・テーブルを生成します。 falseの場合はテーブルを生成しません。 未指定の場合、nec-ejb-jar.xmlファイルの中のcreate-tables-at-deploy属性値が使用されます。
dropandcreatetables nec-ejb-jar.xmlのエントリ (オプション) trueの場合、このアプリケーションを最後に配備した時にテーブルを自動生成していたならば、そのテーブルを削除した後に新たなテーブルを生成します。
 
trueで、このアプリケーションを最後に配備した時にテーブルを自動生成していなければ、テーブルの削除処理自体を行おうとはしません。 自動的に生成されたかもしれない同じ名前のテーブルが見つかった場合は、配備処理が進行しますが、テーブルを生成することができなかった旨を示す警告が表示されます。
 
falseの場合、nec-ejb-jar.xmlファイル中のcreate-tables-at-deploydrop-tables-at-undeployの要素の設定は無視されます。
uniquetablenames nec-ejb-jar.xmlのエントリ (オプション) trueの場合、テーブル名が各アプリケーション・サーバのドメイン内で一意となることを指定します。 未指定の場合は、nec-ejb-jar.xmlの中のuse-unique-table-namesプロパティ値が使用されます。
enabled true (オプション) trueの場合、コンポーネントを有効化します。
deploymentplan なし (オプション) 配備プランは、WebOTX固有の配備記述子を含んだJARファイルです。 WebOTX固有の配備記述子を持たないアーカイブファイルを配備する場合に、この属性を使用してください。
rmic false (オプション) RMI-IIOP用のスタブとタイを生成するかどうかを指定します。trueの場合はスタブとタイを生成し、falseの場合は生成しません。
libraries なし (オプション) ライブラリJARファイルの絶対パス、相対パスを指定します。相対パスは、[ドメインディレクトリ]/lib/applibsからの相対パスを指定します。複数のパスを指定する場合、コンマを区切り文字として使用します。
upload true (オプション) trueの場合、コンポーネントが配備先のサーバへ転送されます。 コンポーネントをローカル・マシン上に配備する場合、配備時間を縮小するために、この属性へfalseを設定してください。 配備でディレクトリが指定される場合、属性値はfalseでなければなりません。
virtualservers 既定値の仮想サーバのみ (オプション) 配備対象である仮想サーバをコンマで分離したリスト。 この属性は、アプリケーション(.ear)または、Web(.war)コンポーネントにのみ適用され、他のコンポーネント・タイプに対しては無視されます。
apgroup なし (プロセスグループ上に配備するアプリケーションの場合は必須、Expressでは指定不可) 配備先のアプリケーショングループを指定します。
pgroup なし (プロセスグループ上に配備するアプリケーションの場合は必須、Expressでは指定不可) 配備先のプロセスグループを指定します。
methodid limit (オプション) プロセスグループに配備するEJBについて、メソッドIDの割り当て方法を指定します。limitの場合はビジネスメソッドに対してのみ割り当てられます。allの場合はすべ てのリモートメソッドに対して割り当てられます。noneの場合は割り当てを行いません。Expressでは無視されます。
bindtype persistent (オプション) 名前サーバの登録方式を設定します。persistentを指定すると、永続的に扱います。transientを指定すると、一時的に扱います。永続的に扱う場合、名前サーバへのIOR登録をプロセス起動停止に関係なく行えます。このため、プロセス起動時の名前サーバアクセス負荷を軽減することができます。一時的に扱う場合、プロセス起動時に名前サーバへの登録を行います。このとき、ラウンドロビン機能の設定もできます。
bindiortojndi true (オプション) IORをJNDIに登録するかどうかを指定します。trueの場合はIORをJNDIに登録し、falseの場合は登録しません。
statechecktimeout 120 (オプション) プロセスグループに配備したコンポーネントについて、コンポーネント状態確認のタイムアウト値を指定します。単位は秒です。
keepstate false (オプション) Webセッション、SFSBインスタンス、および永続的に作成されたEJBタイマーを、再配備時に保持するかどうかを指定します。trueの場合は再配備時に再配備前の値が保持され、falseの場合は保持されません。
hotswapenabled false (オプション) アプリケーションでホットスワップ機能を有効にするかどうかを指定します。アプリケーションサーバでホットスワップ機能が有効になっている場合、trueを指定するとアプリケーション内のクラスファイルの更新を自動で検出し、変更されたクラスの再定義を行います。falseの場合は、クラスファイルの更新が検出されません。
preprocessor なし (オプション) 配備前に実行するプリプロセッサを指定します。
user admin (オプション) アプリケーション・サーバにログインする時に使用されるユーザ名。
password なし (オプション) 非推奨。代わりにpasswordfileを使用してください。 アプリケーション・サーバにログインする時に使用されるパスワード。
passwordfile なし (オプション) パスワードの記述を含んだファイル。 このファイルに記述されたパスワードによってアプリケーション・サーバとの通信を行います。 passwordpasswordfileの両方が指定された場合、passwordfileの方が優先されます。
host localhost (オプション) ターゲット・サーバ。 リモート・サーバに配備する場合は、完全修飾ホスト名を使用すること。
port 6212 (オプション) ターゲット・サーバの運用管理ポート。
protocol rmi (オプション) ドメインの運用管理エージェントとの接続プロトコルを選択します。指定できるプロトコルは、rmijmxmpです。
encrypted false (オプション) ドメインの運用管理エージェントのパスワードに暗号化されたパスワードを利用する場合に指定します。暗号化されたパスワードの生成にはencryptコマンドを使用してください。この属性はpasswordfileが指定されている場合のみ有効です。
secure false (オプション) trueを指定すると、ドメインの運用管理エージェントとの通信にSSL/TLSを利用します。
asinstalldir 説明を参照 (オプション) ローカルのWebOTXのインストール・ディレクトリで、運用管理コマンド(otxadminコマンド)を見つけるために使用されます。 指定されなければ、コマンドはasinstall.dirパラメータが設定されているかをチェックします。 それ以外は、運用管理コマンド(otxadminコマンド)にパスが通っていなければなりません。
webotxhome 説明を参照 (オプション) 非推奨。 代わりにasinstalldirを使用してください。

passwordfileに指定するファイルは、「OTX_ADMIN_PASSWORD=<パスワード>」を記述します。 例えば、パスワードが「adminadmin」の場合は「OTX_ADMIN_PASSWORD=adminadmin」と記述します。

6.2.1.3. 使用例

最初の例は、多くの既定属性値にしたがった単純なアプリケーション配備のスクリプトです。

<webotx-deploy
        file="${appdir}/simple_app.ear"
        passwordfile="${passwordfile}" />

次の例は、ポート: 6212のドメインに対して配備を要求するスクリプトです。 WebOTXインストール時に作成されるdomain1ドメインは、このポートを設定しています。

<webotx-deploy
        file="${sppdir}/simple_app.ear"
        name="simple_app"
        force="true"
        precompilejsp="false"
        verify="false"
        upload="true"
        user="admin"
        password="adminadmin"
        host="localhost"
        port="6212"
        asinstalldir="${webotxinstalldir}" />

次の例は、アプリケーショングループapg1、プロセスグループpg1に配備を行うスクリプトです。

<webotx-deploy
        file="${appdir}/simple_app.ear"
        apgroup="apg1"
        pgroup="pg1"
        passwordfile="${passwordfile}" />

次は、リモートで動作するWebOTXに複数のコンポーネントを配備する例です。

<webotx-deploy passwordfile="${passwordfile}" host="webotx.nec.com"
        asinstalldir="/opt/WebOTX" >
    <component file="${appdir}/simple_app.ear"/>
    <component file="${appdir}/simple_web.war"
      contextroot="example"/>
    <component file="${appdir}/simple_ejb.jar"/>
</webotx-deploy>

最後の例は、filesetサブ要素を用いて相当するコンポーネントを配備するものです。 先の例と同じ働きをします。 ただし、namecontextrootのようなコンポーネントに固有の属性設定ができないことに注意してください。 この場合、それらは既定値が用いられます。

<webotx-deploy passwordfile="${passwordfile}" host="webotx.nec.com"
      asinstalldir="/opt/WebOTX" >
    <fileset dir="${appdirs}" includes="**/*.?ar" />
</webotx-deploy>

6.2.2. webotx-undeploy

このタスクは、以下のコンポーネントの配備解除を行います。

6.2.2.1. サブ要素

次の表は、webotx-undeployタスクのサブ要素を示しています。 これらは、タスクが作用する対象のものです。

要素 説明
component 配備解除するコンポーネント
fileset 指定されたパラメータに対応するコンポーネント・ファイルのセット

これらは、以降の [ 6.3. 再利用可能なサブ要素 ] で後述します。

6.2.2.2. 属性

次の表は、webotx-undeployタスクの属性を示しています。

属性 既定値 説明
name 拡張子を除いたファイル名 (componentfilesetサブ要素が存在する場合、またはfile属性が指定されている場合はオプション、それ以外は必須) 配備するコンポーネントの名前。
file なし (オプション) 配備解除するコンポーネント。 この属性がファイルを参照する場合、それは有効なアーカイブでなければなりません。 この属性がディレクトリを示している場合は、全てのコンポーネントが展開されている有効なアーカイブを含んでいなければなりません。
type なし (オプション) 非推奨。
droptables nec-ejb-jar.xmlのエントリ (オプション) trueの場合は、Beanが配備解除された場合に削除するための最後に配備した際の自動的に生成されたデータベース・テーブルとなります。 falseの場合は、テーブルを削除しません。
 
指定されなければ、nec-ejb-jar.xml内のdrop-tables-at-undeploy属性値が使用されます。
cascade false (オプション) trueの場合は、配備解除するリソース・アダプタに関連付けられたコネクション・プールとコネクタ・リソースを全て削除します。
 
falseの場合は、まだ任意のプールかリソースがリソース・アダプタに関連付けられている場合、配備解除は失敗します。
 
この属性は、コネクタ(リソース・アダプタ)とコネクタ・モジュールを備えたアプリケーションに適用できます。
ejbunbind true (オプション) falseの場合、配備解除対象のコンポーネントのJNDI名をアンバインドしません。
statechecktimeout 120 (オプション) プロセスグループに配備したコンポーネントについて、コンポーネント状態確認のタイムアウト値を指定します。単位は秒です。
user admin (オプション) アプリケーション・サーバにログインする時に使用されるユーザ名。
password なし (オプション) 非推奨。代わりにpasswordfileを使用してください。 アプリケーション・サーバにログインする時に使用されるパスワード。
passwordfile なし (オプション) パスワードの記述を含んだファイル。 このファイルに記述されたパスワードによってアプリケーション・サーバとの通信を行います。 passwordpasswordfileの両方が指定された場合、passwordfileの方が優先されます。
host localhost (オプション) ターゲット・サーバ。 リモート・サーバに配備解除する場合は、完全修飾ホスト名を使用すること。
port 6212 (オプション) ターゲット・サーバの運用管理ポート。
protocol rmi (オプション) ドメインの運用管理エージェントとの接続プロトコルを選択します。指定できるプロトコルは、rmijmxmpです。
encrypted false (オプション) ドメインの運用管理エージェントのパスワードに暗号化されたパスワードを利用する場合に指定します。暗号化されたパスワードの生成にはencryptコマンドを使用してください。この属性はpasswordfileが指定されている場合のみ有効です。
secure false (オプション) trueを指定すると、ドメインの運用管理エージェントとの通信にSSL/TLSを利用します。
asinstalldir 説明を参照 (オプション) ローカルのWebOTXのインストール・ディレクトリで、運用管理コマンド(otxadminコマンド)を見つけるために使用されます。 指定されなければ、コマンドはasinstall.dirパラメータが設定されているかをチェックします。 それ以外は、運用管理コマンド(otxadminコマンド)にパスが通っていなければなりません。
webotxhome 説明を参照 (オプション) 非推奨。 代わりにasinstalldirを使用してください。

6.2.2.3. 使用例

最初の例は、単純なアプリケーション配備解除のスクリプトです。

<webotx-undeploy
        name="simple_app"
        user="admin"
        password="adminadmin"
        host="localhost"
        port="6212"
        asinstalldir="${webotxinstalldir}" />

次の例は、配備解除するJava EEアプリケーション(EAR)とWebアプリケーション(WAR)のアーカイブ・ファイルと、配備解除するEJBコンポーネントの名前を用いて、複数のコンポーネントを配備解除するものです。

<webotx-undeploy passwordfile="${passwordfile}">
    <component file="${appdir}/simple_app.ear"/>
    <component file="${appdir}/simple_web.war"/>
    <component name="simple_ejb" />
</webotx-undeploy>

6.2.3. webotx-component

WebOTXに配備された下記のコンポーネント・タイプを有効化(起動)、無効化(停止)します。

コンポーネント名が指定された場合は、コンポーネントの有効化/無効化のためにアーカイブ・ファイルを指定する必要はありません。 しかし、アーカイブ・ファイルが暗黙にコンポーネント名を特定するので、アーカイブ・ファイルを指定しても構いません。

6.2.3.1. サブ要素

次の表は、webotx-componentタスクのサブ要素を示しています。 これらは、タスクが作用する対象のものです。

要素 説明
component 配備済みのコンポーネント
fileset 指定されたパラメータに対応するコンポーネント・ファイルのセット

これらは、以降の [ 6.3. 再利用可能なサブ要素 ] で後述します。

6.2.3.2. 属性

次の表は、webotx-componentタスクの属性を示しています。

属性 既定値 説明
action なし 対象アプリケーション・サーバに対する制御コマンド。 有効な値は、enabledisableです。
name 拡張子を除いたファイル名 (componentfilesetサブ要素が存在する場合、またはfile属性が指定されている場合はオプション、それ以外は必須) 有効、または無効にするコンポーネントの名前。
file なし (オプション) 有効化、または無効化にするコンポーネント。 この属性がファイルを参照する場合、それは有効なアーカイブでなければなりません。 この属性がディレクトリを示している場合は、全てのコンポーネントが展開されている有効なアーカイブを含んでいなければなりません。
type なし (オプション) 非推奨。
statechecktimeout 120 (オプション) プロセスグループに配備したコンポーネントについて、コンポーネント状態確認のタイムアウト値を指定します。単位は秒です。
user admin (オプション) アプリケーション・サーバにログインする時に使用されるユーザ名。
password なし (オプション) 非推奨。 代わりにpasswordfileを使用してください。 アプリケーション・サーバにログインする時に使用されるパスワード。
passwordfile なし (オプション) パスワードの記述を含んだファイル。 このファイルに記述されたパスワードによってアプリケーション・サーバとの通信を行います。 passwordpasswordfileの両方が指定された場合、passwordfileの方が優先されます。
host localhost (オプション) ターゲット・サーバ。 リモート・サーバに有効化、または無効化をする場合は、完全修飾ホスト名を使用すること。
port 6212 (オプション) ターゲット・サーバの運用管理ポート。
protocol rmi (オプション) ドメインの運用管理エージェントとの接続プロトコルを選択します。指定できるプロトコルは、rmijmxmpです。
encrypted false (オプション) ドメインの運用管理エージェントのパスワードに暗号化されたパスワードを利用する場合に指定します。暗号化されたパスワードの生成にはencryptコマンドを使用してください。この属性はpasswordfileが指定されている場合のみ有効です。
secure false (オプション) trueを指定すると、ドメインの運用管理エージェントとの通信にSSL/TLSを利用します。
asinstalldir 説明を参照 (オプション) ローカルのWebOTXのインストール・ディレクトリで、運用管理コマンド(otxadminコマンド)を見つけるために使用されます。 指定されなければ、コマンドはasinstall.dirパラメータが設定されているかをチェックします。 それ以外は、運用管理コマンド(otxadminコマンド)にパスが通っていなければなりません。
webotxhome 説明を参照 (オプション) 非推奨。代わりにasinstalldirを使用してください。

6.2.3.3. 使用例

最初の例は、コンポーネントを無効化にする単純なものです。

<webotx-component
        action="disable"
        name="simple_app"
        passwordfile="${passwordfile}" />

次の例は、コンポーネントを有効化にする単純なものです。

<webotx-component
        action="enable"
        name="simple_app"
        passwordfile="${passwordfile}" />

この例では、いくつかの既定属性値を明示的に与えながら、WebOTXインストール時に作成されるdomain1ドメイン (ポート: 6212) に対してコンポーネントを有効化にする、上の例と同等なスクリプトです。

<webotx-component
        action="enable"
        name="simple_app"
        user="admin"
        passwordfile="${passwordfile}"
        host="localhost"
        port="6212"
        asinstalldir="${webotxinstalldir}" />

最後の例は、Java EEアプリケーション(EAR)とWebアプリケーション(WAR)のアーカイブ・ファイルと、EJBコンポーネントの名前を用いて、無効化にする複数のコンポーネントを定義するものです。

<webotx-component action="disable" passwordfile="${passwordfile}">
    <component file="${appdir}/simple_app.ear"/>
    <component file="${appdir}/simple_web.war"/>
    <component name="simple_ejb" />
</webotx-component>

6.2.4. webotx-admin

任意の運用管理コマンドやスクリプトからWebOTXアプリケーション・サーバの制御を実行できます。 特定のAntタスクを作っていなかったり、関連するコマンドの組み合わせが単一のスクリプトで構築される場合に役立ちます。

6.2.4.1. サブ要素

なし

6.2.4.2. 属性

次の表は、webotx-adminタスクの属性を示しています。

属性 既定値 説明
command なし (必ず次の中から1つ指定する必要がある属性: commandcommandfileexplicitcommand) 実行するコマンド。 user、password または passwordfilehostportの属性も指定される場合、実行の前にコマンドに自動的に挿入されます。 これらのオプションのうちのどれかがコマンド文字列で指定される場合、対応する属性値は無視されます。
commandfile なし (必ず次の中から1つ指定する必要がある属性: commandcommandfileexplicitcommand) 非推奨。 実行するコマンド・スクリプト。 commandfileが使用される場合、他の全ての属性値が無視されます。 必ずexitコマンドでcommandfileによって参照付けられたスクリプトを終了する必要があります。 すなわち、exitを省略すれば、Antタスクはコマンド・スクリプトが呼ばれた後にハングしたように見えます。
explicitcommand なし (必ず次の中から1つ指定する必要がある属性: commandcommandfileexplicitcommand) 実行する正確なコマンド。 コマンドは処理せずに終えます。 また、他の全ての属性が無視されます。
user admin (オプション) アプリケーション・サーバにログインする時に使用されるユーザ名。
password なし (オプション) 非推奨。 代わりにpasswordfileを使用してください。 アプリケーション・サーバにログインする時に使用されるパスワード。
passwordfile なし (オプション) パスワードの記述を含んだファイル。 このファイルに記述されたパスワードによってアプリケーション・サーバとの通信を行います。 passwordpasswordfileの両方が指定された場合、passwordfileの方が優先されます。
host localhost (オプション) ターゲット・サーバ。 それがリモート・サーバである場合は、完全修飾ホスト名を使用すること。
port 6212 (オプション) ターゲット・サーバの運用管理ポート。
protocol rmi (オプション) ドメインの運用管理エージェントとの接続プロトコルを選択します。指定できるプロトコルは、rmijmxmpです。
encrypted false (オプション) ドメインの運用管理エージェントのパスワードに暗号化されたパスワードを利用する場合に指定します。暗号化されたパスワードの生成にはencryptコマンドを使用してください。この属性はpasswordfileが指定されている場合のみ有効です。
secure false (オプション) trueを指定すると、ドメインの運用管理エージェントとの通信にSSL/TLSを利用します。
asinstalldir 説明を参照 (オプション) ローカルのWebOTXのインストール・ディレクトリで、運用管理コマンド(otxadminコマンド)を見つけるために使用されます。 指定されなければ、コマンドはasinstall.dirパラメータが設定されているかをチェックします。 それ以外は、運用管理コマンド(otxadminコマンド)にパスが通っていなければなりません。
webotxhome 説明を参照 (オプション) 非推奨。 代わりにasinstalldirを使用してください。
failonerror true コマンド実行中にエラーが発生した場合にビルド・プロセスを停止します。

6.2.4.3. 使用例

最初の例は、コネクタ・リソースの生成コマンドを実行するものです。

<webotx-admin command="create-connector-resource --poolname acos eis/vis" />

次の例は、コネクタ・リソースの生成コマンドを実行するために、commandfileを使用したものです。

<webotx-admin commandfile="create_connector_resource.txt" />

この例でのcreate_connector_resource.txtファイルは、以下の内容を含みます。

create-connector-resource --user admin --passwordfile "${passwordfile}" --host localhost --port 6212 --poolname acos eis/vis

最後の例は、コマンドを実行するために、explicitcommandを使用したものです。

<webotx-admin command="create-connector-resource --user admin --passwordfile "${passwordfile}" --host localhost --port 6212 --poolname acos eis/vis" />

6.2.5. webotx-jspc

WebOTXによるJSPの初回呼び出し時に生成する、JSPソース・コードからWebコンテナ用のサーブレットJavaコードへの変換と同じ処理を、このタスクでJSPのソース・コードの事前コンパイルとして実行します。 このタスクは、JSPファイルへのアクセス性能向上のためや、JSPソース・コードの構文チェックのために使用します。 JSPファイルからクラスファイルを生成するために、そこで出力しJavaコードをjavacタスクに与えることができます。

6.2.5.1. サブ要素

なし

6.2.5.2. 属性

属性 既定値 説明
destdir なし 生成したJavaソース・ファイルの出力先ディレクトリ。
srcdir なし (必ず次の中から1つ指定する必要がある属性: srcdirwebapp) JSPファイルが位置する入力先ディレクトリ。
webapp なし (必ず次の中から1つ指定する必要がある属性: srcdirwebapp) Webアプリケーションを含んだディレクトリ。 ディレクトリ内のJSPのファイルは、全て再帰的に解析されます。 ベースのディレクトリには、その下にWEB-INFサブディレクトリを持っていなければなりません。 webappが使用される場合、webotx-jspcはコンパイラに全ての依存性チェックを退けさせます。
verbose 2 (オプション) コンパイラに渡たす冗長メッセージの度合いを示す数値。
classpath なし (オプション) JSPコンパイラを実行するためのクラスパス。
classpathref なし (オプション) JSPコンパイラ・クラスパスへの参照。
uribase / (オプション) JSPファイルに関連するURIへの参照のURIコンテキスト。 このコンテキストが指定されない場合、宣言されたことに関連のあるJSPファイルの位置から類推するか、または、urirootの値から類推します。 明示的に宣言済みのJSPファイルから変換されたページだけが影響されます。
uriroot 説明を参照 (オプション) Webアプリケーションのルート・ディレクトリであり、URIのファイル群はそこから解決されます。 このディレクトリが指定されない場合、最初のJSPファイルは、次のことにしたがって類推されます。 ・最初のJSPファイルの各親ディレクトリがWEB-INFディレクトリから探索される。 ・そして、その中からJSPファイルに近いディレクトリが使用される。 WEB-INFディレクトリが見つからない場合、webotx-jspcが呼ばれたディレクトリが使用されます。 明示的に宣言済みのJSPファイル(タグ・ライブラリを含む)から変換されたページだけが影響されます。
package なし 生成されるJavaクラスの出力先パッケージ。
asinstalldir 説明を参照 (オプション) ローカルのWebOTXのインストール・ディレクトリで、jspcコマンドを見つけるために使用されます。 指定されなければ、コマンドはasinstall.dirパラメータが設定されているかをチェックします。 それ以外は、jspcコマンドにパスが通っていなければなりません。
webotxhome 説明を参照 (オプション) 非推奨。 代わりにasinstalldirを使用してください。
failonerror true コマンド実行中にエラーが発生した場合にビルド・プロセスを停止します。

6.2.5.3. 使用例

この例は、JSPファイルからJavaソース・ファイルを生成するために、webapp属性を使用するものです。 javacタスクはwebotx-jspcタスクに従って動作し、実装クラスのファイルとして生成されたJavaファイルをコンパイルします。 javacタスクの中のclasspath値は、スペースを含まない1行に全てを記述しなければなりません。

<webotx-jspc
        destdir="${appdir.war}/generated"
        webapp="${appdir.war}"
        classpath="${appdir.war}/WEB-INF/classes"
        asinstalldir="${webotxinstalldir}" />
<javac
        srcdir="${appdir.war}/WEB-INF/generated"
        destdir="${appdir.war}/WEB-INF/generated"
        debug="on"
        classpath="${appdir.war}/WEB-INF/classes:
                ${webotxinstalldir}/lib/wosv-rt.jar:
                ${webotxinstalldir}/lib/wosv-ext.jar">
    <include name="**/*.java"/>
</javac>

6.3. 再利用可能なサブ要素

WebOTX用のAntタスクにおける再利用可能なサブ要素は次のとおりです。 これらは、Antタスクが作用する対象のものです。

6.3.1. component

コンポーネントを指定します。 1つのタスクで複数のコンポーネントを操作できます。 component属性は、親のタスクの相当する属性をオーバーライドします。 したがって、親タスクの属性は既定値として機能します。

6.3.1.1. サブ要素

なし

6.3.1.2. 属性

属性 既定値 説明
file なし (親のタスクがwebotx-deployの場合は必須。webotx-undeploywebotx-componentの場合はオプション) 対象のコンポーネント。 この属性がファイルを参照する場合、それは有効なアーカイブでなければなりません。 この属性がディレクトリを示している場合は、全てのコンポーネントが展開されている有効なアーカイブを含んでいなければなりません。 uploadfalseに設定される場合、サーバ・マシン上の絶対パスである必要があります。
name 拡張子を除いたファイル名 (オプション) コンポーネントの名前。
type 親タスクで指定した値

[親タスクで指定していない場合]
なし
(オプション) (webotx-deployに適用する場合のみ有効) 配備されるコンポーネントの種類を指定します。指定可能な値はosgiのみです。OSGiバンドルを配備する際にosgiを指定します。それ以外の種類のコンポーネントは自動的に判別されます。
force 親タスクで指定した値

[親タスクで指定していない場合]
true
(オプション) (webotx-deployに適用する場合のみ有効) trueの場合、既にサーバに存在すればコンポーネントを上書きします。 falseの場合、コンポーネントが存在していれば、含まれるコンポーネントの操作は失敗します。
precompilejsp 親タスクで指定した値

[親タスクで指定していない場合]
false
(オプション) (webotx-deployに適用する場合のみ有効) trueの場合、Java EE Enterprise Application (.ear) かWebアプリケーション (.war) で見つかった全てのJSPファイルを事前コンパイルします。 この属性は、他のコンポーネント・タイプに対しては無視されます。
retrievestubs 親タスクで指定した値

[親タスクで指定していない場合]
クライアント・スタブは保存されない
(オプション) (webotx-deployに適用する場合のみ有効) クライアント・スタブが保存されるディレクトリ。
contextroot 拡張子を除いたファイル名 (オプション) (webotx-deployに適用する場合のみ有効) Webモジュール (WARファイル) のコンテキスト・ルート。 コンポーネントがWARファイルでない場合、この属性は無視されます。
verify 親タスクで指定した値

[親タスクで指定していない場合]
false
(オプション) (webotx-deployに適用する場合のみ有効) trueの場合、全ての配備記述子の構文とセマンティクスが自動的に正確に定義されているかを検証します。
enabled 親タスクで指定した値

[親タスクで指定していない場合]
true
(オプション) (webotx-deployに適用する場合のみ有効) trueの場合、コンポーネントを有効化します。
deploymentplan 親タスクで指定した値

[親タスクで指定していない場合]
なし
(オプション) (webotx-deployに適用する場合のみ有効) 配備プランは、WebOTX固有の配備記述子を含んだJARファイルです。 WebOTX固有の配備記述子を持たないアーカイブファイルを配備する場合に、この属性を使用してください。
rmic 親タスクで指定した値

[親タスクで指定していない場合]
false
(オプション) (webotx-deployに適用する場合のみ有効) RMI-IIOP用のスタブとタイを生成するかどうかを指定します。trueの場合はスタブとタイを生成し、falseの場合は生成しません。
libraries 親タスクで指定した値

[親タスクで指定していない場合]
なし
(オプション) (webotx-deployに適用する場合のみ有効) ライブラリJARファイルの絶対パス、相対パスを指定します。相対パスは、[ドメインディレクトリ]/lib/applibsからの相対パスを指定します。複数のパスを指定する場合、コンマを区切り文字として使用します。
keepstate 親タスクで指定した値

[親タスクで指定していない場合]
false
(オプション) (webotx-deployに適用する場合のみ有効) Webセッション、SFSBインスタンス、および永続的に作成されたEJBタイマーを、再配備時に保持するかどうかを指定します。trueの場合は再配備時に再配備前の値が保持され、falseの場合は保持されません。
hotswapenabled 親タスクで指定した値

[親タスクで指定していない場合]
false
(オプション) (webotx-deployに適用する場合のみ有効) アプリケーションでホットスワップ機能を有効にするかどうかを指定します。アプリケーションサーバでホットスワップ機能が有効になっている場合、trueを指定するとアプリケーション内のクラスファイルの更新を自動で検出し、変更されたクラスの再定義を行います。falseの場合は、クラスファイルの更新が検出されません。
preprocessor 親タスクで指定した値

[親タスクで指定していない場合]
なし
(オプション) (webotx-deployに適用する場合のみ有効) 配備前に実行するプリプロセッサを指定します。

6.3.1.3. 使用例

単一のタスクを使用して複数のコンポーネントを配備できます。 この例は、リモート・サーバ上で作動する同じアプリケーションサーバに各コンポーネントを配備します。

<webotx-deploy passwordfile="${passwordfile}" host="webotx.nec.com"
        asinstalldir="/opt/WebOTX" >
    <component file="${appdir}/simple_app.ear"/>
    <component file="${appdir}/simple_web.war"
      contextroot="test"/>
    <component file="${appdir}/simple_ejb.jar"/>
</webotx-deploy>

単一のタスクを使用して複数のコンポーネントを配備解除できます。 この例は、アーカイブ・ファイル (この場合、Java EEアプリケーション(EAR)とWebアプリケーション(WAR)) と、(EJBコンポーネントの) コンポーネント名を用いています。

<webotx-undeploy passwordfile="${passwordfile}">
    <component file="${appdir}/simple_app.ear"/>
    <component file="${appdir}/simple_web.war"/>
    <component name="simple_ejb" />
</webotx-undeploy>

複数のコンポーネントを有効化・無効化できます。 最後の例は、アーカイブ・ファイル (この場合、Java EEアプリケーション(EAR)とWebアプリケーション(WAR)) と、(EJBコンポーネントの) コンポーネント名を用いて複数のコンポーネントを無効化しています。

<webotx-component action="disable" passwordfile="${passwordfile}">
    <component file="${appdir}/simple_app.ear"/>
    <component file="${appdir}/simple_web.war"/>
    <component name="simple_ejb" />
</webotx-component>

6.3.2. fileset

指定したパラメータに対応するコンポーネントのファイルを選択します。 filesetがサブ要素として含まれる場合、そこに含まれる要素のnamecontextroot属性は、filesetの中でそれらの既定値を各ファイルに対して使用されなければなりません。