ヘッダーをスキップ

Oracle Containers for J2EE構成および管理ガイド
10g(10.1.3.1.0)

B31849-01
目次
目次
索引
索引

戻る 次へ

6 admin_client.jarユーティリティの使用方法

OC4Jにはadmin_client.jarというコマンドライン・ユーティリティが用意されています。このユーティリティを使用すると、Oracle Application Serverのクラスタ化された環境およびスタンドアロンOC4JサーバーのアクティブなOC4Jインスタンスで構成、管理およびデプロイ・タスクを実行できます。また、admin_client.jarを使用して、OC4Jインスタンスやインスタンスのグループを再起動または停止することも可能です。

admin_client.jarユーティリティは、リモートで操作を実行する管理クライアントの一部でもあり、Oracle Application Server 10gリリース3(10.1.3.1.0)のCompanion CDから、またはOracle Technology Networkからダウンロードして入手できます。

特定のOC4Jインスタンスで操作を実行することも、グループ内のすべてのOC4Jインスタンスで同時に操作を実行することも可能です。Oracle Application Server 10gリリース3(10.1.3.1.0)では、グループは同じクラスタ・トポロジ(2つ以上の粗結合のOracle Application Serverノード)に属するOC4Jインスタンスの同期セットです。admin_client.jarコマンドライン・ユーティリティを使用すると、OC4Jインスタンスまたはクラスタ内のインスタンスのグループで次の操作を実行できます。

Application Server ControlコンソールまたはOC4J Antタスクを使用して類似の操作を実行できます。詳細は、『Oracle Containers for J2EEデプロイメント・ガイド』に記載されている、Application Server Controlコンソールを使用したデプロイに関する項またはOC4J Antタスクを使用したデプロイに関する項を参照してください。

この章の内容は次のとおりです。

admin_client.jarの使用の準備

admin_client.jarユーティリティは、各OC4JインスタンスのORACLE_HOME/j2ee/instanceディレクトリにデフォルトでインストールされます。これは、OC4Jで操作を実行する際に推奨されるコマンドライン・ツールです。このユーティリティはリモートで操作を実行する管理クライアントの一部でもあり、Oracle Application Server 10gリリース3(10.1.3.1.0)のCompanion CDから、またはOracle Technology Networkからダウンロードして入手できます。

OC4Jインスタンスでこのユーティリティを使用して操作を実行するには、インスタンスを起動する必要があります。

この項の内容は次のとおりです。

admin_client.jarの構文およびURIの指定の概要

admin_client.jarユーティリティは、次の構文を使用します。

java -jar admin_client.jar uri adminId adminPassword command

コマンドラインで渡される主要なパラメータは、uriです。これは、指定された1つ以上のコマンドのターゲットを指定します。URIの構文は、ターゲットとなるインスタンスによって異なります。このURIの書式は、次の項を参照してください。

OC4J管理ユーザー名およびパスワードもユーティリティに渡されます。デフォルトの管理者アカウントのユーザー名はoc4jadminです。

たとえば、次のコマンドは、petstoreアプリケーションを起動します。このアプリケーションは、クラスタのメンバーであるnode1上のoc4j_2という名前のOC4Jインスタンスにインストールされています。

java -jar admin_client.jar deployer:oc4j:opmn://node1.company.com/oc4j_2
oc4jadmin password -application petstore -start

図6-1に、クラスタ内のOracle Application Serverインスタンスの1つであるOC4J_homeという名前のOC4Jインスタンスから実行するよう構成されている4つのプロセスを示します。

図6-1    クラスタ内のOracle Application Serverインスタンスにおいて複数のJVMで実行されるOC4Jインスタンス


画像の説明


注意

通常、homeという名前のOC4Jインスタンスは、複数プロセス・モデルでの実行には適さないApplication Server Controlアプリケーションのホストであるため、複数のプロセスで実行するように構成することはできません。 


クラスタ内のOC4Jインスタンスのグループでの操作の実行

次のURIを使用して、グループ内のすべてのOC4Jインスタンスをターゲットとして指定します。グループは、同じクラスタ・トポロジに属するOC4Jインスタンスの同期セットです。グループのすべてのOC4Jインスタンスで、構成、管理およびデプロイ操作を同時に実行できます。たとえば、Oracle Application Serverクラスタ内のoc4j_soaという名前のグループに属するすべてのOC4Jインスタンスを同時に停止できます。

URIはOPMNベースのクラスタリング・フレームワークを使用します。このフレームワークでは、クラスタ・ノード同士が相互に認識しています。クラスタ内の任意のOracle Application Serverノードに対するホスト名と必要に応じてOPMNリクエスト・ポートを指定するだけで、アプリケーションはクラスタ内のその他すべてのノードに対するホスト名およびOPMNポートを取得できます。

URIの構文は次のとおりです。

deployer:cluster:[rmis]:opmn://opmnHost[:opmnPort]/groupName

次に例を示します。

deployer:cluster:opmn://node1.company.com/oc4j_soa
表6-1    グループをターゲットとするためのURIパラメータ 
パラメータ  説明 

rmis 

任意。ターゲットがORMI over SSL(ORMIS)を使用する場合に指定します。 

opmnHost 

必須。クラスタ内のOracle Application Serverノードのホスト名。どのノードでも指定できます。クラスタ内の他のノードのリストはこのノードから取得されます。 

opmnPort 

任意。opmn.xmlに指定されているOPMNリクエスト・ポート。ポートを指定しない場合は、デフォルト・ポート6003が使用されます。 

groupName 

必須。クラスタ内で、OC4Jインスタンスが属するグループの名前。 

特定のOC4Jインスタンスでの操作の実行

次のURI構文を使用して、特定のOPMN管理のOC4Jインスタンス(クラスタ内のインスタンスなど)をターゲットとします。接頭辞では、clusteroc4jに置き換えられます。

インスタンスのホストとなるOracle Application Serverノードのホスト名を指定します。ノードのホスト名またはポートが不明な場合は、クラスタ内の別のノードのホスト名とOracle Application Serverインスタンスの名前を指定できます。アプリケーションは、OPMNクラスタリング・フレームワークを使用してOracle Application Serverインスタンスのホストとなるノードを探し出します。

URIの構文は次のとおりです。

deployer:oc4j:[rmis]:opmn://host[:opmnPort]/[iASInstanceName]/oc4jInstanceName

次に例を示します。

deployer:oc4j:opmn://server.company.com:6004/instance2/home
表6-2    特定のインスタンスをターゲットとするためのURIパラメータ 
パラメータ  説明 

rmis 

任意。ターゲットがORMI over SSL(ORMIS)を使用する場合に指定します。 

host 

必須。OPMNサーバーとして使用するための、クラスタ内でターゲットとなるOracle Application Serverノードのホスト名。 

opmnPort 

任意。opmn.xmlに指定されているOPMNリクエスト・ポート。ポートを指定しない場合は、デフォルト・ポート6003が使用されます。 

iASInstanceName 

任意。hostに指定されたノード上に存在しない場合の、ターゲットとなるOracle Application Serverインスタンスの名前。 

oc4jInstanceName 

必須。ターゲットOC4Jインスタンスの名前。 

スタンドアロンOC4Jサーバーでの操作の実行

次のURIのいずれかを使用して、スタンドアロンOC4Jサーバー・インスタンスをターゲットとします。

RMIを使用する場合は、次のようにしてURIを指定します。

deployer:oc4j:host:rmiPort

ORMI over SSL(ORMIS)を使用する場合は、次のようにしてURIを指定します。

deployer:oc4j:rmis:host:ormisPort

次に例を示します。

deployer:oc4j:myserver:23791
deployer:oc4j:rmis:myserver:23943
表6-3    スタンドアロンOC4JをターゲットとするためのURIパラメータ 
パラメータ  説明 

rmis 

ターゲットがORMI over SSL(ORMIS)を使用する場合は必須です。 

host 

必須。クラスタ内のOracle Application Serverノードのホスト名。どのノードでも指定できます。クラスタ内の他のノードのリストはこのノードから取得されます。 

rmiPort 

RMIが使用される場合は必須です。インスタンス固有のrmi.xmlファイルに指定されているRMIポートです。 

ormisPort 

ORMISが使用される場合は必須です。インスタンス固有のrmi.xmlファイルに指定されているSSLポートです。 

URIの検証

URIは、-validateURIコマンドを使用して検証できます。

java -jar admin_client.jar uri adminId adminPassword -validateURI

次に例を示します。

java -jar admin_client.jar deployer:cluster:opmn://node1.company.com/default_group 
oc4jadmin password -validateURI

リモート管理クライアントのダウンロードおよび抽出

管理クライアントのディストリビューションには、admin_client.jarコマンドライン・ユーティリティが含まれています。このユーティリティはOC4JまたはOracle Application Serverターゲットに接続し、一連のライフサイクル、デプロイおよびリソース構成の操作を実行できます。

リモート・システムでOracle Application Serverインスタンスに対して通常の操作を実行する必要があるとします。たとえばリモート・システムに、デプロイ操作、またはアプリケーション固有またはサーバーのJMX MBeansの管理目的での問合せや操作など、自動化された作成またはテスト・プロセスが複数あるとします。または、リモート・システムで、構成およびデプロイ操作の本番セットに対して定期的にスケジュールされたテストを実行するとします。管理クライアント・ディストリビューションを使用してこれを実行すれば、リモート・システムに完全なOC4JまたはOracle Application Serverインストールを用意する必要がなくなります。

