B wldeploy Antタスクのリファレンス

次の項では、アプリケーションおよびスタンドアロン・モジュールをWebLogic Serverにデプロイするツールについて説明します。

wldeploy Antタスクの概要
wldeployを使用する基本手順
wldeploy用build.xmlファイルのサンプル
wldeploy Antタスクの属性のリファレンス

wldeploy Antタスクの概要

wldeploy Antタスクでは、Ant XMLファイルに指定する属性を使用してweblogic.Deployerの機能を実行できます。wldeployを他のWebLogic Server Antタスクとともに使用して、以下を実行する単一のAntビルド・スクリプトを作成できます。

wlcompile、appc、およびWebサービスAntタスクを使用してソースからアプリケーションをビルドします。
wlserverおよびwlconfig Antタスクを使用して、新しいWebLogic Serverドメインを作成、起動、および構成します。
wldeploy Antタスクを使用して、新しく作成したドメインに、コンパイル済みアプリケーションをデプロイします。

wlserver およびwlconfigの詳細は、第2章「Antタスクを使用したWebLogic Serverドメインの構成と使用」を参照してください。wlcompileの詳細は、第4章「分割開発ディレクトリでのアプリケーションのビルド」を参照してください。

wldeployを使用する基本手順

wldeploy Antタスクを使用するには:

環境を設定します。

Windows NTでは、WL_HOME\server\binディレクトリにあるsetWLSEnv.cmdコマンドを実行します。WL_HOMEは、インストールされているWebLogic Serverの最上位ディレクトリです。

UNIXでは、WL_HOME/server/binディレクトリにあるsetWLSEnv.shコマンドを実行します。WL_HOMEは、インストールされているWebLogic Serverの最上位ディレクトリです。
ステージング・ディレクトリで、Antビルド・ファイル(デフォルトはbuild.xml)を作成します。WebLogic Serverと一緒にインストールされたものとは異なるAntを使用する場合は、wldeploy Antタスクを定義することから始めます。
```
<taskdef name="wldeploy" classname="weblogic.ant.taskdefs.management.WLDeploy"/>
```
必要に応じて、新しいWebLogic Serverドメインを作成するためのタスク定義とwlserverおよびwlconfigタスクの呼出しをビルド・スクリプトに追加します。wlserverおよびwlconfigの詳細は、第2章「Antタスクを使用したWebLogic Serverドメインの構成と使用」を参照してください。
wldeployの呼出しを追加して、アプリケーションを1つまたは複数のWebLogic Serverインスタンスまたはクラスタにデプロイします。「wldeploy用build.xmlファイルのサンプル」および「wldeploy Antタスクの属性のリファレンス」を参照してください。
ステージング・ディレクトリでantと入力し、必要であればこのコマンドにターゲットの引数を渡して、build.xmlファイルで指定されたAntタスク(1つまたは複数)を実行します。
```
prompt> ant
```

wldeploy用build.xmlファイルのサンプル

次の例では、アプリケーションを単一のWebLogic Serverインスタンスにデプロイするwldeployのデプロイ先を示しています。

  <target name="deploy">
    <wldeploy
      action="deploy" verbose="true" debug="true"
      name="DeployExample" source="output/redeployEAR"
      user="weblogic" password="weblogic"
      adminurl="t3://localhost:7001" targets="myserver" />
  </target>

次の例では、アプリケーションをアンデプロイする場合に対応するタスクを示します。この例では、アプリケーションをアンデプロイまたは再デプロイする際に、ソース・アーカイブ・ファイルまたは展開ディレクトリではなく、そのデプロイされた名前のみを指定します。

  <target name="undeploy">
    <wldeploy
      action="undeploy" verbose="true" debug="true"
      name="DeployExample"
      user="weblogic" password="weblogic"
      adminurl="t3://localhost:7001" targets="myserver"
      failonerror="false" />
  </target>

次の例では、アプリケーションの部分的な再デプロイを実行する方法を示します。この例では、アプリケーション内の単一のWARファイルのみが再デプロイされます。

  <target name="redeploy_partial">
    <wldeploy
      action="redeploy" verbose="true"
      name="DeployExample"
      user="weblogic" password="weblogic"
      adminurl="t3://localhost:7001" targets="myserver"
      deltaFiles="examples/general/redeploy/SimpleImpl.war" />
  </target>

