WebLogic Server アプリケーションの開発

     前  次    新しいウィンドウで目次を開く   
ここから内容の開始

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

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

 

wldeploy Ant タスクの概要

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

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

 

wldeploy を使用する基本手順

wldeploy Ant タスクを使用するには、次の手順に従います。

  1. 環境を設定します。

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

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

  2. ステージング ディレクトリで、Ant ビルド ファイル (デフォルトは build.xml) を作成します。WebLogic Server と一緒にインストールされたものとは異なる Ant を使用する場合は、wldeploy Ant タスクを定義することから始めます。
    3. <taskdef name="wldeploy" classname="weblogic.ant.taskdefs.management.WLDeploy"/>
  3. 必要に応じて、新しい WebLogic Server ドメインを作成するためのタスク定義と wlserver および wlconfig タスクの呼び出しをビルド スクリプトに追加します。wlserver および wlconfig の詳細については、「Ant タスクを使用した WebLogic Server ドメインのコンフィグレーションと使用」を参照してください。
  4. wldeploy の呼び出しを追加して、アプリケーションを 1 つまたは複数の WebLogic Server インスタンスまたはクラスタにデプロイします。「wldeploy 用 build.xml ファイルのサンプル」と「wldeploy Ant タスクの属性のリファレンス」を参照してください。
  5. ステージング ディレクトリで ant と入力し、必要であればこのコマンドにターゲットの引数を渡して、build.xml ファイルで指定された Ant タスク (1 つまたは複数) を実行します。
    6. 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 タスクの属性の完全な定義については、『WebLogic Server アプリケーションのデプロイメント』の「weblogic.Deployer コマンドライン リファレンス」を参照してください。次の表に簡単な概要を示します。

表 B-1 wldeploy Ant タスクの属性
属性
説明
データ型
action
実行するデプロイメント アクション。
有効な値は、deploy、cancel、undeploy、redeploy、distribute、start、および stop。
String
adminmode
デプロイメント アクションによってアプリケーションが管理モードになるように指定する。
管理モードでは、アプリケーションへのアクセスはコンフィグレーション済みの管理チャネルに制限される。
この属性の有効な値は、true および false。デフォルト値は false。つまり、デフォルトでは、アプリケーションは、すべてのクライアントがすぐにアクセスできるようにプロダクション モードでデプロイされる。
Boolean
adminurl
管理サーバの URL。
この属性の値の形式は protocol://host:port。protocol は http または t3、host は管理サーバが動作しているホスト、port は管理サーバがリスンしているポート。

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

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

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

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

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


  ページの先頭       前  次