Oracle Application Server 10gリリース3(10.1.3.x)の別のディストリビューションである管理クライアントは、Oracle Technology Networkからダウンロードできます。また、Oracle Application ServerのCompanion CDにも含まれています。oc4j_admin_client_101310.zipファイルには、OC4Jインスタンスのリモートからの管理に必要なものがすべて含まれています。

管理クライアント・ディストリビューションを開始するには、次のようにします。

  1. Oracle Technology Networkからoc4j_admin_client_101310.zipをダウンロードします。

    http://download.oracle.com/otn/java/oc4j/10131/oc4j_admin_client_101310.zip
    
  2. oc4j_admin_client_101310.zipのコンテンツをローカル・ディレクトリに解凍します。次に例を示します。

     >mkdir oc4j_admin_client
     >cd oc4j_admin_client
     >jar xvf d:¥software¥oc4j_admin_client_101310.zip
    

    その結果、ディレクトリ構造は次のようになります。

    ¥j2ee
       ¥home
          oc4jclient.jar
          admin_client.jar
          ¥lib
             ejb.jar
             mail.jar
             adminclient.jar
             javax88.jar
             javax77.jar
             jmx_remote_api.jar
             jmxri.jar
    ¥lib
       xmlparserv2.jar
       dms.jar 
    ¥opmn
       ¥lib
       optic.jar
    ¥jlib
       oraclepki.jar
       ojpse.jar
    

    次のURIでは、個々のOC4Jターゲットに異なるパターンが使用されます。

    • スタンドアロンOC4Jサーバー:

      deployer:oc4j:test-cycle.oracle.com:23791
      
    • Oracle Application Serverの特定のOC4Jインスタンス:

      deployer:oc4j:opmn://test-cycle.oracle.com/testunit 
      
    • クラスタ内のOC4Jインスタンスのグループ:

      deployer:cluster:opmn://test-cycle.oracle.com/[groupName] 
      
  3. admin_client.jarを1つ以上のターゲットOC4Jインスタンスに接続し、接続をテストします。次に例を示します。

    >cd j2ee¥home
    >java -jar admin_client.jar
      deployer:oc4j:opmn://test-cycle.oracle.com/testunit 
        oc4jadmin welcome1 
      -validateURI
    
    URI deployer:oc4j:opmn://test-cycle.oracle.com/testunit is valid and connected
    

コンソールへの使用方法の出力

admin_client.jarコマンドのオンライン・ヘルプ・テキストをコンソールに出力するには、-helpとコマンドラインに入力するだけです。次に例を示します。

java -jar admin_client.jar -help

特定のコマンドの詳細なヘルプを表示するには、-usageの後に続けてコマンド識別子を入力します。次に例を示します。

java -jar admin_client.jar -usage [command]

ロギングの有効化

admin_client.jarの実行中に発生するエラーのトラブルシューティングを支援するために、このツールを実行する際にJavaロギングを有効にできます。ログ・メッセージはコンソールに出力されます。

ロギングを有効にするには、次のようにします。

  1. 次の1行を記述したlogging.propertiesファイルを作成します。

    oracle.oc4j.admin.jmx.client.CoreRemoteMBeanServer.level=INFO
    

    このファイルをORACLE_HOME/j2ee/instance以外の場所に作成する場合は、後述のコマンドでファイルへのパスを指定する必要があります。

  2. 次のように-Djava.util.logging.config.file=logging.propertiesadmin_client.jarコマンドラインに設定します。

    java -Djava.util.logging.config.file=logging.properties -jar admin_client.jar uri 
    adminId adminPassword command
    

logging.propertiesファイルの値には、表6-4のJavaログ・レベル値のいずれかを設定できます。

表6-4    Javaログ・レベル 
Javaログ・レベル  説明 
SEVERE
 

システム管理者が注意する必要があるシステム・エラーを記録します。 

WARNING
 

エラーが発生する前に確認して処理する必要があるとして検出されたアクションまたは条件を記録します。 

INFO
 

標準のアクションまたはイベントを記録します。ユーザー操作(「ログイン完了」など)や自動操作(ログイン・ファイルの循環など)が該当します。 

CONFIG
 

ログ構成に関連するメッセージまたは問題。 

FINE
 

デバッグやパフォーマンスの監視に使用されるトレースまたはデバッグのメッセージを記録します。通常、詳細なイベント・データが含まれます。  

FINER
 

非常に詳細なトレースまたはデバッグのメッセージを記録します。 

FINEST
 

きわめて詳細なトレースまたはデバッグのメッセージを記録します。 

次に例を示します。

oracle.oc4j.admin.jmx.client.CoreRemoteMBeanServer.level=FINE

アーカイブのデプロイ

admin_client.jarユーティリティを使用すると、アプリケーション(EAR)、スタンドアロンWebモジュール(WAR)またはスタンドアロン・リソース・アダプタ(RAR)を特定のOC4Jインスタンスまたはクラスタ内のインスタンスのグループにデプロイできます。

この項の内容は次のとおりです。

J2EEアプリケーション(EAR)のデプロイ

-deployコマンドを使用して、EARファイルとしてパッケージされたJ2EEアプリケーションをデプロイまたは再デプロイします。EAR固有の構文は次のとおりです。

java -jar admin_client.jar uri adminId adminPassword -deploy -file path/filename 
-deploymentName appName [-bindAllWebApps [webSiteName]] [-targetPath path] 
[-parent appName] [-deploymentDirectory path] [-enableIIOP] 
[-iiopClientJar path/filename] [-deploymentPlan path/filename] [-removeArchive]

-bindAllWebAppsサブスイッチを指定して、EAR内のすべてのWebモジュールをそのアクセスに使用されるWebサイトにバインドすることをお薦めします。Webサイトを指定しない場合、モジュールはデフォルトWebサイトにバインドされます。

たとえば、次のコマンドは、クラスタ内のグループdefault_groupに属するすべてのOC4Jインスタンスに、utilityアプリケーションをデプロイします。アプリケーション内のすべてのWebモジュールは、デフォルトWebサイトにバインドされます。

java -jar admin_client.jar deployer:cluster:opmn://node1.company.com/default_group 
oc4jadmin password -deploy -file C:/dev/utility.ear -deploymentName utility
-bindAllWebApps
表6-5    EARデプロイの-deployコマンドのサブスイッチ 
サブスイッチ  説明 

-file 

必須。デプロイするEARファイルのパスおよびファイル名。 

-deploymentName 

必須。ユーザー定義のアプリケーションのデプロイ名。OC4J内でアプリケーションを識別する際に使用されます。  

-bindAllWebApps 

任意。すべてのWebモジュールを指定されたWebサイトにバインドします。何も指定されない場合は、デフォルトWebサイトにバインドします。指定しない場合は、「単一のWebサイトへの全Webモジュールのバインド」で説明している-bindAllWebAppsコマンドを使用する必要があります。

必要に応じて、webSiteNameの値を指定できます。この値は、Webサイトを構成するname_web-site.xmlファイルのname部分です。 

-targetPath 

任意。EARのデプロイ先となるディレクトリ。指定しない場合、EARはORACLE_HOME/j2ee/instance/applicationsディレクトリにデフォルトでデプロイされます。

また、デプロイ済EARファイルもこのディレクトリにコピーされます。後続のデプロイのたびに、このEARファイルは上書きされます。  

-parent 

任意。このアプリケーションの親アプリケーション。デフォルトは、defaultアプリケーションまたはグローバルWebアプリケーションです。  

-deploymentPlan 

任意。アプリケーションに適用するデプロイ・プランのパスおよびファイル名。プランは、前回のデプロイ時にXMLファイルとして保存されています。ファイルは、ローカル・ホスト上に存在する必要があります。 

-deploymentDirectory 

任意。OC4J固有のデプロイメント・ディスクリプタおよび生成済ファイル(コンパイル済JSPクラスやEJBラッパー・クラスなど)が格納されるディレクトリ。

デフォルトのディレクトリは、ORACLE_HOME/j2ee/instance/applicationsです。  

-sequential 

任意。クラスタ内の各OC4Jインスタンスに順々にアーカイブをデプロイする場合に指定します。リクエストは、EARをデプロイ中のインスタンスにはルーティングされません。

指定しない場合、アーカイブはデフォルトで同時にすべてのインスタンスにデプロイされます。

このオプションは、クラスタ化された環境でのみ有効です。スタンドアロンOC4Jでは無効です。  

-enableIIOP 

任意。OC4JサーバーでIIOPクライアント・スタブを生成する場合に指定します。

すべてのEJBモジュールに対して生成されるアプリケーション・レベルのスタブは、ORACLE_HOME/j2ee/instance/application-deployments/appNameディレクトリの_iiopClient.jarというアーカイブに出力されます。また、各EJBモジュールに対するスタブは、ORACLE_HOME/j2ee/instance/application-deployments/appName/ejbModuleNameディレクトリに同じ名前のアーカイブで生成されます。

この機能を使用するには、OC4Jの起動時にGenerateIIOPシステム・プロパティを有効にする必要があります。このプロパティは、OC4JスタンドアロンのOC4Jコマンドラインでは-DGenerateIIOP=trueopmn.xmlではoc4j-options値として設定されます。 

-iiopClientJar 

任意。IIOPクライアント・スタブの出力先となるJARのパスおよびファイル名。