次の例では、wldeployのネストされた<files>子要素を使用して、アプリケーション内でアンデプロイする特定のファイルを指定します。

  <target name="undeploy_partial">
    <wldeploy
      action="undeploy" verbose="true" debug="true"
      name="DeployExample"
      user="weblogic" password="weblogic"
      adminurl="t3://localhost:7001" targets="myserver"
      failonerror="false">
      <files
         dir="${current-dir}/output/redeployEAR/examples/general/redeploy"
         includes="SimpleImpl.jsp" />
    </wldeploy>
  </target>

次の例では、ソース・ファイルがoutput/myLibraryディレクトリにあるmyLibraryというJava EEライブラリをデプロイする方法を示します。

  <target name="deploy">
    <wldeploy action="deploy" name="myLibrary"
      source="output/myLibrary" library="true"
      user="weblogic" password="weblogic"
      verbose="true" adminurl="t3://localhost:7001"
      targets="myserver" />
  </target>

wldeploy Antタスクの属性のリファレンス

次の項では、wldeploy Antタスクの属性および子要素<files>について説明します。

主な属性

次の表では、wldeploy Antタスクの主な属性について説明します。

これらの属性は、weblogic.Deployerコマンドの引数の一部に対応します。Oracleは、反復的な開発プロセスの一部としてアプリケーションを簡単にデプロイおよびテストできるように、weblogic.DeployerコマンドのAntタスク・バージョンを提供しています。ただし、通常、本番環境でアプリケーションをデプロイする場合、wldeploy Antタスクではなくweblogic.Deployerコマンドを使用します。したがって、wldeploy Antタスクの属性の完全な定義については、『Oracle WebLogic Serverへのアプリケーションのデプロイ』のweblogic.Deployerコマンドライン・リファレンスに関する項を参照してください。次の表に簡単な概要を示します。

表B-1 wldeploy Antタスクの属性

