この項目では、endptEnabler コマンドを使用してエンタープライズ・アーカイブ (EAR) ファイル内の 一連の Web サービスを使用可能にする方法について説明します。 endptEnabler コマンドは、Web サービス対応 Enterprise JavaBeans (EJB) モジュールを含む EAR ファイル上で実行する必要があります。
各ルーター・モジュールは、特定のトランスポート用の Web サービス・エンドポイント を提供します。例えば、HTTP ルーター・モジュールを追加して、Web サービスが HTTP トランスポート経由で要求を受信できるようにすることができます。 また、Java Message Service (JMS) ルーター・モジュールを追加して、Web サービスが JMS キューやトピックから要求を受信できるようにすることもできます。
endptEnabler コマンドの対話モードでは、アプリケーション内の 1 つ以上のサービスを 使用可能にするために必要なステップが順を追って表示されます。 endptEnabler コマンドは、後でサービスを除去したり追加したりする必要がある場合に備えて、 元の EAR ファイルのバックアップ・コピーを作成します。EAR ファイルに Web サービス対応の Enterprise Bean Java アーカイブ (JAR) ファイルが含まれている場合、EAR ファイルをデプロイする前に endptEnabler コマンドを実行しなければなりません。 含まれていない場合は、このコマンドを実行する必要はありません。
endptEnabler [-verbose|-v] [-quiet|-q] [-help|-h|-?] [-properties|-p properties-filename] [-transport|-t default-transports] [-enableHttpRouterSecurity] [ear-filename]
このパラメーターを使用すると、endptEnabler ツールによる EAR ファイル処理時の進行状況の詳細を示すメッセージが表示されます。 このコマンド行オプションは、 verbose グローバル・プロパティーにマップされます。
このパラメーターを使用すると、endptEnabler ツールによる EAR ファイル処理時のモジュール別進行状況を示すメッセージは表示されません。 このコマンド行オプションは、 quiet グローバル・プロパティーにマップされます。
このパラメーターを使用すると、各種オプションについて説明する簡潔なヘルプ・メッセージが表示されます。
このパラメーターを使用すると、properties-filename プロパティーからプロパティーが読み取られ、endptEnabler ツールの動作が制御されます。
-transport http (the default) -transport jms -t http,jms
このパラメーターを使用すると、すべての EJB モジュールがエンタープライズ Bean JAR ファイル内で保護されている場合に、すべての認証済みユーザーにセキュリティー・ポリシーを追加して、HTTP ルーター・モジュールをプロテクトできるようになります。 このコマンド行オプションは、http.enableRouterSecurity グローバル・プロパティー にマップされます。
このパラメーターは、処理される EAR ファイルの名前を指定します。
ear-filename パラメーターがコマンド行から入力されていない場合は、 対話モードが使用されます。 対話モードでは、処理の進行に応じて、EAR ファイル名、ルーター・モジュール名、およびその他の重要な値の入力を求めるプロンプトが出されます。 以下のダイアログは、endptEnabler 対話モードの例です。
endptEnabler<enter> WSWS2004I: IBM WebSphere Application Server Release 5 WSWS2005I: Web Services Enterprise Archive Endpoint Enabler Tool. WSWS2007I: (C) COPYRIGHT International Business Machines Corp. 1997, 2003 WSWS2006I: Please enter the name of your EAR file: AddressBook.ear<enter> WSWS2003I: Backing up EAR file to: AddressBook.ear~ WSWS2016I: Loading EAR file: AddressBook.ear WSWS2017I: Found EJB Module: AddressBookEJB.jar WSWS2029I: Enter http router name for EJB Module AddressBookEJB [AddressBookEJB_HTTPRouter.war]:<enter> WSWS2030I: Enter http context root for EJB Module AddressBookEJB [/AddressBookEJB]:<enter> WSWS2024I: Adding http router for EJB Module AddressBookEJB.jar. WSWS2036I: Saving EAR file AddressBook.ear... WSWS2037I: Finished saving the EAR file. WSWS2018I: Finished processing EAR file AddressBook.ear.ear-filename パラメーターがコマンド行から入力されている場合は、非対話モードが使用されます。 非対話モードでは、ルーター・モジュール名およびその他の重要な値は、ユーザーが指定したプロパティーやデフォルト値から判別されます。
endptEnabler コマンドを使用すると、-properties コマンド行オプションを使用してプロパティーのセットを指定することにより、そのランタイムの振る舞いを制御できます。 これらのプロパティーは、グローバルに、またはモジュールごとに、どちらかの方法で編成されます。グローバル・プロパティーは、EAR ファイル内の複数の Enterprise Bean JAR モジュールを処理するツールの、全体的な振る舞いに影響を与えます。 モジュールごとのプロパティーは、特定の Enterprise Bean JAR モジュールの処理に影響を与えます。
グローバル・プロパティー
次の表では、 endptEnabler コマンドがサポートするグローバル・プロパティーについて説明しています。
プロパティー名 | 説明 | デフォルト値 |
verbose | 詳細な進行状況メッセージを表示します。 | False |
quiet | 簡単な進行状況メッセージのみを表示します。 | False |
http.enableRouter Security | すべての EJB モジュールがエンタープライズ Bean JAR ファイル内で保護されている場合に、すべての認証済みユーザーにセキュリティー・ポリシーを追加して、HTTP ルーター・モジュールをプロテクトできるようにします。 | False |
http.router ModuleNameSuffix | デフォルト HTTP ルーター・モジュール名を構成するために使用する サフィックスを指定します。.war 拡張子は、endptEnabler コマンドによって追加されます。 | _HTTPRouter |
jms.routerModule NameSuffix | デフォルト JMS ルーター・モジュール名を構成するために使用する サフィックスを指定します。.jar 拡張子は、endptEnabler コマンドによって追加されます。 | _JMSRouter |
jms.default DestinationType | EAR ファイルに追加されるすべての JMS ルーター・モジュールに使用する、デフォルトの宛先タイプを指定します。 このタイプは、queue または topic のいずれかになります。 | キュー |
defaultTransports | ルーター・モジュールの作成先となる、デフォルトのトランスポートのリストを指定します。このリストには、値 http および jms が含まれます。 複数の値は、コンマで区切られます。例: http, jms および http,jms など。 | http |
モジュールごとのプロパティー
次の表では、 endptEnabler コマンドがサポートするモジュールごとのプロパティーについて説明しています。ejbJarName 変数は、EAR ファイル内の Enterprise Bean JAR モジュールの、.jar 拡張子の付かない名前を参照します。
プロパティー名 | 説明 | デフォルト値 |
<ejbJarName> .transports | 特定の Enterprise Bean JAR ファイルにルーター・モジュールが作成されるトランスポートをリストします。このリストには、値 http および jms が含まれます。 複数の値は、コンマで区切られます。例: http, jms および http,jms など。 | http |
<ejbJarName>.http.skip | 別のプロパティーで追加されるようになっている場合であっても、HTTP ルーター・モジュールの追加をバイパスするフラグを指定します。 有効な値は、true および false です。 | false |
<ejbJarName> .http.routerModuleName | 特定の Enterprise Bean JAR ファイルの HTTP ルーター・モジュールの名前を指定します。 | ejbJarName_HTTPRouter |
<ejbJarName> .http.contextRoot | 特定の Enterprise Bean JAR ファイルの HTTP ルーター・モジュールに関連付けられるコンテキスト・ルートを指定します。 | /ejbJarName |
<ejbJarName>.jms.skip | 別のプロパティーで追加されるようになっている場合であっても、JMS ルーター・モジュールの追加をバイパスするフラグを指定します。 有効な値は、true および false です。 | false |
<ejbJarName>.jms. routerModuleName | 特定の Enterprise Bean JAR ファイルの JMS ルーター・モジュールの名前を指定します。 | ejbJarName_JMSRouter |
<ejbJarName>.jms.activationSpecJndiName | JMS ルーター・モジュール内の Message Driven Bean (MDB) 向けに構成される、アクティベーション・スペックである Java Naming and Directory Interface (JNDI) 名を指定します。 | ヌル |
<ejbJarName>.jms.listenerInputPortName | JMS ルーター・モジュール内に MDB を構成するリスナー・ポートの名前を指定します。リスナー・ポートは、activationSpecJndiName プロパティーが指定されない場合のみ構成されます。 | ヌル |
<ejbJarName>.ejb JarName>.jms. destinationType | JMS ルーター内の MDB に関連付けられる JMS 宛先タイプを指定します。 有効な値は、queue および topic です。 | キュー |
プロパティーの例
StockQuoteEJB.transports=http,jms StockQuoteEJB.http.routerModuleName=StockQuoteEJB_HTTP StockQuoteEJB.http.contextRoot=/StockQuote StockQuoteEJB.jms.routerModuleName=StockQuoteEJB_JMS StockQuoteEJB.jms.destinationType=queue
endptEnabler の例
endptEnabler MyApp.ear endptEnabler -t jms,http MyApp.ear endptEnabler -v -properties MyApp.props MyApp.ear endptEnabler -q -t jms MyApp.ear endptEnabler -v -t http,jms