すべてのEJBモジュールに対して生成されるアプリケーション・レベルのスタブは、ORACLE_HOME/j2ee/instance/application-deployments/appNameディレクトリの_iiopClient.jarというアーカイブに出力されます。パスを指定する場合、アーカイブはそのパスにも設定されます。

また、各EJBモジュールに対するスタブは、ORACLE_HOME/j2ee/instance/application-deployments/appName/ejbModuleNameディレクトリに同じ名前のアーカイブで生成されます。

この機能を使用するには、OC4Jの起動時にGenerateIIOPシステム・プロパティを有効にする必要があります。このプロパティは、OC4JスタンドアロンのOC4Jコマンドラインでは-DGenerateIIOP=trueopmn.xmlではoc4j-options値として設定されます。 

-removeArchive 

任意。デプロイ後にサーバーのファイル・システムから削除するEARファイルを指定します。 

リモート・クライアントからのJ2EEアプリケーションのデプロイ

次の例では、リモート・クライアントからOracle Application Serverの特定のOC4JインスタンスにEARをデプロイする方法を示します。

cd j2ee/home
>java -jar admin_client.jar 
 deployer:oc4j:opmn://test-cycle.oracle.com/testunit
 oc4jadmin welcome1 
 -deploy 
 -file d:¥temp¥rupg¥testru.ear 
 -deploymentName testru -bindAllWebApps

06/06/20 17:00:16 Notification ==>Uploading file testru.ear ...
06/06/20 17:00:18 Notification ==>Application Deployer for testru STARTS.
06/06/20 17:00:19 Notification ==>Copy the archive to 
/scratch/sbutton/m1_060618/j2ee/admin/applications/testru.ear
06/06/20 17:00:19 Notification ==>Initialize 
/scratch/sbutton/m1_060618/j2ee/admin/applications/testru.ear begins...
06/06/20 17:00:19 Notification ==>Unpacking testru.ear
06/06/20 17:00:20 Notification ==>Done unpacking testru.ear
06/06/20 17:00:20 Notification ==>Unpacking testru-web.war
06/06/20 17:00:20 Notification ==>Done unpacking testru-web.war
06/06/20 17:00:20 Notification ==>Initialize 
/scratch/sbutton/m1_060618/j2ee/admin/applications/testru.ear ends...
06/06/20 17:00:20 Notification ==>Starting application : testru
06/06/20 17:00:20 Notification ==>Initializing ClassLoader(s)
06/06/20 17:00:20 Notification ==>Initializing EJB container
06/06/20 17:00:20 Notification ==>Loading connector(s)
06/06/20 17:00:20 Notification ==>Starting up resource adapters
06/06/20 17:00:20 Notification ==>Initializing EJB sessions
06/06/20 17:00:20 Notification ==>Committing ClassLoader(s)
06/06/20 17:00:20 Notification ==>Initialize testru-web begins...
06/06/20 17:00:20 Notification ==>Initialize testru-web ends...
06/06/20 17:00:21 Notification ==>Started application : testru
06/06/20 17:00:21 Notification ==>Binding web application(s) to site default-web-site 
begins...
06/06/20 17:00:21 Notification ==>Binding testru-web web-module for application testru 
to site default-web-site under context root /testru
06/06/20 17:00:22 Notification ==>Binding web application(s) to site default-web-site 
ends...
06/06/20 17:00:22 Notification ==>Application Deployer for testru COMPLETES. Operation 
time: 3785 msecs

スタンドアロンWebモジュール(WAR)のデプロイ

-deployコマンドを使用して、WARファイルとしてパッケージされたスタンドアロンWebモジュールをデプロイまたは再デプロイします。

WAR固有の構文は次のとおりです。

java -jar admin_client.jar uri adminId adminPassword -deploy -file
path/filename -deploymentName appName [-bindAllWebApps [webSiteName]]
[-targetPath path] [-parent appName] [-deploymentDirectory path]
[-contextRoot context]
[-removeArchive]

WARは、まだWebモジュール・コンポーネントがない別のデプロイ済アプリケーションの子として指定できます。指定しない場合は、defaultアプリケーションにデプロイされます。

WARは、すでにWebモジュールが存在するアプリケーションの子としてはデプロイできません。つまり、acmeアプリケーションにすでにacme-web.warがある場合、そのアプリケーションには追加のWARファイルをデプロイできません。かわりに、アプリケーションのEARファイルにWARを再パッケージし、そのアプリケーションを再デプロイします。

次のコマンドは、node1がメンバーであるクラスタ内のdefault_groupに属するすべてのOC4Jインスタンスのdefaultアプリケーションに、スタンドアロンacme-web.war Webモジュールをデプロイします。-bindAllWebAppsサブスイッチが指定されていますが、バインド先のWebサイトが指定されていないため、モジュールはデフォルトWebサイトにバインドされます。

java -jar admin_client.jar deployer:cluster:opmn://node1.company.com/default_group 
oc4jadmin password -deploy -file C:/dev/acme-web.war -deploymentName utility 
-bindAllWebApps -parent default
表6-6    WARデプロイの-deployコマンドのサブスイッチ 
サブスイッチ  説明 

-file 

必須。デプロイするアーカイブのパスおよびファイル名。 

-deploymentName 

必須。ユーザー定義のWebモジュール名。OC4J内でWebモジュールを識別する際に使用されます。  

-bindAllWebApps 

任意。すべてのWebモジュールを指定されたWebサイトにバインドします。何も指定されない場合は、デフォルトWebサイトにバインドします。

必要に応じて、webSiteNameの値を指定できます。この値は、Webサイトを構成するname_web-site.xmlファイルのname部分です。 

-targetPath 

任意。アーカイブのデプロイ先となるディレクトリ。指定しない場合、アーカイブはORACLE_HOME/j2ee/instance/applications/ディレクトリにデフォルトでデプロイされます。

また、スタンドアロンWARファイルが含まれる生成済EARファイルもこのディレクトリにコピーされます。後続のデプロイのたびに、このアーカイブは上書きされます。  

-parent 

任意。モジュールのデプロイ先となる親アプリケーション。デフォルトはdefaultアプリケーションです。  

-deploymentDirectory 

任意。OC4J固有のデプロイメント・ディスクリプタおよび生成済ファイル(コンパイル済JSPクラスなど)が格納されるディレクトリ。

デフォルトのディレクトリは、ORACLE_HOME/j2ee/instance/application-deploymentsです。  

-contextRoot 

任意。Webモジュール・コンテキスト。Webブラウザを介してアプリケーションにアクセスするために使用されるURLの最後に追加されます。指定しない場合は、-deploymentNameに渡される値が使用されます。

たとえば、コンテキスト・ルートとして/petstoreを指定すると、モジュールには次のURLからアクセスできます。

http://node1.company.com:7777/petstore 

-removeArchive 

任意。デプロイ後にサーバーのファイル・システムから削除するWARファイルを指定します。 

スタンドアロン・リソース・アダプタ(RAR)のデプロイ

-deployコマンドを使用して、RARファイルとしてパッケージされたJavaコネクタ・アーキテクチャに準拠するリソース・アダプタをデプロイまたは再デプロイします。デフォルトでは、リソース・アダプタはORACLE_HOME/j2ee/instance/connectorsディレクトリにデプロイされます。

スタンドアロンRARの再デプロイまたはアンデプロイでは、defaultアプリケーションを再起動する必要はありません。

RAR固有の構文は次のとおりです。

java -jar admin_client.jar uri adminId adminPassword -deploy -file path/filename 
-deploymentName connectorName [-nativePathLib path] [-grantAllPermissions]
[-removeArchive]

次のコマンドは、クラスタ内のdefault_groupに属するすべてのOC4Jインスタンスにacme-rar.rarモジュールをデプロイします。

java -jar admin_client.jar deployer:cluster:opmn://node1.company.com/default_group 
oc4jadmin password -deploy -file /dev/acme-rar.rar -deploymentName acme-rar 
-grantAllPermissions -removeArchive
表6-7    RARデプロイの-deployコマンドのサブスイッチ 
サブスイッチ  説明 

-file 

必須。デプロイするRARファイルのパスおよびファイル名。 

-deploymentName 

必須。ユーザー定義のコネクタ名。OC4J内でコネクタを識別する際に使用されます。  

-nativeLibPath 

任意。RARファイル内の、ネイティブ・ライブラリ(DLLなど)を格納するディレクトリへのパス。  

-grantAllPermissions 

任意。必要に応じて、リソース・アダプタによってリクエストされるすべてのランタイム権限を付与する場合に指定します。 

-removeArchive 

任意。デプロイ後にサーバーのファイル・システムから削除するRARファイルを指定します。 

詳細は、『Oracle Containers for J2EEデプロイメント・ガイド』の「リソース・アダプタのデプロイ」を参照してください。

バッチ・デプロイでのスクリプト・ファイルの使用

admin_client.jarコマンドラインのデプロイ・コマンドを含むスクリプト・ファイルを指定できます。-scriptコマンドでファイルを指定すると、admin_client.jarによりデプロイメント・マネージャへの1つの接続のみでコマンドのリストを実行できます。バッチ・デプロイの構文は次のとおりです。

java -jar admin_client.jar uri adminId adminPassword
-script filename

スクリプト・ファイルfilenameには、この例のように複数の行が含まれます。

-deploy -file /scratch/rpan/apps/hello-planet.ear -deploymentName hello-planet
-bindWebApp -appName hello-planet -webModuleName hello-planet-web
-stop hello-planet
-start hello-planet
-redeploy -file /scratch/rpan/apps/hello-planet.ear
-deploymentName hello-planet -bindAllWebApps
-undeploy hello-planet
-validateURI

