]> &project; Craig R. McClanahan JNDI Resources HOW-TO JNDI リソース HOW-TO 鰈崎 義之 高橋 達男

Tomcat 5 provides a JNDI InitialContext implementation instance to web applications running under it, in a manner that is compatible with those provided by a Java2 Enterprise Edition application server. Entries in this InitialContext are configured in the $CATALINA_HOME/conf/server.xml file, and may be referenced by the following elements in the web application deployment descriptor (/WEB-INF/web.xml) of your web application:

Tomcat 5 は、その下で動作する Web アプリケーションに対して JNDI InitialContext の実装を提供します。この実装は、 Java2 Enterprise Edition アプリケーションサーバで提供される JNDI の実装と互換性があります。 この InitialContext 内のエントリは $CATALINA_HOME/conf/server.xml ファイルで設定され、 アプリケーションの Web アプリケーション配備記述子 (/WEB-INF/web.xml)の以下の要素で参照できます。

  • <env-entry> - Environment entry, a single-value parameter that can be used to configure how the application will operate.
  • <resource-ref> - Resource reference, which is typically to an object factory for resources such as a JDBC DataSource, a JavaMail Session, or custom object factories configured into Tomcat 5.
  • <resource-env-ref> - Resource environment reference, a new variation of resource-ref added in Servlet 2.4 that is simpler to configure for resources that do not require authentication information.
  • <env-entry> - 環境エントリ。 アプリケーションがどのように動作するかを設定するのに使用できる、 単独の値を持つパラメータ。
  • <resource-ref> - リソース参照。 主として JDBC DataSource や JavaMail Session など、 Tomcat 5 内に設定されたカスタムオブジェクトファクトリに対するリソース参照。
  • <resource-env-ref> - リソース環境参照。 Servlet 2.4 で追加された resource-ref の新たなバリエーション。 認証情報が不要なリソースの設定が簡単にできます。

The InitialContext is configured as a web application is initially deployed, and is made available to web application components (for read-only access). All configured entries and resources will be placed in the java:comp/env portion of the JNDI namespace, so a typical access to a resource - in this case, to a JDBC DataSource - would look something like this:

InitialContext は、Web アプリケーションが最初に配備されたときに設定され、 Web アプリケーションコンポーネントから (読み込み専用で) 利用できるようになります。 すべての設定されたエントリとリソースは、JNDI 名前空間の java:comp/env の下に置かれます。したがってリソース - この場合 JDBC DataSource - への典型的なアクセスは以下のようになります。

// Obtain our environment naming context Context initCtx = new InitialContext(); Context envCtx = (Context) initCtx.lookup("java:comp/env"); // Look up our data source DataSource ds = (DataSource) envCtx.lookup("jdbc/EmployeeDB"); // Allocate and use a connection from the pool Connection conn = ds.getConnection(); ... use this connection to access the database ... conn.close(); // 環境ネーミングコンテキストを取得 Context initCtx = new InitialContext(); Context envCtx = (Context) initCtx.lookup("java:comp/env"); // データソースを検索 DataSource ds = (DataSource) envCtx.lookup("jdbc/EmployeeDB"); // 接続をプールから割り当てて使用する Connection conn = ds.getConnection(); ... この接続をデータベースアクセスに使用 ... conn.close();

See the following Specifications for more information about programming APIs for JNDI, and for the features supported by Java2 Enterprise Edition (J2EE) servers, which Tomcat emulates for the services that it provides:

JNDI のプログラミング API や、サービスを提供するために Tomcat がエミュレートしている Java2 Enterprise Edition (J2EE) サーバでサポートする機能に関するより詳しい情報は、以下の仕様を参照してください。

Each available JNDI Resource is configured based on inclusion of the following elements in the $CATALINA_HOME/conf/server.xml file:

利用可能な各 JNDI リソースは、$CATALINA_HOME/conf/server.xml ファイルに以下の要素を含めることで設定できます。

  • <Environment> - Configure names and values for scalar environment entries that will be exposed to the web application through the JNDI InitialContext (equivalent to the inclusion of an <env-entry> element in the web application deployment descriptor).
  • <Resource> - Configure the name and data type of a resource made available to the application (equivalent to the inclusion of a <resource-ref> element in the web application deployment descriptor).
  • <ResourceParams> - Configure the Java class name of the resource factory implementation to be used, as well as JavaBeans properties used to configure that resource factory.
  • <ResourceLink> - Add a link to a resource defined in the global JNDI context.
  • <Environment> - JNDI InitialContext を通じて Web アプリケーションに公開するスカラ値の環境エントリの名前と値を設定します (Web アプリケーション配備記述子に含める <env-entry> 要素と同等)。
  • <Resource> - アプリケーションで利用できるようにリソースの名前とデータ型を設定します (Web アプリケーション配備記述子に含める <resource-ref> 要素と同等)。
  • <ResourceParams> - リソースファクトリの実装に使われる Java クラス名と、 リソースファクトリの設定に使われる JavaBean のプロパティを設定します。
  • <ResourceLink> - グローバル JNDI コンテキストで定義されたリソースへのリンクを追加します。