属性	説明	データ型
action	実行するデプロイメント・アクション。有効な値は、`deploy`、`cancel`、`undeploy`、`redeploy`、`distribute`、`start`、および`stop`です。	文字列
adminmode	デプロイメント・アクションによってアプリケーションが管理モードになるように指定します。管理モードでは、アプリケーションへのアクセスは構成済の管理チャネルに制限されます。この属性の有効な値は、`true`および`false`です。デフォルト値は`false`です - つまり、デフォルトでは、アプリケーションは、すべてのクライアントがすぐにアクセスできるように本番モードでデプロイされます。	ブール
adminurl	管理サーバーのURL。この属性の値の形式は、`protocol://host:port`です - ここで、`protocol`は`http`または`t3`、`host`は管理サーバーが実行されているホスト、`port`は管理サーバーがリスニングしているポートです。注意: HTTPプロトコルを使用するには、管理コンソールでhttpトンネリングのオプションを有効にする必要があります。	文字列
allversions	アプリケーションのすべてのバージョンに適用するアクション(再デプロイ、停止など)を指定します。この属性の有効な値は、`true`および`false`です。デフォルト値は`false`です。	ブール
altappdd	デプロイメントに使用する代替Java EEデプロイメント記述子(`application.xml`)の名前を指定します。この属性を指定せず、エンタープライズ・アプリケーションをデプロイする場合、デフォルトのデプロイメント記述子は`application.xml`という名前で、アプリケーションのメイン・ディレクトリまたはアーカイブ(`source`属性で指定)のMETA-INFサブディレクトリに置かれます。	文字列
altwlsappdd	デプロイメントに使用する代替WebLogic Serverデプロイメント記述子(`weblogic-application.xml`)の名前を指定します。この属性を指定せず、エンタープライズ・アプリケーションをデプロイする場合、デフォルトのデプロイメント記述子は`weblogic-application.xml`という名前で、アプリケーションのメイン・ディレクトリまたはアーカイブ(`source`属性で指定)のMETA-INFサブディレクトリに置かれます。	文字列
appversion	デプロイされるアプリケーションのバージョン識別子。	文字列
debug	`wldeploy`デバッグ・メッセージを有効にします。	ブール
deleteFiles	サーバーのステージング・ディレクトリから静的ファイルを削除するかどうかを指定します。この属性は、展開されたデプロイメント、および`stage`モードを使用してデプロイされたアプリケーションでのみ有効です。この属性を使用するときは、ターゲット・サーバーを指定する必要があります。 `deleteFiles`属性を指定すると、デプロイメント時にステージング領域にコピーされたファイルのみが削除されます。この属性は、`action="redeploy"`と一緒にしか使用できません。 `deleteFiles`属性では指定したすべてのファイルが削除されるので、`deleteFiles`を使用する場合は慎重を期し、また、本番環境では使用しないことをお薦めします。この属性の有効な値は、trueおよびfalseです。デフォルト値はfalseです。	ブール
deltaFiles	再デプロイするアプリケーションのルート・ディレクトリを基準にして、ファイルのカンマ区切りまたはスペース区切りのリストを指定します。この属性は、アプリケーションの部分再デプロイを実行する際、必ず`action="redeploy"`と組み合わせて使用します。	文字列
enableSecurityValidation	セキュリティ・データの検証を有効にするかどうかを指定します。この属性の有効な値は、trueおよびfalseです。デフォルト値はfalseです。	ブール
externalStage	デプロイメントで`external_stage`デプロイメント・モードを使用するかどうかを指定します。このモードでは、Antタスクはデプロイメント・ファイルをターゲット・サーバーにコピーしません。かわりに、デプロイメント・ファイルがターゲット・サーバーのステージング・ディレクトリの正しいサブディレクトリにコピーされたことを確認する必要があります。 `stage`、`nostage`または`external_stage`のいずれかの属性のみを指定できます。何も指定しない場合、管理ターゲット・サーバーに対するデフォルトのデプロイメント・モードは`stage`、単一のサーバーでの管理サーバーに対するデフォルト・モードは`nostage`です。「ステージング・モードによるデプロイメント・ファイルのコピーの制御」を参照してください。	ブール
failonerror	WebLogic Server Antタスクで使用されるグローバル属性。ビルド中にエラーが発生した場合、タスクを失敗させるかどうかを指定します。この属性の有効な値は、trueおよびfalseです。デフォルト値はtrueです。	ブール
graceful	既存のHTTPクライアントが作業を完了した後でアプリケーションを停止します。この属性は、アプリケーションを停止またはアンデプロイする場合にのみ使用できます。つまり、`action="stop"`か`action="undeploy"`のいずれかも指定する必要があります。この属性の有効な値は、`true`および`false`です。デフォルト値は`false`です。	ブール
id	デプロイメントのステータスの取得やデプロイメントの取消しに使用されるID。デプロイ時に一意のIDをアプリケーションに割り当て、以降の再デプロイ、アンデプロイ、停止などではそのIDを使用します。この属性を指定しない場合、Antタスクがアプリケーションに一意のIDを割り当てます。	文字列
ignoresessions	このオプションでは、現在のHTTPセッションが完了するのを待機せずに、アプリケーションを直ちに管理モードにします。この属性は、アプリケーションを停止またはアンデプロイする場合にのみ使用できます。つまり、`action="stop"`か`action="undeploy"`のいずれかも指定する必要があります。この属性の有効な値は、`true`および`false`です。デフォルト値は`false`です。	ブール
libImplVer	Java EEライブラリまたはオプション・パッケージの実装のバージョンを指定します。この属性は、ライブラリまたはパッケージのマニフェスト・ファイルに実装のバージョンが含まれていない場合にのみ使用できます。この属性は、`library`属性との組み合わせでのみ指定できます。第9章「共有Java EEライブラリおよびオプション・パッケージの作成」を参照してください。	文字列
library	デプロイメントを共有Java EEライブラリまたはオプション・パッケージとして指定します。Java EEライブラリまたはオプション・パッケージをデプロイまたは分散する場合は`library`属性を指定する必要があります。この属性の有効な値は、`true`および`false`です。デフォルト値は`false`です。第9章「共有Java EEライブラリおよびオプション・パッケージの作成」を参照してください。	ブール
libSpecVer	Java EEライブラリまたはオプション・パッケージの仕様のバージョンを指定します。この属性は、ライブラリまたはパッケージのマニフェスト・ファイルに仕様バージョンが含まれていない場合にのみ使用できます。この属性は、`library`属性との組み合わせでのみ指定できます。第9章「共有Java EEライブラリおよびオプション・パッケージの作成」を参照してください。	文字列
name	デプロイ済みのアプリケーションのデプロイメント名。この属性を指定しない場合、WebLogic Serverは、アーカイブ・ファイルまたは展開ディレクトリに基づくデプロイメント名をアプリケーションに割り当てます。	文字列
nostage	デプロイメントでnostageデプロイメント・モードを使用するかどうかを指定します。このモードでは、Antタスクはデプロイメント・ファイルをターゲット・サーバーにコピーせず、`source`属性で指定された固定の場所に残します。ターゲット・サーバーは、デプロイメント・ファイルの同じコピーにアクセスします。 `stage`、`nostage`または`external_stage`のいずれかの属性のみを指定できます。何も指定しない場合、管理ターゲット・サーバーに対するデフォルトのデプロイメント・モードは`stage`、単一のサーバーでの管理サーバーに対するデフォルト・モードは`nostage`です。「ステージング・モードによるデプロイメント・ファイルのコピーの制御」を参照してください。	ブール
noversion	`wldeploy` Antタスクが管理サーバーにあるバージョン関連のすべてのコード・パスを無視することを指定します。この動作は、デプロイメント・ソース・ファイルが(管理サーバーではなく)管理ターゲット・サーバーにあり、external_stageステージング・モードを使用する場合に有用です。このオプションを使用する場合、バージョン指定されたアプリケーションは使用できません。この属性の有効な値は、trueおよびfalseです。デフォルト値はfalseです。	ブール
nowait	`wldeploy`が(バックグラウンド・タスクとしてデプロイすることによって)デプロイメント呼出しを行った後、ただちに復帰するかどうかを指定します。	ブール
password	管理パスワード。ビルド・ファイルまたは`ps`などのプロセス・ユーティリティでパスワードがプレーン・テキストで表示されないようにするには、まずWebLogic Scripting Tool (WLST)の`storeUserConfig`コマンドを使用して有効なユーザー名と暗号化されたパスワードを構成ファイルに格納します。次に、Antビルド・ファイルで`username`および`password`の両属性を省略します。これらの属性を省略すると、`wldeploy`はデフォルト構成ファイルの値を使用してログインを試みます。デフォルト以外の構成ファイルとキー・ファイルからユーザー名およびパスワードを取得する場合は、`wldeploy`で`userconfigfile`属性と`userkeyfile`属性を使用します。パスワードの格納と暗号化の詳細は、WebLogic Scripting Toolコマンド・リファレンスの`storeUserConfig`のコマンド・リファレンスを参照してください。	文字列
plan	アプリケーションまたはモジュールをデプロイするときに使用するデプロイメント・プランを指定します。デフォルトでは、プランが格納されているアプリケーションのルート・ディレクトリからデプロイする場合でも、`wldeploy`は利用可能なデプロイメント・プランを使用しません。	文字列
planversion	デプロイメント・プランのバージョン識別子。	文字列
remote	サーバーが別のマシンに配置されているかどうかを指定します。これはファイル名の転送方法に影響します。この属性の有効な値は、`true`および`false`です。デフォルト値は`false`です - つまり、Antタスクは、すべてのソース・パスがローカル・マシン上の有効なパスであると見なします。	ブール
retiretimeout	WebLogic Serverがこのアプリケーションまたはモジュールの現在実行中のバージョンをアンデプロイし、クライアントが新しいバージョンで開始できるようになるまでの秒数を指定します。この属性を指定した場合、ユーザーは、すでに実行中のアプリケーションの新しいバージョンを開始、デプロイ、再デプロイすると見なされます。「本番環境でのアプリケーションの更新」を参照してください。	int
securityModel	このデプロイメントで使用するセキュリティ・モデルを指定します。指定可能なセキュリティ・モデルは次のとおりです。デプロイメント記述子のみカスタム・ロールカスタム・ロールおよびポリシーセキュリティ・レルム構成(詳細モデル) この属性で有効な実際の値は`DDOnly`、`CustomRoles`、`CustomRolesAndPolicy`、または`Advanced`です。これらのセキュリティ・モデルの詳細は、「WebアプリケーションおよびEJBリソースの保護のオプション」を参照してください。	文字列
source	デプロイするアーカイブ・ファイルまたは展開ディレクトリ。	ファイル
stage	デプロイメントでstageデプロイメント・モードを使用するかどうかを指定します。このモードでは、Antタスクは、ターゲット・サーバーのステージング・ディレクトリにデプロイメント・ファイルをコピーします。 `stage`、`nostage`または`external_stage`のいずれかの属性のみを指定できます。何も指定しない場合、管理ターゲット・サーバーに対するデフォルトのデプロイメント・モードは`stage`、単一のサーバーでの管理サーバーに対するデフォルト・モードは`nostage`です。「ステージング・モードによるデプロイメント・ファイルのコピーの制御」を参照してください。	ブール
submoduletargets	JMSアプリケーション・モジュール内で定義されているリソースのJMSサーバー・ターゲットを指定します。この属性の値は、JMSサーバー名のカンマ区切りのリストです。「JMSアプリケーション・モジュールにおけるサブモジュールのターゲット指定の使用」を参照してください。	文字列
targets	アプリケーションがデプロイされるターゲット・サーバーのリスト。この属性の値は、ターゲット・サーバー、クラスタまたは仮想ホストのカンマ区切りのリストです。アプリケーションのデプロイ時にターゲット・リストを指定しない場合、ターゲットのデフォルトは管理サーバー・インスタンスになります。	文字列
timeout	デプロイメントが正常に終了するのを待機する最大秒数。	int
upload	デプロイメントの前にソース・ファイルが管理サーバーのアップロード・ディレクトリにコピーされるかどうかを指定します。この属性は、リモート・マシンで作業していて、デプロイメント・ファイルを管理サーバーに他の手段でコピーできない場合に使用します。この属性の有効な値は、`true`および`false`です。デフォルト値は`false`です。	ブール
usenonexclusivelock	デプロイメント・アクション(デプロイ、再デプロイ、停止など)が、そのアクションを実行している同じユーザーによってすでに取得されている、ドメインの既存のロックを使用するように指定します。この属性は、ユーザーが複数のデプロイメント・ツール(Antタスク、コマンド・ライン、管理コンソールなど)を同時に使用しており、いずれかのツールでドメインのロックをすでに取得している場合に有用です。この属性の有効な値は、`true`および`false`です。デフォルト値は`false`です。	ブール
user	管理ユーザー名。	文字列
userconfigfile	管理ユーザー名および管理パスワードを取得するために使用するユーザー構成ファイルの場所を指定します。このオプションは、プレーン・テキストのパスワードをインラインまたは`ps`などのプロセス・レベルのユーティリティで表示したくない場合に、ビルド・ファイルで`user`および`password`属性のかわりに使用します。 `userconfigfile`属性を指定する前に、WebLogic Scripting Toolコマンド・リファレンスの説明に従い、WebLogic Scripting Tool (WLST)の`storeUserConfig`コマンドを使用してファイルを生成する必要があります。	文字列
userkeyfile	ユーザー構成ファイル(`userconfigfile`属性)に格納されたユーザー名とパスワードの情報を暗号化および復号化するために使用するユーザー・キー・ファイルの場所を指定します。 `userkeyfile`属性を指定する前に、WebLogic Scripting Toolコマンド・リファレンスの説明に従い、WebLogic Scripting Tool (WLST)の`storeUserConfig`コマンドを使用してキー・ファイルを生成する必要があります。	文字列
verbose	`wldeploy`で詳細出力メッセージを表示するかどうかを指定します。	ブール

ネストされた<files>子要素

wldeploy Antタスクには、デプロイメント・アクションの実行対象となるファイルのリスト(アンデプロイするJSPのリストなど)を指定するためにネストできる<files>子要素もあります。

注意:

WebLogic Serverリリース9.0以降では、<files>を使用してアプリケーションのファイルのリストを再デプロイすることは非推奨になりました。この場合、代わりにwldeployのdeltaFiles属性を使用します。

<files>要素は、実際のタスク名の違いを除いて、標準的な<fileset> Antタスクと同じ処理を行います。したがって、<files>要素で指定可能な属性のリファレンス情報については、Apache Ant Webサイト(http://ant.apache.org/manual/Types/fileset.html)を参照してください。