リファレンス ガイド

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

Deployer コマンドライン リファレンス

この節では、以下の項目について説明します。

 

Deployer コマンドライン ユーティリティの使い方の概要

Deployer は、管理者や開発者が Oracle CEP アプリケーションのデプロイ操作をコマンドラインで実行するための Java ベースのデプロイメント ユーティリティです。Oracle CEP デプロイメントのコンテキストでは、アプリケーションは次のアーティファクトを含む OSGi バンドル JAR ファイルとして定義されます。

このデプロイメント バンドルを作成する方法の詳細については、「Oracle CEP アプリケーションのアセンブル : 主な手順」を参照してください。

Deployer ユーティリティは HTTP を使用して Oracle CEP に接続します。つまり、アプリケーションのデプロイ先となるサーバ インスタンスに応じて Jetty をコンフィグレーションする必要があります。詳細については、Oracle CEP のコンフィグレーション」を参照してください。

Oracle CEP は、deployments.xml ファイルを使用して、デプロイ済みアプリケーションの OSGi バンドルのリストを内部的に維持します。このファイルは DOMAIN_DIR/servername ディレクトリにあります。DOMAIN_DIR はメイン ドメイン ディレクトリであり、アプリケーションのデプロイ先となるサーバ インスタンスに対応します。servername はサーバ インスタンス自体です。このファイルについては、「デプロイメントの XSD スキーマ」を参照してください。

警告 : deployments.xml ファイルの XSD は、あくまでも参考として示しています。deployments.xml ファイルを手動で更新することは、お勧めしません。

 

Deployer ユーティリティに必要な環境

Deployer ユーティリティを使用するための環境を設定するには、次の手順に従います。

  1. Oracle CEP のインストールの説明に従って、Oracle CEP ソフトウェアをインストールおよびコンフィグレーションします。
  2. コマンド ウィンドウを開き、「開発環境の設定」の説明に従って、環境を設定します。
  3. ORACLE_CEP_HOME/ocep_10.3/bin ディレクトリにある wlevsdeploy.jar JAR ファイルを含むように CLASSPATH 変数を更新します。ORACLE_CEP_HOME は、/oracle_cep などの Oracle CEP メイン インストール ディレクトリです。

 

Deployer ユーティリティのリモート実行

Oracle CEP をインストールして実行しているコンピュータとは別のコンピュータで Deployer ユーティリティを実行すると便利な場合があります。このユーティリティをリモートで実行するには、次の手順に従います。

  1. Oracle CEP がインストールされているコンピュータから Deployer ユーティリティを実行するコンピュータに、次の JAR ファイルをコピーします。JAR ファイルのコピー先のディレクトリ名は、任意の名前とすることができます。
    • ORACLE_CEP_HOME/ocep_10.3/bin/wlevsdeploy.jar

      • ORACLE_CEP_HOME は、Oracle CEP のインストール先のメイン ディレクトリです。

  2. 次のいずれかの方法で CLASSPATH を設定します。
    • ユーティリティ実行時に、-jar 引数を使用して CLASSPATH を暗黙的に設定します。つまり、この引数で NEW_DIRECTORY/wlevsdeploy.jar ファイルを設定します。NEW_DIRECTORY は、必要な JAR ファイルをコピーしたリモート コンピュータ上のディレクトリです。-jar 引数を使用するときは、コマンドラインで Deployer ユーティリティ名を指定しません。
    • リモート コンピュータにコピーした JAR ファイルを CLASSPATH 環境変数に追加することにより、明示的に CLASSPATH を更新します。
  3. 次の節の説明に従って Deployer ユーティリティを呼び出します。

 

Deployer ユーティリティを呼び出すための構文

Deployer ユーティリティを使用するための構文は次のとおりです。 

java -jar wlevsdeploy.jar 
      [接続の引数]
      [ユーザ資格の引数] 
      [デプロイメント コマンド]

以下の節では、Deployer ユーティリティで使用できるさまざまな引数およびコマンドについて説明します。このユーティリティの具体的な使い方の例については、「Deployer ユーティリティの使用例」を参照してください。

接続の引数

次の表は、Deployer ユーティリティで指定できる接続の引数を示しています。

表 3-1 接続の引数
引数
説明
-url url
OSGI バンドルのデプロイ先となる Oracle CEP インスタンスのデプロイヤの URL を指定します。
URL は次の形式にします。

http://host:port/wlevsdeployer

各項目は次のとおりです。
  • host は、Oracle CEP を実行しているコンピュータのホスト名です。
  • port は Oracle CEP がリスンするポート番号であり、その値はデフォルトで 9002 です。このポートは、Oracle CEP ドメインを記述する config.xml ファイルで指定されます。このファイルは DOMAIN_DIR/config ディレクトリにあります (DOMAIN_DIR はドメイン ディレクトリを表します)。ポート番号は、<Netio> 要素の <Port> 子要素の値です。

    • <Netio>
    <Name>NetIO</Name>
    <Port>9002</Port>
    </Netio>

たとえば、Oracle CEP がホスト ariel のポート 9002 で実行されている場合、URL は次のようになります。

http://ariel:9002/wlevsdeployer

ユーザ資格の引数

次の表は、Deployer ユーティリティで指定できるユーザ資格の引数を示しています。

表 3-2 ユーザ資格の引数
引数
説明
-user username
Oracle CEP 管理者のユーザ名。
-user オプションを指定し、対応する -password オプションを指定しなかった場合は、パスワードの入力を求める Deployer ユーティリティのプロンプトが表示されます。
-password password
Oracle CEP 管理者のパスワード。

デプロイメント コマンド