Any number of these elements may be nested inside a <Context> element (to be associated only with that particular web application) or inside a <DefaultContext> element (used to set the default configuration characteristics for automatically deloyed applications).

これらの要素は、 <Context> 要素 (特定の Web アプリケーションだけに関連付けられる)内や、 <DefaultContext> 要素(自動的に配備されるアプリケーションのデフォルト設定として使われる) 内の入れ子として、 いくつ入っていてもかまいません。

In addition, the names and values of all <env-entry> elements included in the web application deployment descriptor (/WEB-INF/web.xml) are configured into the initial context as well, overriding corresponding values from conf/server.xml only if allowed by the corresponding <Environment> element (by setting the override attribute to "true").

さらに、Web アプリケーション配備記述子 (/WEB-INF/web.xml) の中に含まれているすべての <env-entry> 要素の名前と値は初期コンテキスト内で同様に設定されます。 その際、conf/server.xml で対応する値は、対応する <Environment> 要素で (override 属性を "true" にセットすることによって) 許可されている時 だけ 上書きされます。

Global resources can be defined in the server-wide JNDI context, by adding the resource elements described above to the <GlobalNamingResources> child element of the <Server> element.

グローバルリソースは、サーバ全体の JNDI コンテキストの中で定義されます。 <Server> 要素の子要素である <GlobalNamingResources> に、上記の resource 要素を追加することによって定義されます。

Tomcat 5 includes a series of standard resource factories that can provide services to your web applications, but give you configuration flexibility (in $CATALINA_HOME/conf/server.xml) without modifying the web application or the deployment descriptor. Each subsection below details the configuration and usage of the standard resource factories.

Tomcat 5 には一連の標準リソースファクトリがあり、 Web アプリケーションへのサービスの提供も可能ですが、 それ以上に、 Web アプリケーションや配備記述子の修正なしに、 ($CATALINA_HOME/conf/server.xml での) 柔軟な設定を実現します。 標準リソースファクトリの設定と使い方については、以下の各節で詳しく述べます。

See Adding Custom Resource Factories for information about how to create, install, configure, and use your own custom resource factory classes with Tomcat 5.

Tomcat 5 で独自のカスタムリソースファクトリのクラスを作成・インストール・設定・使用する方法に関する情報は カスタムリソースファクトリの追加 を参照してください。

NOTE - Of the standard resource factories, only the "JDBC Data Source" and "User Transaction" factories are mandated to be available on other platforms, and then they are required only if the platform implements the Java2 Enterprise Edition (J2EE) specs. All other standard resource factories, plus custom resource factories that you write yourself, are specific to Tomcat and cannot be assumed to be available on other containers.

注意 - 標準リソースファクトリのうち、 他のプラットフォームでも利用可能であることが義務づけられているのは、 「JDBC データソース」と「ユーザトランザクション」のファクトリだけで、 しかもこれらが必要なのは、プラットフォームが Java2 Enterprise Edition (J2EE) 仕様を実装する場合のみです。他のすべての標準リソースファクトリ、 および独自に作成したカスタムリソースファクトリは Tomcat 固有のものであり、 他のコンテナで使えるかどうかはわかりません。

0. Introduction

0. はじめに

