2.8.3 deploy
コンポーネントのデプロイ
書式
asadmin [asadmin-options] deploy [--help] [--force={false|true}] [--virtualservers virtual_servers] [--contextroot context_root] [--precompilejsp={false|true}] [--name component_name] [--upload={true|false}] [--retrieve local_dirpath] [--deploymentplan deployment_plan] [--altdd alternate_deploymentdescriptor] [--runtimealtdd runtime_alternate_deploymentdescriptor] [--deploymentorder deployment_order] [--enabled={true|false}] [--generatermistubs={false|true}] [--availabilityenabled={false|true}] [--libraries jar_file[,jar_file]...] [--target target] [--type pkg-type] [--properties name=value[:name=value]...] file_archive|filepath
格納先
Application Serverインストールディレクトリー/javaee/glassfish/bin
機能
deployサブコマンド は、アプリケーションをサーバにデプロイします。アプリケーションには、エンタープライズアプリケーション、Webアプリケーション、EJBモジュール、リソースアダプターアーカイブ、およびアプリケーションクライアントのモジュールがあります。コンポーネントがすでにデプロイされている場合、--force オプションに true を設定すると、強制的にリデプロイされます。
このサブコマンドはリモートモードだけサポートします。
アプリケーションのデプロイの実行時にドメイン管理サーバでOutOfMemoryErrorが発生した場合、ドメイン管理サーバのJavaヒープが不足している可能性があります。ドメイン管理サーバのJavaヒープサイズは、デプロイするアプリケーションアーカイブのサイズを考慮したサイズにしてください。
前提条件
ドメイン管理サーバは、稼働状態である必要があります。
ファイル
-
file_archiveまたはfilepathには、コマンドでデプロイされる入力ファイルを与えます。
-
--retrieveオプションを使用すると、--retrieveオプションで指定したファイルパスにクライアントスタブのJARファイルを生成します。
-
--deploymentplanオプションには、Java EE RIのDDを含む入力JARファイルを与えます。
-
--altddオプションには、標準DDを含む入力JARファイルを与えます。
-
--runtimealtddオプションには、Java EE RIのDDを与えます。
-
--generatermistubsオプションを使用すると、静的RMI-IIOPスタブが生成され、client.jarに包含されます。
-
--librariesオプションには、デプロイされたアプリケーションで利用できる入力ライブラリーJARファイルを与えます。
引数
- --help | -?
-
このサブコマンドのヘルプテキストを表示します。
- --force={false|true}
-
指定したコンポーネントがすでにデプロイされている場合に、コンポーネントをリデプロイするかどうかを指定します。
型:Boolean
指定できる値を次に示します。
-
true
-
false
デフォルト値:false
-
- --virtualservers virtual_servers
-
仮想サーバIDを指定します。複数のIDはコンマ(,)で区切ります。
型:String
指定できる値を次に示します。
-
仮想サーバID
デフォルト値:なし
-
- --contextroot context_root
-
アプリケーションのコンテキストルートを指定します。アーカイブがWebモジュールの場合にだけ有効です。
型:String
指定できる値を次に示します。
-
Webモジュールのコンテキストルート
デフォルト値:Webモジュールのアーカイブファイル(拡張子なし)
-
- --precompilejsp={false|true}
-
Webアプリケーションのデプロイ中に、Webアプリケーションが同梱するJSPファイルを、Java EEサーバが事前コンパイルするかどうかを指定します。事前コンパイルでは、Webアプリケーションに含まれる次の拡張子のファイルは、すべてコンパイルされます。
-
jsp
-
jspx
なお、JSPセグメントがWebアプリケーションに含まれる場合、JSPセグメントのファイル名に上記の拡張子を指定しないでください。JSPセグメントはJSP構文として成立しないことがあります。そのため、JSPセグメントのファイル名の拡張子に"jsp"または"jspx"を指定すると、JSP構文として成立しないJSPセグメントも事前コンパイルされ、コンパイルエラーとなる場合があります。
型:Boolean
指定できる値を次に示します。
-
true
-
false
デフォルト値:false
-
- --name component_name
-
デプロイするコンポーネントの名称を指定します。
名称にはオプションでバージョン識別子を入れることができます。この場合、名前の後にコロン(:)で区切って追加します。バージョン識別子は、文字または数値で始まる必要があります。使用できる文字は、英数字、アンダースコア(_)、ハイフン(-)およびピリオド(.)です。
型:String
指定できる値を次に示します。
-
コンポーネント名
デフォルト値:なし
-
- --upload={true|false}
-
ファイルをドメイン管理サーバにアップロードするかどうかを指定します。
filepathにディレクトリーが指定された場合、このオプションは無視されます。
型:Boolean
指定できる値を次に示します。
-
false
ファイルをアップロードしないで、指定したファイル名でファイルへのアクセスを試みます。ドメイン管理サーバがファイルにアクセスできない場合、このサブコマンドは失敗します。
例えば、ドメイン管理サーバが管理ユーザーとは異なるユーザーとして稼働している可能性があり、ファイルへのアクセス権がドメイン管理サーバにない場合があります。この状況では、--uploadオプションをfalseに設定すると、サブコマンドは失敗します。
-
true
ネットワーク接続経由でファイルをドメイン管理サーバにアップロードします。
デフォルト値:
-
サブコマンドを実行するホスト上にドメイン管理サーバがある場合
false
-
リモートホスト上にドメイン管理サーバがある場合
true
-
- --retrieve local_dirpath
-
サーバマシンからローカルディレクトリーにクライアントスタブのJARファイルを取得します。
型:String
指定できる値を次に示します。
-
クライアントスタブのJARファイルの格納先ディレクトリーパス
デフォルト値:なし
-
- --deploymentplan deployment_plan
-
Java EE RIのDDを含むJARファイルである、デプロイメントプランをデプロイします。
型:String
指定できる値を次に示します。
-
JARファイル名
デフォルト値:なし
-
- --altdd alternate_deploymentdescriptor
-
アプリケーションアーカイブの外にある標準DDを使用してアプリケーションをデプロイします。
代替となるDDは、アーカイブに含まれる最高位のDDをオーバーライドします。例えばEARの場合は、--altddオプションはapplication.xmlファイルをオーバーライドします。スタンドアロンモジュールの場合、--altddオプションはweb.xmlなどの最上位のモジュール記述子をオーバーライドします。
型:String
指定できる値を次に示します。
-
標準DD
デフォルト値:なし
-
- --runtimealtdd runtime_alternate_deploymentdescriptor
-
アプリケーションアーカイブの外にあるJava EE RIのDDを使用してアプリケーションをデプロイします。
代替となるDDは、アーカイブに含まれる最高位のDDをオーバーライドします。
スタンドアロンモジュールの場合、-runtimealtddオプションはglassfish-web.xmlなどの最上位のモジュール記述子をオーバーライドします。Java EE ServerのDDだけに適用されます(glassfish-*.xml)。代替となるDDファイルの名称は、glassfish-で始まる必要があります。非推奨のsun-*.xml DDには適用されません。
型:File
指定できる値を次に示します。
-
Java EE RIのDDのファイル名
デフォルト値:なし
-
- --deploymentorder deployment_order
-
アプリケーションのデプロイ順序を指定します。
小さい数値のアプリケーションは、大きい数値のアプリケーションの前にロードされます。
2つのアプリケーションのデプロイ順序が同じ場合、最初にデプロイされたアプリケーションがサーバ起動時に先にロードされます。
型:Integer
指定できる値を次に示します。
-
1〜2147483647
デフォルト値:100
-
- --enabled={true|false}
-
ユーザーがアプリケーションにアクセスできるかどうかを指定します。
型:Boolean
指定できる値を次に示します。
-
true
-
false
デフォルト値:true
-
- --generatermistubs={true|false}
-
スタブを生成するかどうかを指定します。
型:Boolean
指定できる値を次に示します。
-
true
-
false
デフォルト値:false
-
- --availabilityenabled={false|true}
-
Stateful Session Beanのチェックポインティングと潜在的なパッシべーション、およびWebセッションに対して、高可用性を有効にするかどうかを指定します。
型:Boolean
指定できる値を次に示します。
-
true
-
false
デフォルト値:false
-
- --libraries jar_file[,jar_file]...
-
add-libraryサブコマンドでJava EE Serverに追加したライブラリーJARファイルをコンマ区切りで指定します。ライブラリーJARファイルは、domain-dir/lib/applibsに対する相対パスで指定します。
型:String
デフォルト値:なし
- --target target
-
デプロイする対象を指定します。
型:String
指定できる値を次に示します。
-
server
ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。
-
domain
ドメインを対象とします。
ドメインが初期デプロイの対象の場合、アプリケーションはドメインにデプロイされます。このとき、サーバインスタンスまたはクラスターはアプリケーションを参照しません。ドメインがリデプロイの対象(--forceオプションでtrueを設定)で、アプリケーションを参照するクラスターまたはサーバインスタンスに対して動的再構成が有効な場合、参照しているクラスターまたはサーバインスタンスは自動的に新しいバージョンのアプリケーションを取得します。ドメインがリデプロイの対象で動的再構成が無効の場合、参照しているクラスターまたはサーバインスタンスは、クラスターまたはスタンドアロンのサーバインスタンスが再起動するまで新しいバージョンのアプリケーションを取得しません。
-
cluster_name
指定した名称のクラスターを対象とします。
-
instance_name
指定した名称のサーバインスタンスを対象とします。
デフォルト値:server
-
- --type pkg-type
-
デプロイする対象コンポーネントのアーカイブの形式を指定します。
型:String
指定できる値を次に示します。
-
car
コンポーネントはCARファイルとしてパッケージされます。
-
ear
コンポーネントはEARファイルとしてパッケージされます。
-
ejb
コンポーネントはJARファイルとしてパッケージされたEJBになります。
-
rar
コンポーネントはRARファイルとしてパッケージされます。
-
war
コンポーネントはWARファイルとしてパッケージされます。
デフォルト値:なし
-
- --properties name=value | --property name=value
-
デプロイメントに追加するプロパティーをキーと値のペア(キー = 値)で指定します。
型:String
デプロイメントには次のプロパティーを指定できます。
-
preserveAppScopedResources={false|true}
trueを設定した場合、アプリケーションスコープのすべてのリソースを保存し、リデプロイのあいだに復元します。
型:Boolean
指定できる値を次に示します。
true
false
デフォルト値:false
これら以外に利用できるプロパティーは、リデプロイするコンポーネントの実装によって決まります。
デフォルト値:なし
-
- file_archive|filepath
-
デプロイするアプリケーションを含むアーカイブへのパスを指定します。
型:String
-
アプリケーションを含むアーカイブファイルへのパス
デフォルト値:なし
-
使用例
次の例では、instance1という名称のサーバインスタンスに、Cart.earファイルに含まれるエンタープライズアプリケーションをデプロイします。
asadmin deploy --target instance1 Cart.ear
戻り値
戻り値 |
説明 |
---|---|
0 |
サブコマンドの実行に成功しました。 |
1 |
サブコマンドの実行中にエラーが発生しました。 |