HomeDocumentation > 1. 管理 > 1.9. ツールとコマンド > 1.9.3. Deployer tool - デプロイヤー・ツール
{scrollbar}

top
デプロイヤー・アプリケーションは Java アプリケーションであり、Geronimo サーバーにおいて J2EE アーティファクトと GBean コンポーネントを管理します。Geronimo の実行中はサーバーに接続しサーバーのデプロイメント・サービスを通してアクションを実行します。実行中のサーバーが見つからない場合は、エラーを throw し、「サーバーに接続できなかった」もしくは「サーバーがダウンしている」と出力します。

デプロイメント・ツールは java -jar を使用することで始動し、 <geronimo_home>/bin/deployer.jar におけるメイン・クラスを起動します。

典型的には、デプロイメント・ツールは deploy スクリプトを使用することによって始動しますが、アプリケーションの実行には Java 仮想マシンを以下のシンタックスによって開始します。

java -jar deployer.jar <general_options> <command> <command_options>

<general_options> は全コマンドに適用できる共通オプションを指定し、アプリケーションがどのように振舞うかをコントロールします。 <command> はコマンド名で実行するアクションを指定し、 <command_options> は指定されたコマンドで決まるオプションです。

一般的なオプション

このセクションでは Geronimo デプロイヤー・ツールの使用可能な一般的な全オプションをリストします。

  • --uri <identifier>
    <identifier> は Universal Resource Identifier (URI) を指し、デプロイヤーがサーバーとどのようにコンタクトするかを指定します。このフラグが指定されない場合、デプロイヤーは localhost の標準ポートを使用してサーバーへのコンタクトをしようとします。 identifier は以下の形式で記述されます。
    deployer:geronimo:jmx:rmi:///jndi/rmi:[//host[:port]]/JMXConnector
    <host> はホスト名もしくはサーバーの起動しているシステムの TCP/IP アドレスで置き換えられ、<port> はサーバーが listen しているポート番号です。指定しない場合は localhost とデフォルト・ポートが使用されます。
  • --host <host>
    <host> はアプリケーションやリソースをデプロイしようとしているサーバーのホスト名です。このオプションによリモート・サーバーへのリソースとアプリケーションのデプロイが可能です。このパラメーターはオプションで、localhost がデフォルトです。
  • --port <port>
    <port> はアプリケーションやリソースをデプロイしようとしているリモート・サーバーのポートです。このパラメーターはオプションで、ポート 1099 がデフォルトです。.
  • --driver <driver_path>
    <driver_path> はドライバー JAR へのパスで、Geronimo 以外のサーバーとあわせて使用します。現在のところは、JAR の中の manifest Class-Path エントリーは無視されます。
  • --user <username>
    <username> はサーバー管理者権限を付与されたユーザー名です。コマンドが認証を必要とする場合、このオプションを使用します。
  • --password <password>
    <password> はユーザー名を認証するのに必要なパスワードです。指定しない場合は、デプロイヤーはパスワードなしでコマンドを実行しようとしますが、失敗すると、パスワードを入力するようプロンプトします。
  • --syserr <select>
    <select> は true もしくは false のどちらかです。指定しない場合は false が使用されます。  syserr デバイスにエラー情報をログしたい場合は true を指定してください。
  • --verbose <select>
    <select> は true もしくは false のどちらかです。指定しない場合は false が使用されます。 エラー原因を特定するためのメッセージを出力したい場合は true を指定してください。

Back to top

コマンド

Geronimo デプロイヤー・ツールとして使用可能なコマンドは以下の通りです。

加えて、あるコマンドの詳細をさらに知りたい場合は、 help と入力します。シンタックスは以下の通りです。

java -jar deployer.jar help <commands>

Back to top

Deploy deploy

deploy コマンドを使用し新規のモジュールを起動してみます。以下のシンタックスとなります。

java -jar deployer.jar <general_options> deploy <module> <deployment_plan>