インストールのスクリプトまたはログを参照し、既存のコンフィギュレーション・アシスタントによって使用される関連行を抽出することで、バッチ・モードに変換できます。

デプロイ後のWebサイトへのWebモジュールのバインド

OC4Jにデプロイされた各Webモジュールは、そのアクセスに使用されるWebサイトにバインドする必要があります。

通常、EAR内のWARファイルとしてパッケージされたWebモジュールは、-deployコマンドで-bindAllWebAppsサブスイッチを使用して、EARのデプロイ時にバインドします。しかし、EARのデプロイ時に-bindAllWebAppsサブスイッチを指定しなかった場合は、次の各項で説明するように、デプロイ後にモジュールをWebサイトにバインドできます。

単一のWebサイトへの全Webモジュールのバインド

-bindAllWebAppsコマンドを使用して、J2EEアプリケーション内のすべてのWebモジュールを同じWebサイトにバインドするか、デフォルトでdefault-web-siteにバインドします。このコマンドの構文は次のとおりです。

java -jar admin_client.jar uri adminId adminPassword -bindAllWebApps
-appName appName -webSiteName siteName
表6-8    -bindAllWebAppsコマンドのサブスイッチ 
サブスイッチ  説明 

-appName 

必須。デプロイ時に指定された親アプリケーションの名前。 

-webSiteName 

任意。Webモジュールのバインド先となるWebサイトを示すname_web-site.xmlファイルの名前。省略すると、すべてのモジュールがdefault-web-siteにバインドされます。 

特定のWebサイトへの特定のWebモジュールのバインドおよびコンテキスト・ルートの設定

-bindWebAppコマンドを使用して、J2EEアプリケーション内の単一のWebモジュールを特定のWebサイトにバインドするか、デフォルトでdefault-web-siteにバインドします。また、必要に応じて、モジュールへのアクセスに使用されるコンテキスト・ルートを設定することもできます。

構文は次のとおりです。

java -jar admin_client.jar uri adminId adminPassword -bindWebApp
-appName appName -webModuleName moduleName -webSiteName siteName
-contextRoot contextRoot
表6-9    -bindWebAppコマンドのサブスイッチ 
サブスイッチ  説明 

-appName 

必須。デプロイ時に指定された親アプリケーションの名前。 

-webModuleName 

必須。バインドするWebモジュールの名前。この値は、EARファイル内に含まれるWARファイルの名前(.WAR拡張子を除く)である必要があります。 

-webSiteName 

任意。Webモジュールのバインド先となるWebサイトを示すname_web-site.xmlファイルの名前。省略すると、すべてのモジュールがdefault-web-siteにバインドされます。 

-contextRoot 

任意。Webモジュールのコンテキスト・ルート。この値は、Webブラウザを介してアプリケーションにアクセスするために使用されるURLの最後に追加されます。次に例を示します。

http://localhost:8888/petstore

指定しない場合は、親アプリケーションのapplication.xmlデプロイメント・ディスクリプタに指定されるコンテキスト・ルートが使用されます。 

アーカイブの再デプロイ

-redeployコマンドを使用して、すでにデプロイされたアーカイブを再デプロイできます。

この操作は、アプリケーションが稼働中の場合はそのアプリケーションを停止した後にアーカイブをアンデプロイして、正常な再デプロイを実行します。その後、アプリケーションのデプロイおよび再起動を実行します。一方、-deployコマンドによるアーカイブの再デプロイは、アプリケーションを停止せず、単にアンデプロイおよび再デプロイした後に再起動します。

構文は次のとおりです。

java -jar admin_client.jar uri adminId adminPassword -redeploy -file path/filename 
-deploymentName appName [-keepSettings] [-sequential] -removeArchive
表6-10    -redeployコマンドのサブスイッチ 
サブスイッチ  説明 

-file 

必須。デプロイするEARファイルのパスおよびファイル名。 

-deploymentName 

必須。ユーザー定義のアプリケーションのデプロイ名。OC4J内でアプリケーションを識別する際に使用されます。この値は、サーバーの既存アプリケーションの名前と完全一致する必要があります。 

-keepSettings 

任意。指定する場合、再デプロイされるアプリケーションは、前回のデプロイからデプロイ・プランを取得して使用します。アーカイブにパッケージされたデプロイメント・ディスクリプタに設定される値は、無視されます。

指定しない場合、アーカイブにパッケージされたデプロイメント・ディスクリプタの値に設定されます。 

-sequential 

任意。クラスタ内の各OC4Jインスタンスに順々にアーカイブをデプロイする場合に指定します。各ターゲットでの再デプロイは、次のターゲットに進む前に完了する必要があります。リクエストは、EARをデプロイ中のインスタンスにはルーティングされません。

指定しない場合、アーカイブはデフォルトで同時にすべてのインスタンスにデプロイされます。

このオプションは、クラスタ化された環境でのみ有効です。スタンドアロンOC4Jでは無効です。  

-removeArchive 

任意。デプロイ後にサーバーのファイル・システムから削除するEARファイルを指定します。 

アーカイブのアンデプロイ

-undeployコマンドは、次の各項で説明するように、アプリケーションまたはスタンドアロンWebモジュール、スタンドアロン・コネクタ・モジュールをターゲットOC4Jインスタンスから削除します。

EARまたはスタンドアロンWARのアンデプロイ

EARまたはスタンドアロンWebモジュールをアンデプロイすると、OC4Jランタイムから削除されます。既存のWebサイトのバインディングも同様に削除されます。

EARまたはスタンドアロンWARのアンデプロイの構文は次のとおりです。アプリケーションまたはモジュールの名前を指定する必要があります。

java -jar admin_client.jar uri adminId adminPassword -undeploy appName

スタンドアロンRARのアンデプロイ

スタンドアロンRARのアンデプロイの構文は次のとおりです。-isConnectorサブスイッチをコネクタ名とともに指定する必要があります。

java -jar admin_client.jar uri adminId adminPassword -undeploy connectorName 
-isConnector

スタンドアロンRARのアンデプロイでは、defaultアプリケーションを再起動する必要はありません。

デプロイ済EJBモジュールの変更されたクラスの更新

-updateEJBModuleコマンドは、OC4Jインスタンスまたはクラスタ内のインスタンスのグループで稼働中のアプリケーションにおいて、EJBモジュールの増分的または部分的な再デプロイを実行します。この機能により、モジュール全体の再デプロイを必要とせずに、EJB JAR内の変更されたBeanのみを再デプロイできます。


注意

増分的な再デプロイは、CMPまたはBMPエンティティBeanにアプリケーション全体を再デプロイするよりも効率的ですが、セッションBean、メッセージドリブンBeanまたはEJB 3.0 JPAエンティティでは当てはまりません。この機能の使用に関する詳細は、『Oracle Containers for J2EEデプロイメント・ガイド』の「更新されたEJBモジュールの増分再デプロイ」を参照してください。 


デプロイ済のEJBモジュールで変更されたクラスを更新する構文は、次のとおりです。EJB JARが構成するアプリケーションの名前を指定する必要があります。スタンドアロンEJBモジュールを更新する場合は、defaultアプリケーションを指定します。

java -jar admin_client.jar uri adminId adminPassword -updateEJBModule
-appName appName -ejbModuleName ejbJarName -file path/ejbJarName

次に例を示します。

java -jar admin_client.jar deployer:cluster:opmn://node1.company.com/default_group 
oc4jadmin password -updateEJBModule -appName petstore 
-ejbModuleName customerEjb.jar -file build/customerEjb.jar
表6-11    -updateEJBModuleの構文 
オプション  説明 

-appName 

必須。EJBが構成するアプリケーションの名前。スタンドアロンEJBモジュールを更新する場合は、defaultアプリケーションを指定します。 

-ejbModuleName 

必須。application.xmlに定義されている、更新対象のEJB JARファイルの名前。  

-file 

必須。更新されたEJB JARのパスおよびファイル名。 

共有ライブラリの作成および管理

admin_client.jarユーティリティを使用すると、次の項で説明するように、OC4Jインスタンスまたはクラスタ内のインスタンスのグループで共有ライブラリの作成および管理を実行できます。

共有ライブラリのインストール

-publishSharedLibraryコマンドを使用すると、特定のOC4Jインスタンスまたはクラスタ内のインスタンスのグループに共有ライブラリのディレクトリ構造を作成し、ライブラリを構成するバイナリをその中にインストールできます。共有ライブラリは、各OC4JインスタンスのORACLE_HOME/j2ee/instance/shared-libディレクトリに作成されます。

また、このコマンドは、各OC4Jインスタンスのserver.xmlファイルの<shared-library>要素内に共有ライブラリを宣言し、アプリケーションで使用できるようにします。

共有ライブラリのインストールの構文は次のとおりです。複数のコード・ソース(共有ライブラリを構成するバイナリ)のパスおよびファイル名は、それぞれを空白で区切って指定できます。

java -jar admin_client.jar uri adminId adminPassword -publishSharedLibrary
-name libName -version libVersion [-parentName parentLibName] 
[-parentVersion parentLibVersion] [-installCodeSources path [path ...]]
[-addCodeSources path [path ...]] [-imports sharedLibName
[:min-version][,max-version] [sharedLibName ...]]

次のコマンドは、クラスタ内のOC4Jインスタンス(default_groupのすべてのメンバー)のグループにacme.common:2.5共有ライブラリをデプロイします。