This resource factory can be used to create objects of any Java class that conforms to standard JavaBeans naming conventions (i.e. it has a zero-arguments constructor, and has property setters that conform to the setFoo() naming pattern. The resource factory will create a new instance of the appropriate bean class every time a lookup() for this entry is made.

このリソースファクトリは、標準 JavaBeans 命名規約 (つまり引数のないコンストラクタがあり、setFoo() 形式の命名パターンに沿ったプロパティセッタがある) に従った あらゆる Java クラスのオブジェクトの作成に使用できます。 リソースファクトリは、エントリの lookup() が行われるたびに適切な bean クラスの新しいインスタンスを作成します。

The steps required to use this facility are described below.

この機能を利用するために必要な手順を以下に示します。

1. Create Your JavaBean Class

1. JavaBean クラスの作成

Create the JavaBean class which will be instantiated each time that the resource factory is looked up. For this example, assume you create a class com.mycompany.MyBean, which looks like this:

リソースファクトリが検索されるたびにインスタンス化される JavaBean クラスを作成します。この例では、com.mycompany.MyBean クラスを以下のように作成すると仮定します。

package com.mycompany; public class MyBean { private String foo = "Default Foo"; public String getFoo() { return (this.foo); } public void setFoo(String foo) { this.foo = foo; } private int bar = 0; public int getBar() { return (this.bar); } public void setBar(int bar) { this.bar = bar; } }

2. Declare Your Resource Requirements

2. リソースに必要なものの定義

Next, modify your web application deployment descriptor (/WEB-INF/web.xml) to declare the JNDI name under which you will request new instances of this bean. The simplest approach is to use a <resource-env-ref> element, like this:

次に、この bean の新しいインスタンスをリクエストする JNDI 名を定義するために、 Web アプリケーション配備記述子 (/WEB-INF/web.xml) を修正します。 一番簡単なのは、<resource-env-ref> 要素を使う方法で、 以下のように行います。

<resource-env-ref> <description> Object factory for MyBean instances. </description> <resource-env-ref-name> bean/MyBeanFactory </resource-env-ref-name> <resource-env-ref-type> com.mycompany.MyBean </resource-env-ref-type> </resource-env-ref> <resource-env-ref> <description> MyBean インスタンスのためのオブジェクトファクトリ </description> <resource-env-ref-name> bean/MyBeanFactory </resource-env-ref-name> <resource-env-ref-type> com.mycompany.MyBean </resource-env-ref-type> </resource-env-ref>

WARNING - Be sure you respect the element ordering that is required by the DTD for web application deployment descriptors! See the Servlet Specification for details.

警告 - 要素の順序が Web アプリケーション配備記述子の DTD で要求されたとおりであることを確認してください! 詳細は、 Servlet 仕様 を参照してください。

3. Code Your Application's Use Of This Resource

3. このリソースを使うコードをアプリケーションに記述

A typical use of this resource environment reference might look like this:

このリソース環境参照の典型的な使い方は、以下のようになるでしょう。

Context initCtx = new InitialContext(); Context envCtx = (Context) initCtx.lookup("java:comp/env"); MyBean bean = (MyBean) envCtx.lookup("bean/MyBeanFactory"); writer.println("foo = " + bean.getFoo() + ", bar = " + bean.getBar());

4. Configure Tomcat's Resource Factory

4. Tomcat のリソースファクトリの設定

To configure Tomcat's resource factory, add an elements like this to the $CATALINA_HOME/conf/server.xml file, nested inside the Context element for this web application (or nested inside a DefaultContext element for the surrounding <Host> or <Engine> element.

Tomcat のリソースファクトリを設定するには、この Web アプリケーションの Context 要素内で入れ子になった (あるいは <Host> または <Engine> 要素内のDefaultContext 要素内で入れ子になった)、 以下のような要素を $CATALINA_HOME/conf/server.xml ファイルに追加します。

<Context ...> ... <Resource name="bean/MyBeanFactory" auth="Container" type="com.mycompany.MyBean"/> <ResourceParams name="bean/MyBeanFactory"> <parameter> <name>factory</name> <value>org.apache.naming.factory.BeanFactory</value> </parameter> <parameter> <name>bar</name> <value>23</value> </parameter> </ResourceParams> ... </Context>

Note that the resource name (here, bean/MyBeanFactory must match the value specified in the web application deployment descriptor. We are also initializing the value of the bar property, which will cause setBar(23) to be called before the new bean is returned. Because we are not initializing the foo property (although we could have), the bean will contain whatever default value is set up by its constructor.

リソース名 (ここでは bean/MyBeanFactory) が Web アプリケーション配備記述子で指定された値と一致していなければならないことに注意してください。 また、bar プロパティの値の初期化も行っており、それにより 新しい bean が返される前に setBar(23) が呼び出されます。 foo プロパティは (初期化可能でしたが) 初期化していないので、 bean ではコンストラクタでセットアップする何らかのデフォルト値が入ることでしょう。

0. Introduction

0. はじめに

In many web applications, sending electronic mail messages is a required part of the system's functionality. The Java Mail API makes this process relatively straightforward, but requires many configuration details that the client application must be aware of (including the name of the SMTP host to be used for message sending).

多くの Web アプリケーションにおいて、 システムの機能として電子メールメッセージの送信が必要となります。 Java Mail API は、 比較的簡単にこういった処理を実現しますが、設定の詳細の多くを クライアントアプリケーションが知っている必要があります (メッセージ送信に使う SMTP ホスト名もその一つです)。

Tomcat 5 includes a standard resource factory that will create javax.mail.Session session instances for you, already connected to the SMTP server that is configured in server.xml. In this way, the application is totally insulated from changes in the email server configuration environment - it simply asks for, and receives, a preconfigured session whenever needed.

Tomcat 5 には、 javax.mail.Session のセッションインスタンスを作成する標準リソースファクトリがあります。 このセッションインスタンスは server.xml で設定された SMTP サーバに既に接続されています。この方法で、 アプリケーションは電子メールサーバ環境設定の変更から完全に分離されます - アプリケーションはいつでも必要なときに、 あらかじめ設定されたセッションを要求して受け取るだけです。

The steps required for this are outlined below.

必要な手順の概要を以下で説明します。

1. Declare Your Resource Requirements

1. リソースに必要なものを定義

The first thing you should do is modify the web application deployment descriptor (/WEB-INF/web.xml) to declare the JNDI name under which you will look up preconfigured sessions. By convention, all such names should resolve to the mail subcontext (relative to the standard java:comp/env naming context that is the root of all provided resource factories. A typical web.xml entry might look like this:

まず最初にしなければいけないのは、あらかじめ設定されたセッションを検索する JNDI 名を定義するために、Web アプリケーション配備記述子 (/WEB-INF/web.xml) を修正することです。 is modify → is to modify 慣例に従えば、こうした名前はすべて、mail サブコンテキスト (提供されるすべてのリソースファクトリのルートである標準の java:comp/env ネーミングコンテキストの下位にある) に属すべきです。 典型的な web.xml のエントリは以下のようになるでしょう。

<resource-ref> <description> Resource reference to a factory for javax.mail.Session instances that may be used for sending electronic mail messages, preconfigured to connect to the appropriate SMTP server. </description> <res-ref-name> mail/Session </res-ref-name> <res-type> javax.mail.Session </res-type> <res-auth> Container </res-auth> </resource-ref> <resource-ref> <description> 電子メールメッセージを送信するのに使われる javax.mail.Session インスタンスのファクトリへのリソース参照。 適切な SMTP サーバへ接続するようにあらかじめ設定されています。 </description> <res-ref-name> mail/Session </res-ref-name> <res-type> javax.mail.Session </res-type> <res-auth> Container </res-auth> </resource-ref>

WARNING - Be sure you respect the element ordering that is required by the DTD for web application deployment descriptors! See the Servlet Specification for details.

警告 - 要素の順序が Web アプリケーション配備記述子の DTD で要求されたとおりであることを確認してください! 詳細は、 Servlet 仕様 を参照してください。

2. Code Your Application's Use Of This Resource

2. このリソースを使うコードをアプリケーションに記述

A typical use of this resource reference might look like this:

このリソース環境参照の典型的な使い方は、以下のようになるでしょう。

Context initCtx = new InitialContext(); Context envCtx = (Context) initCtx.lookup("java:comp/env"); Session session = (Session) envCtx.lookup("mail/Session"); Message message = new MimeMessage(session); message.setFrom(new InternetAddress(request.getParameter("from")); InternetAddress to[] = new InternetAddress[1]; to[0] = new InternetAddress(request.getParameter("to")); message.setRecipients(Message.RecipientType.TO, to); message.setSubject(request.getParameter("subject")); message.setContent(request.getParameter("content"), "text/plain"); Transport.send(message);

Note that the application uses the same resource reference name that was declared in the web application deployment descriptor. This is matched up against the resource factory that is configured in $CATALINA_HOME/conf/server.xml, as described below.

アプリケーションでは、Web アプリケーション配備記述子で定義されたものと同じリソース参照名を使うことに注意してください。 これは、以下で示す $CATALINA_HOME/conf/server.xml で定義されるリソースファクトリと一致してなければなりません。

3. Configure Tomcat's Resource Factory

3. Tomcat のリソースファクトリの設定

To configure Tomcat's resource factory, add an elements like this to the $CATALINA_HOME/conf/server.xml file, nested inside the Context element for this web application (or nested inside a DefaultContext element for the surrounding <Host> or <Engine> element.

Tomcat のリソースファクトリを設定するには、この Web アプリケーションの Context 要素内で入れ子になった (あるいは <Host> または <Engine> 要素内のDefaultContext 要素内で入れ子になった)、 以下のような要素を $CATALINA_HOME/conf/server.xml ファイルに追加します。

<Context ...> ... <Resource name="mail/Session" auth="Container" type="javax.mail.Session"/> <ResourceParams name="mail/Session"> <parameter> <name>mail.smtp.host</name> <value>localhost</value> </parameter> </ResourceParams> ... </Context>

Note that the resource name (here, mail/Session) must match the value specified in the web application deployment descriptor. Customize the value of the mail.smtp.host parameter to point at the server that provides SMTP service for your network.

リソース名 (ここでは mail/Session) が Web アプリケーション配備記述子で指定された値と一致していなければならないことに注意してください。 mail.smtp.host パラメータの値は、実際のネットワークで SMTP サービスを提供しているサーバを指すようにカスタマイズしてください。

Example Application

サンプルアプリケーション

The /examples application included with Tomcat contains an example of utilizing this resource factory. It is accessed via the "JSP Examples" link. The source code for the servlet that actually sends the mail message is in /WEB-INF/classes/SendMailServlet.java.

Tomcat に付属している /examples アプリケーションには、 このリソースファクトリを利用しているサンプルがあります。 このアプリケーションには "JSP Examples" リンクからアクセスできます。 実際にメールメッセージを送信しているサーブレットのソースコードは、 /WEB-INF/classes/SendMailServlet.java にあります。

WARNING - The default configuration assumes that there is an SMTP server listing on port 25 on localhost. If this is not the case, edit the $CATALINA_HOME/conf/server.xml file, and modify the parameter value for the mail.smtp.host parameter to be the host name of an SMTP server on your network.

警告 - デフォルトの設定では、localhost の 25 番ポートで SMTP サーバが接続要求を受付けていることを想定しています。 このケースに当てはまらない場合は、$CATALINA_HOME/conf/server.xml ファイルを編集し、mail.smtp.host パラメータの値を実際のネットワークの SMTP サーバのホスト名に修正してください。 listing→listening

0. Introduction

0. はじめに

Many web applications need to access a database via a JDBC driver, to support the functionality required by that application. The J2EE Platform Specification requires J2EE Application Servers to make available a DataSource implementation (that is, a connection pool for JDBC connections) for this purpose. Tomcat 5 offers exactly the same support, so that database-based applications you develop on Tomcat using this service will run unchanged on any J2EE server.

アプリケーションで必要な機能をサポートするために、多くの Web アプリケーションは JDBC ドライバ経由でデータベースにアクセスする必要があります。 そのため、J2EE プラットフォーム仕様では、J2EE アプリケーションサーバは、DataSource 実装 (すなわち JDBC 接続の接続プール) を使えるようにする必要があります。Tomcat 5 はまさしく同様のサポートを提供するので、このサービスを使って Tomcat で開発した、データベースを利用するアプリケーションは、変更なしにどの J2EE サーバでも動かすことができるでしょう。

For information about JDBC, you should consult the following:

JDBC についての情報は、以下を参考にして下さい。

NOTE - The default data source support in Tomcat is based on the DBCP connection pool from the Jakarta Commons subproject. However, it is possible to use any other connection pool that implements javax.sql.DataSource, by writing your own custom resource factory, as described below.

注意 - Tomcat でのデフォルトのデータソースサポートは、 Jakarta Commons サブプロジェクトの DBCP 接続プールに基づいています。 けれども、後ほど 説明するカスタムリソースファクトリを自分で作成することにより、 javax.sql.DataSource を実装する他の接続プールも利用できます。

1. Install Your JDBC Driver

1. JDBC ドライバのインストール

Use of the JDBC Data Sources JNDI Resource Factory requires that you make an appropriate JDBC driver available to both Tomcat internal classes and to your web application. This is most easily accomplished by installing the driver's JAR file(s) into the $CATALINA_HOME/common/lib directory, which makes the driver available both to the resource factory and to your application.

JDBC データソース JNDI リソースファクトリを使うには、 適切な JDBC ドライバを Tomcat 内部クラスと Web アプリケーションの両方で利用可能にする必要があります。 これを実現するには、ドライバの JAR ファイル (複数の場合もあり) を $CATALINA_HOME/common/lib ディレクトリ以下にインストールするのが一番簡単です。そうすればドライバは、 リソースファクトリとアプリケーションの両方から利用可能となります。

2. Declare Your Resource Requirements

2. リソースに必要なものを定義

Next, modify the web application deployment descriptor (/WEB-INF/web.xml) to declare the JNDI name under which you will look up preconfigured data source. By convention, all such names should resolve to the jdbc subcontext (relative to the standard java:comp/env naming context that is the root of all provided resource factories. A typical web.xml entry might look like this:

次に、あらかじめ設定されたデータソースを検索する JNDI 名を定義するために、Web アプリケーション配備記述子 (/WEB-INF/web.xml) を修正します。 慣例に従えば、こうした名前はすべて、jdbc サブコンテキスト (提供されるすべてのリソースファクトリのルートである標準の java:comp/env ネーミングコンテキストの下位)に属すべきです。 典型的な web.xml のエントリは以下のようになるでしょう。

<resource-ref> <description> Resource reference to a factory for java.sql.Connection instances that may be used for talking to a particular database that is configured in the server.xml file. </description> <res-ref-name> jdbc/EmployeeDB </res-ref-name> <res-type> javax.sql.DataSource </res-type> <res-auth> Container </res-auth> </resource-ref> <resource-ref> <description> java.sql.Connection インスタンスのためのファクトリへの リソース参照。server.xml ファイルで設定された、特定の データベースと接続するのに使われます。 </description> <res-ref-name> jdbc/EmployeeDB </res-ref-name> <res-type> javax.sql.DataSource </res-type> <res-auth> Container </res-auth> </resource-ref>

WARNING - Be sure you respect the element ordering that is required by the DTD for web application deployment descriptors! See the Servlet Specification for details.

警告 - 要素の順序が Web アプリケーション配備記述子の DTD で要求されたとおりであることを確認してください! 詳細は、 Servlet 仕様 を参照してください。

3. Code Your Application's Use Of This Resource

3. このリソースを使うコードをアプリケーションに記述

A typical use of this resource reference might look like this:

このリソース環境参照の典型的な使い方は、以下のようになるでしょう。

Context initCtx = new InitialContext(); Context envCtx = (Context) initCtx.lookup("java:comp/env"); DataSource ds = (DataSource) envCtx.lookup("jdbc/EmployeeDB"); Connection conn = ds.getConnection(); ... use this connection to access the database ... conn.close(); Context initCtx = new InitialContext(); Context envCtx = (Context) initCtx.lookup("java:comp/env"); DataSource ds = (DataSource) envCtx.lookup("jdbc/EmployeeDB"); Connection conn = ds.getConnection(); ... データベースアクセスでこの接続を使用 ... conn.close();

Note that the application uses the same resource reference name that was declared in the web application deployment descriptor. This is matched up against the resource factory that is configured in $CATALINA_HOME/conf/server.xml, as described below.

アプリケーションでは、Web アプリケーション配備記述子で定義されたものと同じリソース参照名を使うことに注意してください。 これは、以下で示す $CATALINA_HOME/conf/server.xml で定義されるリソースファクトリと一致してなければなりません。

4. Configure Tomcat's Resource Factory

4. Tomcat のリソースファクトリの設定

To configure Tomcat's resource factory, add an elements like this to the $CATALINA_HOME/conf/server.xml file, nested inside the Context element for this web application (or nested inside a DefaultContext element for the surrounding <Host> or <Engine> element.

Tomcat のリソースファクトリを設定するには、この Web アプリケーションの Context 要素内で入れ子になった (あるいは <Host> または <Engine> 要素内のDefaultContext 要素内で入れ子になった)、 以下のような要素を $CATALINA_HOME/conf/server.xml ファイルに追加します。

<Context ...> ... <Resource name="jdbc/EmployeeDB" auth="Container" type="javax.sql.DataSource"/> <ResourceParams name="jdbc/EmployeeDB"> <parameter> <name>username</name> <value>dbusername</value> </parameter> <parameter> <name>password</name> <value>dbpassword</value> </parameter> <parameter> <name>driverClassName</name> <value>org.hsql.jdbcDriver</value> </parameter> <parameter> <name>url</name> <value>jdbc:HypersonicSQL:database</value> </parameter> <parameter> <name>maxActive</name> <value>8</value> </parameter> <parameter> <name>maxIdle</name> <value>4</value> </parameter> </ResourceParams> ... </Context>

Note that the resource name (here, jdbc/EmployeeDB) must match the value specified in the web application deployment descriptor.

リソース名 (ここでは jdbc/EmployeeDB) が Web アプリケーション配備記述子で指定した値と一致していなければならないことに注意してください。

This example assumes that you are using the HypersonicSQL database JDBC driver. Customize the driverClassName and driverName parameters to match your actual database's JDBC driver and connection URL.

この例では、HypersonicSQL データベースの JDBC ドライバを使用していると仮定しています。 driverClassName と driverName パラメータをそれぞれ実際に使用するデータベースの JDBC ドライバと接続 URL に合わせてカスタマイズしてください。

The configuration properties for Tomcat's standard data source resource factory (org.apache.naming.factory.DbcpDataSourceFactory) are as follows:

Tomcat の標準データソースリソースファクトリ (org.apache.naming.factory.DbcpDataSourceFactory) の設定プロパティは、以下のようになります。

  • driverClassName - Fully qualified Java class name of the JDBC driver to be used.
  • maxActive - The maximum number of active instances that can be allocated from this pool at the same time.
  • maxIdle - The maximum number of connections that can sit idle in this pool at the same time.
  • maxWait - The maximum number of milliseconds that the pool will wait (when there are no available connections) for a connection to be returned before throwing an exception.
  • password - Database password to be passed to our JDBC driver.
  • url - Connection URL to be passed to our JDBC driver. (For backwards compatibility, the property driverName is also recognized.)
  • user - Database username to be passed to our JDBC driver.
  • validationQuery - SQL query that can be used by the pool to validate connections before they are returned to the application. If specified, this query MUST be an SQL SELECT statement that returns at least one row.
  • driverClassName - 使用される JDBC ドライバの完全修飾 Java クラス名。
  • maxActive - プールから同時に割り当てられるアクティブインスタンスの最大数。
  • maxIdle - プール内で同時にアイドルにしておける接続の最大数。
  • maxWait - プールが例外を投げるまでに、 (利用可能な接続がない場合に) 接続を返されるのを待つ最大ミリ秒。
  • password - JDBC ドライバに渡されるデータベースのパスワード。
  • url - JDBC ドライバに渡される接続 URL。 (下位互換性のために、driverName プロパティも認識します。)
  • user - JDBC ドライバに渡されるデータベースのユーザ名。
  • validationQuery - アプリケーションに返される前に、 接続が有効かどうか確認するのに、プールが使用する SQL クエリ。 指定されている場合、このクエリは少なくとも 1 行を返す SQL SELECT 文でなければなりません。

If none of the standard resource factories meet your needs, you can write your own factory and integrate it into Tomcat 5, and then configure the use of this factory in the conf/server.xml configuration file. In the example below, we will create a factory that only knows how to create com.mycompany.MyBean beans, from the Generic JavaBean Resources example, above.

もし標準リソースファクトリに要件を満たすものがなければ、 独自のファクトリを実装し Tomcat 5 に組み込み、conf/server.xml 設定ファイルでそのファクトリの利用方法を設定できます。 以下の例においては、前述の 汎用 JavaBean リソースの例から、com.mycompany.MyBean Bean の作り方だけを知っているファクトリを作成します。

1. Write A Resource Factory Class

1. リソースファクトリクラスの実装

You must write a class that implements the JNDI service provider javax.naming.spi.ObjectFactory inteface. Every time your web application calls lookup() on a context entry that is bound to this factory, the getObjectInstance() method is called, with the following arguments:

JNDI サービスプロバイダである javax.naming.spi.ObjectFactory インタフェースを実装するクラスを作成しなければいけません。 Web アプリケーションがこのファクトリと紐づいたコンテキストエントリへの lookup() を呼出すたびに、以下の引数で getObjectInstance() メソッドが呼出されます。

  • Object obj - The (possibly null) object containing location or reference information that can be used in creating an object. For Tomcat, this will always be an object of type javax.naming.Reference, which contains the class name of this factory class, as well as the configuration properties (from conf/server.xml) to use in creating objects to be returned.
  • Name name - The name to which this factory is bound relative to nameCtx, or null if no name is specified.
  • Context nameCtx - The context relative to which the name parameter is specified, or null if name is relative to the default initial context.
  • Hashtable environment - The (possibly null) environment that is used in creating this object. This is generally ignored in Tomcat object factories.
  • Object obj - オブジェクト作成時に使われる、 場所および参照の情報を含むオブジェクト (null の可能性あり)。 Tomcat では、これは常に javax.naming.Reference 型のオブジェクトで、このファクトリクラスのクラス名や、 返値のオブジェクトを作成するのに使う (conf/server.xml からの) 設定プロパティが含まれています。
  • Name name - このファクトリが紐づく名前で、 nameCtx をベースとします。 名前を指定しないときは null。
  • Context nameCtx - 指定された name パラメータのベースとなるコンテキスト。name がデフォルトの初期コンテキストをベースとする場合は null。
  • Hashtable environment - このオブジェクトを作成するのに使われる環境 (null の可能性あり)。 Tomcat オブジェクトファクトリでは通常は無視される。

To create a resource factory that knows how to produce MyBean instances, you might create a class like this:

MyBean インスタンスの生成方法を知るリソースファクトリを作成するには、 以下のようなクラスを作ればいいでしょう。

package com.mycompany; import java.util.Enumeration; import java.util.Hashtable; import javax.naming.Context; import javax.naming.Name; import javax.naming.NamingException; import javax.naming.RefAddr; import javax.naming.Reference; import javax.naming.spi.ObjectFactory; public class MyBeanFactory implements ObjectFactory { public Object getObjectInstance(Object obj, Name name, Context nameCtx, Hashtable environment) throws NamingException { // Acquire an instance of our specified bean class MyBean bean = new MyBean(); // Customize the bean properties from our attributes Reference ref = (Reference) obj; Enumeration addrs = ref.getAll(); while (addrs.hasMoreElements()) { RefAddr addr = (RefAddr) addrs.nextElement(); String name = addr.getType(); String value = (String) addr.getContent(); if (name.equals("foo")) { bean.setFoo(value); } else if (name.equals("bar")) { try { bean.setBar(Integer.parseInt(value)); } catch (NumberFormatException e) { throw new NamingException("Invalid 'bar' value " + value); } } } // Return the customized instance return (bean); } } package com.mycompany; import java.util.Enumeration; import java.util.Hashtable; import javax.naming.Context; import javax.naming.Name; import javax.naming.NamingException; import javax.naming.RefAddr; import javax.naming.Reference; import javax.naming.spi.ObjectFactory; public class MyBeanFactory implements ObjectFactory { public Object getObjectInstance(Object obj, Name name, Context nameCtx, Hashtable environment) throws NamingException { // 指定の bean クラスのインスタンスを取得 MyBean bean = new MyBean(); // 属性にしたがい bean のプロパティをカスタマイズ Reference ref = (Reference) obj; Enumeration addrs = ref.getAll(); while (addrs.hasMoreElements()) { RefAddr addr = (RefAddr) addrs.nextElement(); String name = addr.getType(); String value = (String) addr.getContent(); if (name.equals("foo")) { bean.setFoo(value); } else if (name.equals("bar")) { try { bean.setBar(Integer.parseInt(value)); } catch (NumberFormatException e) { throw new NamingException("Invalid 'bar' value " + value); } } } // カスタマイズしたインスタンスを返す return (bean); } }

In this example, we are unconditionally creating a new instance of the com.mycompany.MyBean class, and populating its properties based on the parameters included in the <ResourceParams> element that configures this factory (see below). You should note that any parameter named factory should be skipped - that parameter is used to specify the name of the factory class itself (in this case, com.mycompany.MyBeanFactory) rather than a property of the bean being configured.

この例では、無条件に com.mycompany.MyBean クラスの新しいインスタンスを作成し、このファクトリを設定する <ResourceParams> 要素 (以下を参照) に含まれているパラメータに基づいてプロパティに設定を行います。 factory という名前のパラメータはすべてスキップされることに注意して下さい。 このパラメータは、bean に設定されるパラメータではなく、 ファクトリクラスそのものの名前 (この場合は com.mycompany.MyBeanFactory) を指定するのに使います。

For more information about ObjectFactory, see the JNDI 1.2 Service Provider Interface (SPI) Specification.

ObjectFactory に関するより詳しい情報は、 JNDI 1.2 Service Provider Interface (SPI) 仕様 を参照してください。

You will need to compile this class against a class path that includes all of the JAR files in the $CATALINA_HOME/common/lib and $CATALINA_HOME/server/lib directories. When you are through, place the factory class (and the corresponding bean class) unpacked under $CATALINA_HOME/common/classes, or in a JAR file inside $CATALINA_HOME/common/lib. In this way, the required class files are visible to both Catalina internal resources and your web application.

このクラスをコンパイルするには、クラスパスに $CATALINA_HOME/common/lib と $CATALINA_HOME/server/lib ディレクトリ内のすべての JAR ファイルが含まれている必要があります。それが完了している場合は、 ファクトリクラス (と対応する bean クラス) を展開した状態で $CATALINA_HOME/common/classes 以下に置くか、もしくは JAR ファイルとして $CATALINA_HOME/common/lib 内に置いてください。 こうすれば、必要なクラスファイルが Catalina 内部リソースと Web アプリケーションの両方から見えるようになります。

2. Declare Your Resource Requirements

2. リソースに必要なものを定義

Next, modify your web application deployment descriptor (/WEB-INF/web.xml) to declare the JNDI name under which you will request new instances of this bean. The simplest approach is to use a <resource-env-ref> element, like this:

次に、この bean の新しいインスタンスをリクエストする JNDI 名を定義するために Web アプリケーション配備記述子 (/WEB-INF/web.xml) を修正します。 一番簡単なのは以下のように <resource-env-ref> 要素を使う方法です。

<resource-env-ref> <description> Object factory for MyBean instances. </description> <resource-env-ref-name> bean/MyBeanFactory </resource-env-ref-name> <resource-env-ref-type> com.mycompany.MyBean </resource-env-ref-type> <resource-env-ref> <resource-env-ref> <description> MyBean インスタンスのためのオブジェクトファクトリ。 </description> <resource-env-ref-name> bean/MyBeanFactory </resource-env-ref-name> <resource-env-ref-type> com.mycompany.MyBean </resource-env-ref-type> <resource-env-ref>

WARNING - Be sure you respect the element ordering that is required by the DTD for web application deployment descriptors! See the Servlet Specification for details.

警告 - 要素の順序が Web アプリケーション配備記述子の DTD で要求されたとおりであることを確認してください! 詳細は、 Servlet 仕様 を参照してください。

3. Code Your Application's Use Of This Resource

3. このリソースを使うコードをアプリケーションに記述

A typical use of this resource environment reference might look like this:

このリソース環境参照の典型的な使い方は、以下のようになるでしょう。

Context initCtx = new InitialContext(); Context envCtx = (Context) initCtx.lookup("java:comp/env"); MyBean bean = (MyBean) envCtx.lookup("bean/MyBeanFactory"); writer.println("foo = " + bean.getFoo() + ", bar = " + bean.getBar());

4. Configure Tomcat's Resource Factory

4. Tomcat でのリソースファクトリの定義

To configure Tomcat's resource factory, add an elements like this to the $CATALINA_HOME/conf/server.xml file, nested inside the Context element for this web application (or nested inside a DefaultContext element for the surrounding <Host> or <Engine> element.

Tomcat のリソースファクトリを設定するには、この Web アプリケーションの Context 要素内で入れ子になった (あるいは <Host> または <Engine> 要素内の DefaultContext 要素内で入れ子になった)、 以下のような要素を $CATALINA_HOME/conf/server.xml ファイルに追加します。

<Context ...> ... <Resource name="bean/MyBeanFactory" auth="Container" type="com.mycompany.MyBean"/> <ResourceParams name="bean/MyBeanFactory"> <parameter> <name>factory</name> <value>com.mycompany.MyBeanFactory</value> </parameter> <parameter> <name>bar</name> <value>23</value> </parameter> </ResourceParams> ... </Context>

Note that the resource name (here, bean/MyBeanFactory must match the value specified in the web application deployment descriptor. We are also initializing the value of the bar property, which will cause setBar(23) to be called before the new bean is returned. Because we are not initializing the foo property (although we could have), the bean will contain whatever default value is set up by its constructor.

リソース名 (ここでは bean/MyBeanFactory) が Web アプリケーション配備記述子で指定した値と一致していなければならないことに注意してください。 また、bar プロパティの値の初期化も行っており、それにより 新しい bean が返される前に setBar(23) が呼び出されます。 foo プロパティは (初期化可能でしたが) 初期化していないので、 bean ではコンストラクタでセットアップする何らかのデフォルト値が入ることでしょう。

You will also note that, from the application developer's perspective, the declaration of the resource environment reference, and the programming used to request new instances, is identical to the approach used for the Generic JavaBean Resources example. This illustrates one of the advantages of using JNDI resources to encapsulate functionality - you can change the underlying implementation without necessarily having to modify applications using the resources, as long as you maintain compatible APIs.

また、アプリケーション開発者としての観点で言えば、リソース環境参照の定義や、 新しいインスタンスを要求するのに使われているプログラミングは、 汎用 JavaBean リソース の例で使われている方法と同じであることにも注意して下さい。 これは、機能性をカプセル化するために JNDI リソースを使う利点の一つを具体的に示しています。 つまり 互換性のある API を維持している限り、 リソースを使ってアプリケーションを修正しなくても、 内部の実装を変更できます。