<module> はアプリケーション・ファイル名とロケーションを指定します。 <deployment_plan> は XML によるデプロイメント・プランのファイル名とロケーションを指定します。アプリケーション・モジュールがパッケージ内にデプロイメント・プランをすでに含んでいることがあり、また、アプリケーションが非常に単純でデプロイメント・プランをまったく必要としない場合があります。こういった場合には、このパラメーターは省略できます。

モジュール・ファイルは以下のどれかになります。

  • J2EE Enterprise Application Archive (EAR) file
  • J2EE Web Application Archive (WAR) file
  • J2EE Enterprise JavaBean Archive (JAR) file
  • J2EE Java Resource Archive (RAR) file

アプリケーションのデプロイ時にサーバーが実行されていなかった場合は、サーバーの次回起動時にモジュールが有効になります。

もっとも一般的な <general_options> は、 --user および --password となります。 --inPlace オプションでは、アプリケーションのパッケージングの必要さえなく、Geronimo の外にあるディレクトリーから直接アプリケーションを指定しデプロイできるようにしてくれます。言い換えると、Geronimo でアプリケーションを起動させていても、そのアプリケーションは任意のファイル・システム上でよい、ということを意味します。

このオプションは以下のように使用します。

java -jar deployer.jar <general_options> deploy --inPlace <app_home>

<app_home> はアプリケーションのホーム・ディレクトリーを指定します。

Geronimo が起動していない状態でアプリケーションをデプロイしたい場合は、 --offline オプションを使用します。シンタックスは以下の通りです。

java -jar deployer.jar <general_options> --offline deploy <module>

もちろん、 --offline および --inPlace を組み合わせることもできます。

java -jar deployer.jar <general_options> --offline deploy --inPlace <app_home>

Back to top

Login login

login コマンドを使用し、カレント・ユーザーのホーム・ディレクトリーで .geronimo-deployer ファイルに、現在の接続情報としてユーザー名とパスワードを保存します。次から同じサーバーへの接続は、この保存された認証情報を使用し、可能な場合はプロンプトしません。

この情報はコネクション URL とは別に保存されます。よって、コマンドライン上で --url もしくは --host もしくは --port を指定し、異なるサーバーへのログインを保存できます。

login コマンドは以下のシンタックスとなります。

java -jar deployer.jar --user <user_name> --password <password> login

したがって、次回異なるコマンドを発行する際にも、本来であればユーザー名とパスワードを必要とするような場合でも、直接以下のようにコマンドを発行できます。

deploy list-modules

ログイン情報がクリア・テキストに保存されている訳ではないからといって、必ずしも安心とはいえません。もし安全に認証情報を保存しておきたい場合は、他者から読み書きされないように、自身のホーム・ディレクトリー内に .geronimo-deployer ファイルを変更します。

Back to top

Redeploy redeploy

redeploy コマンドを使用し、停止、置換、およびデプロイ済のモジュールの再起動を行います。リデプロイ・コマンドは以下のシンタックスを持ちます。

java -jar deployer.jar <general_options> redeploy <module> <deployment_plan>

deploy command と同様に、リデプロイ・コマンドも次のモジュールのファイル・タイプに対応します。

  • J2EE Enterprise Application Archive (EAR) file
  • J2EE Web Application Archive (WAR) file
  • J2EE Enterprise JavaBean Archive (JAR) file
  • J2EE Java Resource Archive (RAR) file

典型的には、モジュールとプランの両方がオプションとして指定されます。モジュールがプランを含んでいるか、デフォルト・プランが使用されれば、プラン用のオプションは省略できます。しかし、この場合にプランが指定されれば、他のプランをオーバーライドします。 プランが、すでにサーバー環境にデプロイされているサーバー・コンポーネントを参照している場合、モジュールのオプションは省略できます。

Back to top

Start start

start コマンドを使用し以前デプロイしたモジュールを開始します。以下のシンタックスとなります。

java -jar deployer.jar <general_options> start <moduleIDs>