java -jar admin_client.jar 
deployer:cluster:opmn://server.company.com:6004/default_group
oc4jadmin password -publishSharedLibrary -name acme.common -version 2.5 
-installCodeSources /myserver/tmp/acme-apis.jar /myserver/tmp/acmeImpl.jar

ターゲットOC4Jサーバー内の結果のディレクトリ構造は、次のとおりです。

ORACLE_HOME/j2ee/home/shared-lib
  /acme.common
    /2.5
      acme-apis.jar
      acmeImpl.jar
表6-12    -publishSharedLibraryコマンドのサブスイッチ 
サブスイッチ  説明 

-name 

必須。共有ライブラリの名前。

共通APIが複数のベンダーによって実装される場合は、oracle.jdbcxerces.xmlなどのように、名前にベンダー名とテクノロジ名の両方を含めることをお薦めします。 

-version 

必須。共有ライブラリのバージョン番号。この値はコードの実装バージョンを反映することをお薦めします。 

-parentName 

任意。該当する場合は、親共有ライブラリの名前。 

-parentVersion 

任意。該当する場合は、親共有ライブラリのバージョン番号。 

-installCodeSources 

OC4Jインスタンスにアップロードし、共有ライブラリの一部としてインストールする1つ以上のJARまたはZIPファイルのパスおよびファイル名。パスまたはファイル名の各文字列は、空白で区切ります。 

-addCodeSources 

任意。共有ライブラリに追加するためにすでに1つ以上のOC4JインスタンスにアップロードされているJARまたはZIPファイルのパスおよびファイル名。パスまたはファイル名の各文字列は、空白で区切ります。 

-imports 

任意。この共有ライブラリにインポートする1つ以上の既存の共有ライブラリの名前。各名前の文字列は空白で区切ります。

インポートするライブラリの最高または最低、あるいはその両方のバージョンを指定できます。 

既存の共有ライブラリの変更

-modifySharedLibraryコマンドを使用すると、既存の共有ライブラリの内容を変更できます。また、このコマンドは、各OC4Jインスタンスのserver.xmlファイル内にある共有ライブラリ定義を更新します。

既存の共有ライブラリを変更する構文は次のとおりです。複数のコード・ソース(共有ライブラリを構成するバイナリ)のパスおよびファイル名は、それぞれを空白で区切って指定できます。

java -jar admin_client.jar uri adminId adminPassword -modifySharedLibrary
-name libName -version libVersion [-installCodeSources path [path ...]]
[-addCodeSources path [path ...]] [-removeCodeSources path [path ...]]
[-addImports sharedLibName[:min-version][,max-version] [sharedLibName ...]] 
[-removeImports sharedLibName[:min-version][,max-version] [sharedLibName ...]]

次のコマンドは、acme.common:2.5共有ライブラリを更新します。

java -jar admin_client.jar
deployer:cluster:opmn://server.company.com:6004/default_group
oc4jadmin password -modifySharedLibrary -name acme.common -version 2.5 
-addCodeSources /myserver/tmp/acme-helpers.jar
表6-13    -modifySharedLibraryコマンドのサブスイッチ 
サブスイッチ  説明 

-name 

必須。更新する共有ライブラリの名前。 

-version 

必須。更新する共有ライブラリのバージョン番号。  

-installCodeSources 

任意。1つ以上のOC4Jインスタンスにアップロードし、共有ライブラリの一部としてインストールするJARまたはZIPファイルのパスおよびファイル名。パスまたはファイル名の各文字列は、空白で区切ります。 

-addCodeSources 

任意。共有ライブラリに追加するためにすでにOC4Jインスタンスにアップロードされている1つ以上のJARまたはZIPファイルのパスおよびファイル名。パスまたはファイル名の各文字列は、空白で区切ります。 

-removeCodeSources 

任意。共有ライブラリから削除するJARまたはZIPファイルのパスおよびファイル名。  

-addImports 

任意。この共有ライブラリにインポートする1つ以上の既存の共有ライブラリの名前。各名前の文字列は空白で区切ります。

インポートするライブラリの最高または最低、あるいはその両方のバージョンを指定できます。 

-removeImports 

任意。この共有ライブラリから削除する1つ以上の既存の共有ライブラリの名前。

削除するライブラリの最高または最低、あるいはその両方のバージョンを指定できます。 

共有ライブラリの内容の表示

-describeSharedLibraryコマンドを使用して、指定された共有ライブラリを構成するコード・ソースとインポート済共有ライブラリを表示します。構文は次のとおりです。

java -jar admin_client.jar uri adminId adminPassword -describeSharedLibrary
-name libName -version libVersion
表6-14    -describeSharedLibraryコマンドのサブスイッチ 
サブスイッチ  説明 

-name 

必須。共有ライブラリの名前。 

-version 

必須。共有ライブラリのバージョン番号。  

すべての共有ライブラリのリスト出力

-listSharedLibrariesコマンドを使用して、1つ以上のターゲットOC4Jインスタンスに定義されているすべての共有ライブラリのリストを出力します。構文は次のとおりです。

java -jar admin_client.jar uri adminId adminPassword -listSharedLibraries


注意

JDK1.4を使用している場合、Oracle Application Server 10gリリース3(10.1.3.1.0)ではJDKに同梱されているXalanライブラリを共有ライブラリとして使用することはできません。Xalanライブラリを使用するには、次の2つの方法があります。

  • 同梱されているXalanライブラリが共有ライブラリとしてサポートされているJDK 1.5(JDK 5)を使用します。

  • JDK1.4の場合は、同梱されているバージョンではなく、Xalanライブラリのスタンドアロン・ディストリビューションを使用します。

 

共有ライブラリの削除

-removeSharedLibraryコマンドを使用して、1つ以上のターゲットOC4Jインスタンスから共有ライブラリを削除します。構文は次のとおりです。

java -jar admin_client.jar uri adminId adminPassword -removeSharedLibrary
-name libName -version libVersion
表6-15    -removeSharedLibraryコマンドのサブスイッチ 
サブスイッチ  説明 

-name 

必須。削除する共有ライブラリの名前。 

-version 

必須。削除する共有ライブラリのバージョン番号。  

アプリケーションの起動、再起動および停止

admin_client.jarユーティリティを使用すると、特定のOC4Jインスタンスで、またはクラスタ内のインスタンスのグループでアプリケーションおよびその子アプリケーションを起動、再起動または停止できます。アプリケーション内のファイルが変更されている場合、アプリケーションは起動時に自動的に再デプロイされます。

これらのコマンドを使用してApplication Server Controlコンソール(ascontrol)を停止および起動することもできます。

構文は次のとおりです。

java -jar admin_client.jar uri adminId adminPassword -start|-stop appName

次の例では、クラスタ内のnode2ascontrolアプリケーションを停止しています。

java -jar admin_client.jar deployer:oc4j:opmn://node2.company.com:6004/home oc4jadmin 
password -stop ascontrol

OC4Jインスタンスの再起動および停止

admin_client.jarユーティリティを使用すると、スタンドアロンOC4Jサーバー、管理環境下にある特定のOC4Jインスタンス、またはクラスタ内のインスタンスのグループを停止できます。-shutdownコマンドは、指定された1つ以上のOC4Jインスタンスを停止します。OPMN管理のインスタンスの場合には、停止されることがOPMNに通知されます。-restartコマンドは、指定された1つ以上のインスタンスを再起動します。

次の各項では、これらのコマンドの構文および例を示します。

OC4Jインスタンスまたはインスタンスのグループの再起動

次に示すように、admin_client.jar-restartコマンドラインを使用すると、OC4Jインスタンスまたはクラスタ内のインスタンスのグループを再起動できます。

java -jar admin_client.jar uri adminId adminPassword -restart

たとえば、次のコマンドは、スタンドアロンOC4Jサーバーを再起動します。

java -jar admin_client.jar deployer:oc4j:localhost oc4jadmin password -restart

次のコマンドは、クラスタ・トポロジ内の各Oracle Application Serverのdefault_groupのメンバーであるすべてのOC4Jインスタンスを再起動します。

java -jar admin_client.jar deployer:cluster:opmn://node1.company.com/default_group 
oc4jadmin password -restart

1つ以上のOC4Jインスタンスの停止

次に示すように、admin_client.jar-shutdownコマンドを使用すると、OC4Jインスタンスまたはクラスタ内のインスタンスのグループを停止できます。

java -jar admin_client.jar uri adminId adminPassword -shutdown

たとえば、次のコマンドは、スタンドアロンOC4Jサーバーを停止します。

java -jar admin_client.jar deployer:oc4j:localhost oc4jadmin password -shutdown

このコマンドは、ホスト・マシンが接続されていないかのように、すべてのスレッドを即座に終了させてOC4Jサーバー全体を停止します。このコマンドを使用すると、クラスタ化されたアプリケーションの現在の状態はレプリケートされません。

次のコマンドは、Oracle Application Server管理の環境の指定されたOC4Jインスタンスを停止します。

java -jar admin_client.jar deployer:oc4j:opmn://localhost/home oc4jadmin password 
-shutdown

次のコマンドは、クラスタ・トポロジ内の各Oracle Application Serverのdefault_groupのメンバーであるすべてのOC4Jインスタンスを停止します。

java -jar admin_client.jar deployer:cluster:opmn://node1.company.com/default_group 
oc4jadmin password -shutdown