次の表は、Deployer ユーティリティで使用できるデプロイメント コマンドを示しています。

表 3-3 デプロイメント コマンド
コマンド
説明
-install bundle
指定した Oracle CEP インスタンスに、指定した OSGi バンドルをインストールします。
bundle パラメータには、Deployer ユーティリティを実行するコンピュータのローカルなファイルの名前を指定します。
バンドルが置かれている場所が、Deployer ユーティリティを実行しているディレクトリに対して相対的なディレクトリではない場合、バンドルの絶対パス名を必ず指定してください。
特に、Oracle CEP では次の処理が行われます。
  • 指定したバンドルがドメイン ディレクトリにコピーされます。
  • バンドルの META-INF/wlevs ディレクトリでコンポーネント コンフィグレーション ファイルが検索され、ドメイン ディレクトリに抽出されます。
  • 内部デプロイメント レジストリが更新されます。
  • アプリケーションが開始されます。受信アダプタは直ちにデータを受信し始めます。
-update bundle
既存の OSGi バンドルを新しいアプリケーション コードで更新します。
bundle パラメータには、Deployer ユーティリティを実行するコンピュータのローカルなファイルの名前を指定します。
バンドルが置かれている場所が、Deployer ユーティリティを実行しているディレクトリに対して相対的なディレクトリではない場合、バンドルの絶対パス名を必ず指定してください。
特に、Oracle CEP では次の処理が行われます。
  • 更新したバンドルがドメイン ディレクトリにコピーされます。
  • 更新したバンドルの META-INF/wlevs ディレクトリで更新したコンポーネント コンフィグレーション ファイルが検索され、ドメイン ディレクトリに抽出されます。
  • 更新した情報で内部デプロイメント レジストリが更新されます。
-uninstall name
指定した Oracle CEP インスタンスから既存のバンドルを削除します。
name パラメータは、削除する OSGi バンドルのシンボリック名です。シンボリック名は、バンドルの MANIFEST.MF ファイルに含まれる Bundle-SymbolicName ヘッダの値です。
Bundle-SymbolicName: myApp
特に、Oracle CEP では次の処理が行われます。
  • 指定した OSGi バンドルがドメイン ディレクトリから削除されます。
  • 内部デプロイメント レジストリからバンドルが削除されます。
-suspend name
指定した Oracle CEP インスタンスにインストール済みで現在実行中の OSGI バンドルを中断します。
name パラメータは、開始する OSGi バンドルのシンボリック名です。シンボリック名は、バンドルの MANIFEST.MF ファイルに含まれる Bundle-SymbolicName ヘッダの値です。
Bundle-SymbolicName: myApp
-resume name
指定した Oracle CEP インスタンス上で中断された OSGI バンドルを再開します。コンフィグレーションされたアダプタが再び直ちに着信データを受信し始めます。
name パラメータは、停止する OSGi バンドルのシンボリック名です。シンボリック名は、バンドルの MANIFEST.MF ファイルに含まれる Bundle-SymbolicName ヘッダの値です。
Bundle-SymbolicName: myApp
-group groupname
デプロイ コマンド (install、uninstall、update、suspend、または resume) をターゲット グループ (具体的には、そのグループ内の一連の実行中サーバ) に適用することを指定します。
ドメイン グループを指定するには、次のようにキーワード all を使用します。
-group all
カスタム グループを指定するには、単純にグループの名前を指定します。
-group my_group
-status name
現在のインストール済み OSGi バンドルに関するステータス情報を返します。
name パラメータは、ステータス情報を取得する OSGi バンドルのシンボリック名です。シンボリック名は、バンドルの MANIFEST.MF ファイルに含まれる Bundle-SymbolicName ヘッダの値です。
Bundle-SymbolicName: myApp
-startLevel startLevel
OSGi バンドルが開始されたレベルを指定します。この数字の小さいバンドルが先に開始されたバンドルです。
システム バンドルの開始レベルは 7 未満です。

 

Deployer ユーティリティの使用例

以下の例は、Deployer ユーティリティの使い方を示しています。すべての例で、Oracle CEP はホスト ariel で実行されており、ポート 9002 をリスンしています。また、サーバ管理者のユーザ名/パスワードは wlevs/wlevs です。わかりやすくするために例は複数行に分けて示していますが、コマンドを実行するときは、すべての引数とコマンドを 1 行に入力してください。 

prompt> java -jar wlevsdeploy.jar 
        -url http://ariel:9002/wlevsdeployer -user wlevs -password wlevs
         -install /application/bundles/com.my.exampleApp_1.0.0.0.jar

上の例は、/application/bundles ディレクトリにある com.my.exampleApp_1.0.0.0.jar という OSGi バンドルをインストールする方法を示しています。

次のコマンドは、このアプリケーションを中断後に再開する方法を示しています。 

prompt> java com.bea.wlevs.deployment.Deployer 
        -url http://ariel:9002/wlevsdeployer -user wlevs -password wlevs
         -resume exampleApp

次の例は、このアプリケーションのアンインストール方法を示しています。アンインストールを実行すると、アプリケーションのすべてのトレース情報がドメイン ディレクトリから削除されます。 

prompt> java com.bea.wlevs.deployment.Deployer 
        -url http://ariel:9002/wlevsdeployer -user wlevs -password wlevs
         -uninstall exampleApp

次の例は、strategies_1.0.jar というアプリケーションを strategygroup にインストールする方法を示しています。また、java ユーティリティの -jar コマンドの使用方法も示しています。 

prompt> java -jar wlevsdeploy.jar 
        -url http://ariel:9002/wlevsdeployer -install strategies_1.0.jar 
         -group strategygroup

  ページの先頭       前  次