<moduleIDs> はブランク・スペースによって区切られた1つ以上のモジュール (configID) のリストです。モジュールのID (つまり ConfigID) はデプロイ時に個々のデプロイメント・プランにおいて先にデプロイされた各モジュールに対して定義されます。

Back to top

Stop stop

stop コマンドを使用し、起動中のモジュールを停止します。以下のシンタックスとなります。

java -jar deployer.jar <general_options> stop <moduleIDs>

<moduleIDs> はブランク・スペースによって区切られた1つ以上のモジュール (configID) のリストです。 モジュールのID (つまり ConfigID) はデプロイ時に個々のデプロイメント・プランにおいて先にデプロイされた各モジュールに対して定義されます。

Back to top

Undeploy undeploy

undeploy コマンドを使用し、停止および(起動中かどうかにかかわらず)モジュールおよびサーバーからのデプロイ情報の除去を行います。以下のシンタックスとなります。

java -jar deployer.jar <general_options> undeploy <moduleIDs>

<moduleIDs> はブランク・スペースによって区切られた1つ以上のモジュール (configID) のリストです。 モジュールのID (つまり ConfigID) はデプロイ時に個々のデプロイメント・プランにおいて先にデプロイされた各モジュールに対して定義されます。

このコマンドは deploy の場合と同様、サーバーが起動していない状態でアプリケーションをアンインストールします。以下のシンタックスとなります。

java -jar deployer.jar <general_options> --offline undeploy <moduleID>

Back to top

Distribute distribute

distribute コマンドを使用し、サーバーへ新規モジュールの追加を行います。このコマンドではモジュールの開始を行ったり、開始の予定として登録したりしません。以下のシンタックスとなります。

java -jar deployer.jar <general_options> distribute <module> <deployment_plan>

デプロイ・コマンドと同様、 <module> はアプリケーションのファイル名とロケーションを指定します。モジュールがプランを含んでいるか、デフォルト・プランが使用されれば、プラン用のオプションは省略できます。しかし、この場合にプランが指定されれば、 他のプランをオーバーライドします。 プランが、すでにサーバー環境にデプロイされているサーバー・コンポーネントを参照している場合、モジュールのオプションは省略できます。

モジュール・ファイルは以下のうちの一つ となります。

  • J2EE Enterprise Application Archive (EAR) file
  • J2EE Web Application Archive (WAR) file
  • J2EE Enterprise JavaBean Archive (JAR) file
  • J2EE Java Resource Archive (RAR) file

Back to top

List-modules list-modules

list-modules コマンドを使用し、サーバー上の使用可能なモジュールをすべてリストします。このコマンドを実行するにはサーバーを起動していなければならないことに注意してください。以下のシンタックスとなります。

java -jar deployer.jar <general_options> list-modules [-{}{}all|started|-stopped ]

  • --all : デフォルトで他のオプションが指定されていない場合に使用されます。すべての使用可能なモジュールをリストします。
  • --started : このオプションでは起動しているモジュールのみリストされます。
  • --stopped : このオプションでは起動していないモジュールのみリストされます。

Back to top

List-targets list-targets

list-targets コマンドを使用し、接続しているサーバーへの既知のターゲットをリストします。以下のシンタックスとなります。

java -jar deployer.jar <general_options> list-targets

Geronimo の場合は、各構成ストアは別々のターゲットとなっています。ですので、Geronimo はターゲットとしてのクラスターをサポートしません。

Back to top

Install-plugin install-plugin

install-plugin コマンドを使用し、 Geronimo サーバーから先にエクスポートした、または、リポジトリーからダウンロードした Geronimo プラグインを導入します。 Geronimo プラグインはアプリケーションであり、そういったデータソースやドライバーの構成であり、またはそれらの混合されたものとなります。以下のシンタックスとなります。

java -jar deployer.jar install-plugin <plugin_file>

Back to top

Search-plugins search-plugins

search-plugins コマンドを使用し、Maven リポジトリーで使用可能な Geronimo プラグインを全てリストします。以下のシンタックスとなります。

java -jar deployer.jar search-plugins <maven_repository_URL>

Back to top