これらのコマンドは指定された1つ以上のインスタンスを停止し、すべてのスレッドを即時に終了します。-shutdownコマンドを使用すると、クラスタ化されたアプリケーションの現在の状態はレプリケートされません。OPMN管理の各OC4Jインスタンスでは、OPMNが再起動を試行しないように、サーバーを故意に停止中であることがadmin_client.jarによりOPMNに通知されます。

データソースの管理

admin_client.jarユーティリティを使用すると、次の各項で説明するように、OC4Jインスタンスまたはクラスタ内のインスタンスのグループでデータソースを管理できます。

データソース接続プールの追加、テストおよび削除

admin_client.jarユーティリティを使用すると、次の各項で説明するように、OC4Jインスタンスまたはクラスタ内のインスタンスのグループでデータソース接続プールを追加、テストおよび削除できます。

データソース接続プールの追加

-addDataSourceConectionPoolコマンドを使用すると、OC4Jインスタンスまたはクラスタ内のグループの各OC4Jインスタンスでアプリケーションのデータソース接続プールを追加できます。

データソース接続プールを追加する構文は次のとおりです。

java -jar admin_client.jar uri adminId adminPassword -addDataSourceConectionPool
-applicationName applicationName -name name -factoryClass factoryClass
-user user -password password -url url
[-factoryProperties name1 value1 [name2 value2 [...]]]

次に例を示します。

java -jar admin_client.jar deployer:oc4j:localhost oc4jadmin welcome1 
-addDataSourceConectionPool -applicationName default -name ScottConnectionPool 
-factoryClass oracle.jdbc.pool.OracleDataSource 
-user scott -password tiger -url jdbc:oracle:thin:@localhost:1521:xe
表6-16    -addDataSourceConectionPoolコマンドのサブスイッチ 
サブスイッチ  説明 

-applicationName 

必須。データソース接続プールを追加するアプリケーションの名前。 

-name 

必須。接続プールの名前。 

-factoryClass 

必須。コネクション・ファクトリ実装の完全修飾パス。 

-user 

必須。接続を取得するために使用するデフォルト・ユーザーの名前。 

-password 

必須。接続を取得するために使用するデフォルトのパスワード。 

-url 

必須。接続を取得するために使用するコネクション・ファクトリのURL。 

-factoryProperties 

任意。コネクション・ファクトリの定義に設定する1つ以上のプロパティ名および値のペア。 

データソース接続プールのテスト

-testDataSourceConnectionPoolコマンドを使用すると、OC4Jインスタンスまたはクラスタ内のグループの各OC4Jインスタンスでデータソース接続プールへのアプリケーションの接続をテストできます。

データソース接続プールへの接続をテストする構文は次のとおりです。

java -jar admin_client.jar uri adminId adminPassword -testDataSourceConnectionPool
-connectionPoolName connectionPoolName -sqlStatement sqlStatement
[-applicationName applicationName] [-user user] [-password password]

次に例を示します。

java -jar admin_client.jar deployer:oc4j:localhost oc4jadmin welcome1
-testDataSourceConnectionPool -sqlStatement "select * from dual" 
-applicationName default -connectionPoolName ScottConnectionPool
表6-17    -testDataSourceConnectionPoolコマンドのサブスイッチ 
サブスイッチ  説明 

-connectionPoolName 

必須。接続プールの名前。 

-sqlStatement 

必須。接続をテストするために使用するSQL文。 

-applicationName 

任意。データソース接続プールをテストするアプリケーションの名前。 

-user 

任意。接続を取得するために使用するデフォルト・ユーザーの名前。 

-password 

任意。接続を取得するために使用するデフォルトのパスワード。 

データソース接続プールの削除

-removeDataSourceConnectionPoolコマンドを使用すると、OC4Jインスタンスまたはクラスタ内のグループの各OC4Jインスタンスでアプリケーションからデータソース接続プールを削除できます。データソース接続プールを削除する構文は次のとおりです。

java -jar admin_client.jar uri adminId adminPassword 
-removeDataSourceConnectionPool -name name [-applicationName applicationName]

次に例を示します。

java -jar admin_client.jar deployer:oc4j:localhost oc4jadmin welcome1 
-removeDataSourceConnectionPool -name ScottConnectionPool -applicationName default 
表6-18    -removeDataSourceConnectionPoolコマンドのサブスイッチ 
サブスイッチ  説明 

-name 

必須。接続プールの名前。 

-applicationName 

任意。データソース接続プールを削除するアプリケーションの名前。 

データソースの追加、テストおよび削除

admin_client.jarユーティリティを使用すると、次の各項で説明するように、OC4Jインスタンスまたはクラスタ内のインスタンスのグループでデータソースを追加、テストおよび削除できます。

マネージド・データソースの追加

-addManagedDataSourceコマンドを使用すると、OC4Jインスタンスまたはクラスタ内のグループの各OC4Jインスタンスでアプリケーションのマネージド・データソースを追加できます。マネージド・データソースを追加する構文は次のとおりです。

java -jar admin_client.jar uri adminId adminPassword -addManagedDataSource
-applicationName applicationName -dataSourceName dataSourceName 
-jndiLocation jndiLocation -connectionPoolName connectionPoolName 
[-user user] [-password password] [-loginTimeout loginTimeout] [-txLevel txLevel] 
[-dbSchema dbSchema] [-manageLocalTransactions true|false] 

次に例を示します。

java -jar admin_client.jar deployer:oc4j:localhost oc4jadmin welcome1 
-addManagedDataSource -applicationName default -dataSourceName ScottDataSource 
-jndiLocation jdbc/ScottDataSource -connectionPoolName ScottConnectionPool
表6-19    -addManagedDataSourceコマンドのサブスイッチ 
サブスイッチ  説明 

-applicationName 

必須。データソースを追加するアプリケーションの名前。 

-dataSourceName 

必須。データソースの名前。 

-jndiLocation 

必須。新規データソースをJNDIにバインドするために使用する場所。 

-connectionPoolName 

必須。データソースが通信するコネクション・プールの名前。 

-user 

任意。新規データソースのデフォルト・ユーザー。 

-password 

任意。新規データソースのデフォルト・パスワード。 

-loginTimeout 

任意。新規データソースのログイン・タイムアウト。 

-txLevel 

任意。トランザクション・レベル(localまたはglobal)。 

-dbSchema 

任意。使用中のEJB CMP実装がOrion CMPの場合に使用するデータベース・スキーマ。(TopLink CMPはデフォルトです。) 

-manageLocalTransactions 

任意。OC4Jでローカル・トランザクションを管理するかどうかを指定します。デフォルト値はtrueです。 

マネージド・データソースの削除

-removeManagedDataSourceコマンドを使用すると、OC4Jインスタンスまたはクラスタ内のグループの各OC4Jインスタンスでアプリケーションからマネージド・データソースを削除できます。マネージド・データソースを削除する構文は次のとおりです。

java -jar admin_client.jar uri adminId adminPassword -removeManagedDataSource
-dataSourceName dataSourceName [-applicationName applicationName] 

次に例を示します。

java -jar admin_client.jar deployer:oc4j:localhost oc4jadmin welcome1 
-removeManagedDataSource -dataSourceName ScottDataSource -applicationName default 
表6-20    -removeManagedDataSourceコマンドのサブスイッチ 
サブスイッチ  説明 

-dataSourceName 

必須。削除するデータソースの名前。 

-applicationName 

任意。データソースを削除するアプリケーションの名前。 

ネイティブ・データソースの追加

-addNativeDataSourceコマンドを使用すると、OC4Jインスタンスまたはクラスタ内のグループの各OC4Jインスタンスでアプリケーションのネイティブ・データソースを追加できます。ネイティブ・データソースを追加する構文は次のとおりです。

java -jar admin_client.jar uri adminId adminPassword -addNativeDataSource 
-dataSourceName dataSourceName -user user -password password 
-jndiLocation jndiLocation -loginTimeout loginTimeout 
-dataSourceClass dataSourceClass -url url [-applicationName applicationName] 
[-properties name1 value1 [name2 value2 [...]]]

次に例を示します。

java -jar admin_client.jar deployer:oc4j:localhost oc4jadmin welcome1 
-addNativeDataSource -dataSourceName ScottDataSource 
-user scott -password tiger -jndiLocation jdbc/ScottNativeDataSource
-loginTimeout 5 -dataSourceClass com.acme.DataSourceImpl
-url jdbc:oracle:thin:@localhost:1521:xe
表6-21    -addNativeDataSourceコマンドのサブスイッチ 
サブスイッチ  説明 

-dataSourceName 

必須。新規データソースの名前。 

-user 

必須。新規データソースのデフォルト・ユーザー。 

-password 

必須。新規データソースのデフォルト・パスワード。 

-jndiLocation 

必須。新規データソースをJNDIにバインドするために使用する場所。 

-loginTimeout 

必須。新規データソースのログイン・タイムアウト。 

-dataSourceClass 

必須。新規データソースの完全修飾クラス。 

-url 

必須。データベースに接続するために新規データソースによって使用されるURL。 

-applicationName 

任意。データソースを追加するアプリケーションの名前。 

-properties 

任意。新規データソースの1つ以上のプロパティ。 

ネイティブ・データソースの削除

-removeNativeDataSourceコマンドを使用すると、OC4Jインスタンスまたはクラスタ内のグループの各OC4Jインスタンスでアプリケーションからネイティブ・データソースを削除できます。ネイティブ・データソースを削除する構文は次のとおりです。

java -jar admin_client.jar uri adminId adminPassword -removeNativeDataSource 
-dataSourceClass dataSourceClass  [-applicationName applicationName]

次に例を示します。

java -jar admin_client.jar deployer:oc4j:localhost oc4jadmin welcome1 
-removeNativeDataSource -dataSourceName ScottDataSource 
表6-22    -removeNativeDataSourceコマンドのサブスイッチ 
サブスイッチ  説明 

-dataSourceName 

必須。削除するデータソースの名前。 

-applicationName 

任意。データソースを削除するアプリケーションの名前。 

データベース接続のテスト

-testDatabaseConnectionコマンドを使用すると、OC4Jインスタンスまたはクラスタ内のグループの各OC4Jインスタンスでアプリケーションのデータベースへの接続をテストできます。

データベース接続をテストする構文は次のとおりです。

java -jar admin_client.jar uri adminId adminPassword -testDatabaseConnection
-sqlStatement sqlStatement -factoryClass factoryClass -user user 
-password password -url url [-applicationName applicationName] 

次に例を示します。

java -jar admin_client.jar deployer:oc4j:localhost oc4jadmin welcome1
-testDatabaseConnection -sqlStatement "select * from dual"
-factoryClass oracle.jdbc.pool.OracleDataSource -user scott
-password tiger -url jdbc:oracle:thin:@localhost:1521:xe -applicationName default 
表6-23    -testDatabaseConnectionコマンドのサブスイッチ 
サブスイッチ  説明 

-sqlStatement 

必須。接続をテストするために使用するSQL文。 

-factoryClass 

必須。テストするJDBCファクトリ(Driver、DataSource、ConnectionPoolDataSourceまたはXADataSourceのインスタンス)。 

-user 

必須。使用するユーザー。 

-password 

必須。使用するパスワード。 

-url 

必須。JDBCファクトリに設定するURL。 

-applicationName 

任意。アプリケーションの名前。 

データソースのテスト

-testDataSourceコマンドを使用すると、OC4Jインスタンスまたはクラスタ内のグループの各OC4Jインスタンスでアプリケーションのデータソースへの接続をテストできます。

データソースをテストする構文は次のとおりです。

java -jar admin_client.jar uri adminId adminPassword -testDataSource
-datasourceName datasourceName -sqlStatement sqlStatement 
[-applicationName applicationName] [-user user] 
[-password password]

次に例を示します。

java -jar admin_client.jar deployer:oc4j:localhost oc4jadmin welcome1
-testDataSource -datasourceName ScottDataSource -sqlStatement "select * from dual"
-applicationName default -user scott -password tiger 
表6-24    -testDataSourceコマンドのサブスイッチ 
サブスイッチ  説明 

-datasourceName 

必須。テストするデータソース。 

-sqlStatement 

必須。接続をテストするために使用するSQL文。 

-applicationName 

任意。アプリケーションの名前。 

-user 

任意。使用するユーザー。 

-password 

任意。使用するパスワード。 

アプリケーションのデータソース・ディスクリプタの取得

-getDataSourcesDescriptorコマンドを使用すると、アプリケーションのデータソース・ディスクリプタを取得できます。データソース・ディスクリプタを取得する構文は次のとおりです。

java -jar admin_client.jar uri adminId adminPassword -getDataSourcesDescriptor
[-applicationName applicationName]  
表6-25    -getDataSourcesDescriptorコマンドのサブスイッチ 
サブスイッチ  説明 

-applicationName 

任意。ディスクリプタが属するアプリケーションの名前。 

JMSリソースの管理

admin_client.jarユーティリティを使用すると、次の各項で説明するように、OC4Jインスタンスまたはクラスタ内のインスタンスのグループでJMSリソースを管理できます。

JMSコネクション・ファクトリの管理

admin_client.jarユーティリティを使用すると、次の各項で説明するように、OC4J JMSコネクション・ファクトリを管理できます。

JMSコネクション・ファクトリの追加

-addJMSConnectionFactoryコマンドを使用すると、OC4Jインスタンスまたはクラスタ内のグループの各インスタンスにJMSコネクション・ファクトリを追加できます。このコマンドの構文は次のとおりです。

java -jar admin_client.jar uri adminId adminPassword -addJMSConnectionFactory
-domain domain -location location [-host host] [-port port]
[-username username] [-password password] [-clientID clientID] [-isXA true|false]

次に例を示します。

java -jar admin_client.jar deployer:oc4j:localhost oc4jadmin welcome1 
-addJMSConnectionFactory -domain Queue -location jms/ExampleQueueCF
表6-26    -addJMSConnectionFactoryコマンドのサブスイッチ 
サブスイッチ  説明 

-domain 

必須。コネクション・ファクトリのJMSドメイン(`QUEUE'`TOPIC'または`UNIFIED')。 

-location 

必須。コネクション・ファクトリをバインドするJNDIロケーション。 

-host 

任意。コネクション・ファクトリに関連付けるホスト名(デフォルトで、包含するOC4J JMSサーバー・ホストに設定されます)。 

-port 

任意。コネクション・ファクトリに関連付けるポート番号(デフォルトで、包含するOC4J JMSサーバー・ポートに設定されます)。 

-username 

任意。コネクション・ファクトリに関連付けるユーザー名(デフォルトでanonymousに設定されます)。 

-password  

任意。コネクション・ファクトリに関連付けるパスワード(デフォルトでNullに設定されます)。 

-clientID 

任意。コネクション・ファクトリに関連付けるJMSクライアントID(デフォルトでNullに設定されます)。 

-isXA 

任意。XAコネクション・ファクトリであるかどうかを指定します(デフォルトでfalseに設定されます)。 

JMSコネクション・ファクトリの削除

-removeJMSConnectionFactoryコマンドを使用すると、1つ以上のOC4JインスタンスからJMSコネクション・ファクトリを削除できます。このコマンドの構文は次のとおりです。

java -jar admin_client.jar uri adminId adminPassword -removeJMSConnectionFactory
-location location

次に例を示します。

java -jar admin_client.jar deployer:oc4j:localhost oc4jadmin welcome1 
-removeJMSConnectionFactory -location jms/ExampleQueueCF
表6-27    -removeJMSConnectionFactoryコマンドのサブスイッチ 
サブスイッチ  説明 

-location 

必須。削除するコネクション・ファクトリのJNDIロケーション。 

JMSコネクション・ファクトリの情報の取得

-getJMSConnectionFactoriesコマンドを使用すると、OC4Jインスタンスまたはクラスタ内のOC4Jインスタンスのグループで各JMSコネクション・ファクトリの属性を戻すことができます。このコマンドの構文は次のとおりです。

java -jar admin_client.jar uri adminId adminPassword -getJMSConnectionFactories

次に例を示します。

java -jar admin_client.jar deployer:oc4j:localhost oc4jadmin welcome1 
-getJMSConnectionFactories

JMS宛先の管理

admin_client.jarユーティリティを使用すると、次の各項で説明するように、OC4J JMS宛先を管理できます。

JMS宛先の追加

-addDestinationコマンドを使用すると、JMS宛先を追加できます。このコマンドの構文は次のとおりです。

java -jar admin_client.jar uri adminId adminPassword -addDestination
-domain domain -name name -jndiLocation jndiLocation [-persistenceFile persistenceFile] 
[-description description]

次に例を示します。

java -jar admin_client.jar deployer:oc4j:localhost oc4jadmin welcome1 
-addDestination -domain Queue -name ExampleQueue -jndiLocation jms/ExampleQueue
表6-28    -addDestinationコマンドのサブスイッチ 
サブスイッチ  説明 

-domain 

必須。宛先のJMSドメイン(`QUEUE'または`TOPIC')。 

-name 

必須。宛先のOC4J JMSプロバイダ固有の名前。 

-jndiLocation 

必須。宛先をバインドするJNDIロケーション。 

-persistenceFile 

任意。宛先に関連付ける永続性ファイル(デフォルトでNullに設定されます)。 

-description 

任意。宛先に関するテキストの説明(デフォルトでNullに設定されます)。 

JMS宛先の削除

-removeDestinationコマンドを使用すると、OC4Jインスタンスまたはクラスタ内のグループの各OC4JインスタンスからJMS宛先を削除できます。このコマンドの構文は次のとおりです。

java -jar admin_client.jar uri adminId adminPassword -removeDestination
-name name [-force true|false]  [-removePFile true|false]

次に例を示します。

java -jar admin_client.jar deployer:oc4j:localhost oc4jadmin welcome1 
-removeDestination -name ExampleQueue -removePFile true
表6-29    -removeDestinationコマンドのサブスイッチ 
サブスイッチ  説明 

-name 

必須。削除する宛先のOC4J JMSプロバイダ固有の名前。 

-force 

任意。メッセージまたはコンシューマが存在するかどうかにかかわらず宛先が削除されます(デフォルトでfalseに設定されます)。 

-removePFile 

任意。ファイル・システムから永続性ファイルを削除します(デフォルトでfalseに設定されます)。 

JMS宛先の情報の取得

-getDestinationsコマンドを使用すると、OC4Jインスタンスまたはクラスタ内のOC4Jインスタンスのグループで各OC4J JMS宛先の属性を戻すことができます。このコマンドの構文は次のとおりです。

java -jar admin_client.jar uri adminId adminPassword -getDestinations

次に例を示します。

java -jar admin_client.jar deployer:oc4j:localhost oc4jadmin welcome1 
-getDestinations

リモート・クライアントを使用したOC4Jの管理

「リモート管理クライアントのダウンロードおよび抽出」で説明されているように、リモート管理クライアントからファイルをインストールすると、リモート・クライアントを使用してOC4Jを管理できます。その後、コマンドライン・ツールまたはJMXリモートAPIを介してadmin_client.jarを使用できます。

リモートからのadmin_client.jarコマンドの使用方法

「リモート管理クライアントのダウンロードおよび抽出」で説明されているように、OC4Jアプリケーション・サーバー・ターゲットに接続すると、リモート・クライアントからadmin_client.jarコマンドを発行できます。OC4Jインスタンス内で使用するのと同じ構文を使用します。

JConsoleを使用したリモートのOracle Application Serverインスタンスへの接続

JConsoleは、JDK 5.0に含まれるJMX GUIコンソールです。JConsoleは任意のJVMに接続し、稼働中のMBeanServerにフックできます。これにより、JVMのスレッドやメモリー使用量など、システムの様々な詳細が示された一連のページが表示されます。JConsoleはローカルJVMに接続することも、JMXリモートAPIを使用してリモートJVMに接続することもできます。

管理クライアント・ディストリビューションには、JConsoleによるリモートのOC4JまたはOracle Application Serverインスタンスへの接続に必要なライブラリが含まれています。ターゲット・インスタンスに接続するには、(Windowsプラットフォームでネイティブの実行可能ファイルとして提供されている)JConsoleユーティリティが、管理クライアント・ディストリビューションの関連する詳細とともに構成されている必要があります。

Oracle Application Serverインスタンスに接続するには、次のようにします。

  1. CLASSPATH環境変数に/j2ee/instance/admin_client.jarを追加します。

    set CLASSPATH=j2ee/home/admin_client.jar
    
  2. CLASSPATH環境変数にJConsoleライブラリを追加します。

    set CLASSPATH=%CLASSPATH%;%JAVA_HOME%¥lib¥jconsole.jar
    set CLASSPATH=%CLASSPATH%;%JAVA_HOME%¥lib¥tools.jar
    
  3. OC4J ORMIプロトコルを使用できるようJMXコネクタを構成します。

    set PROPS= jmx.remote.protocol.provider.pkgs=oracle.oc4j.admin.jmx.remote
    
  4. JConsoleを実行します。

    %JAVA_HOME%¥bin¥jconsole
    -J-Djava.class.path=%CLASSPATH% 
    -J-D%PROPS%
    

    これによりJConsoleが起動されます。

  5. 「Connect to Agent」画面の「Advanced」タブで、OC4JまたはOracle Application Serverターゲットの接続文字列、およびターゲットの管理ユーザー名とパスワードを入力します。

    OC4Jターゲットでは、JMX URLのパターンは、Oracle Application Serverターゲットのパターンとは異なります。表6-30に、これらのURLパターンの例を示します。

    表6-30    OC4JおよびOracle Application ServerターゲットのJMX URL 
    ターゲット  JMX URL 

    OC4Jスタンドアロン・サーバー 

    service:jmx:rmi://test-cycle.oracle.com:23791 

    Oracle Application ServerのOC4Jインスタンス 

    service:jmx:ormi:///opmn://test-cycle.oracle.com:6010/test1 

    Oracle Application Serverクラスタ 

    service:jmx:rmis:///opmn://stadp69:6003/cluster/as101/admin 

  6. JConsoleユーティリティにより、ターゲット・インスタンスのOC4J MBeansが表示されます。これらのMBeansは、OC4Jインスタンスの構成の表示および管理に使用できます。

Windowsでは、JConsoleによって使用される環境は、次に示す特別なシステム・プロパティ・フォームを使用して変更できます。

-J-Dname=value

次に、サンプル・コマンドのスクリプトを示します。

setlocal

set URL=service:jmx:rmi:///opmn://test-cycle.oracle.com:6010/testunit

set JAVA_HOME=C:¥java¥jdk150_07

set JCONSOLE_CP
set JCONSOLE_CP=%JCONSOLE_CP%;%JAVA_HOME%¥lib¥jconsole.jar
set JCONSOLE_CP=%JCONSOLE_CP%;%JAVA_HOME%¥lib¥tools.jar

set ORACLE_HOME=D:¥oc4j_admin_client
set ORACLE_CP=
set ORACLE_CP=%ORACLE_CP%;%ORACLE_HOME%¥j2ee¥home¥admin_client.jar;

set CLASSPATH=%JCONSOLE_CP%;%ORACLE_CP%
set PROPS=
set PROPS=%PROPS%  
-J-Djmx.remote.protocol.provider.pkgs=oracle.oc4j.admin.jmx.remote

set PROPS=%PROPS% -J-Djava.class.path=%CLASSPATH%

jconsole %PROPS% %URL%

endlocal

JMXプログラム・クライアントを使用したリモートからのOC4Jの管理

管理クライアント・ディストリビューションは、JMXクライアント・アプリケーションがリモートのOC4Jインスタンスに接続するための完全なクライアント環境を提供します。JMXプログラム・クライアントを使用し、MBeanServerへの接続を確立できるJMXリモートAPI(JSR160)を介してリモートからOC4Jを管理できます。JDK 5.0を使用して実行するために必要なJARファイルは、管理クライアント・ディストリビューションによって提供されるoc4jclient.jarおよびadmin_client.jarのみです。

次の例では、JMX APIとともにこれらのJARファイルが使用されています。

// A URL is of the form "service:jmx:rmi://127.0.0.1:23791" 
             JMXServiceURL serviceURL = new JMXServiceURL(_url); 
  
             Hashtable credentials = new Hashtable(); 
              credentials.put("login", _username); 
              credentials.put("password", _password); 
  
             // Properties required to use the OC4J ORMI protocol 
             Hashtable env = new Hashtable(); 
             env.put(JMXConnectorFactory.PROTOCOL_PROVIDER_PACKAGES, 
 "oracle.oc4j.admin.jmx.remote"); 
             env.put(JMXConnector.CREDENTIALS, credentials); 
             JMXConnector jmxCon = 
 JMXConnectorFactory.newJMXConnector(serviceURL, env); 
             jmxCon.connect(); 
  
             MBeanServerConnection mbeanServer = 
 jmxCon.getMBeanServerConnection(); 

JDK 5.0では、このコードのコンパイルにはOracleライブラリは不要で、JDK 5.0に用意されているライブラリのみが使用されます。

clear 
 @echo off 
 @setlocal 
  
 set J2EE_HOME=c:¥java¥oc4j-1013-prod¥j2ee¥home 
 set JAVA_HOME=c:¥java¥jdk50 
 set CLASSPATH=. 
  
 rem 
 rem Uncomment below if using JDK14 
 rem set CLASSPATH=%CLASSPATH%;%J2EE_HOME%¥lib¥jmxri.jar 
 rem set CLASSPATH=%CLASSPATH%;%J2EE_HOME%¥lib¥jmx_remote_api.jar 
 rem set CLASSPATH=%CLASSPATH%;%J2EE_HOME%¥lib¥javax77.jar 
 rem 
  
 %JAVA_HOME%¥bin¥javac -classpath %CLASSPATH% -d . *.java 
 @endlocal 

oc4j_admin_client_101310.zipディストリビューションを使用してコードを実行するには、次のようにします。

  1. 実行可能なJARファイルを作成します。

  2. JARファイルを管理クライアント・ディストリビューションのj2ee/homeディレクトリに移動します。

  3. リモートのOC4Jインスタンスに接続します。

コードは、$ORACLE_HOME/j2ee/home/oc4jclient.jarおよび$ORACLE_HOME/j2ee/home/admin_client.jarを使用してJDK 5.0で実行されます。

@echo off 
@setlocal 
clear 
set J2EE_HOME=c:¥java¥oc4j-1013-prod¥j2ee¥home 
set JAVA_HOME=c:¥java¥jdk50 

rem Runtime classpath 
set CLASSPATH=. 
set CLASSPATH=%CLASSPATH%;%J2EE_HOME%¥oc4jclient.jar; 
set CLASSPATH=%CLASSPATH%;%J2EE_HOME%¥admin_client.jar; 

rem 
rem Uncomment if using JDK14 
rem set CLASSPATH=%CLASSPATH%;%J2EE_HOME%¥lib¥jmxri.jar 
rem set CLASSPATH=%CLASSPATH%;%J2EE_HOME%¥lib¥jmx_remote_api.jar 
rem set CLASSPATH=%CLASSPATH%;%J2EE_HOME%¥lib¥javax77.jar 
@endlocal 

この例のメイン・メソッドの接続URLは、ローカルのOC4Jインスタンスに接続するよう設定されています。ORMIポートを介してOracle Application Serverに接続する必要がある場合には、次の形式のサービスURLを使用します。

 service:jmx:rmi|ormi:///opmn://stadp57.us.oracle.com:6003/home

サービスURLは、OPMNデーモンからORMIポートを取得します。ORMIポートは実行時に割り当てられます。OPMN接続文字列パスを使用すると、指定されたOC4Jインスタンスに接続できます。

JMXクライアントを使用してリモートからOC4Jインスタンスを管理する方法の詳細は、『Oracle Containers for J2EE開発者ガイド』の「JMXリモートAPI(JSR-160)を使用するリモート管理」を参照してください。


戻る 次へ
Oracle
Copyright © 2006 Oracle Corporation.

All Rights Reserved.
目次
目次
索引
索引