| Oracle® Fusion Middleware Oracle WebLogic Server 12.1.3 RESTful Webサービスの開発と保護 12c (12.1.3) E57546-02 |
|
 前 |
 次 |
| Oracle® Fusion Middleware Oracle WebLogic Server 12.1.3 RESTful Webサービスの開発と保護 12c (12.1.3) E57546-02 |
|
前 |
次 |
この章では、Jersey 1.18 Java API for RESTful Web Services (JAX-RS) 1.1参照実装(RI)を使用して、Representational State Transfer (REST)アーキテクチャ・スタイルに従ったWebLogic Server 12.1.3内のJava EE Webサービスをパッケージ化およびデプロイする方法について説明します。
Apache Ant、Mavenなどのコンパイル・ツールやOracle JDeveloperなどの好みのIDEを使用して、RESTful Webサービス・アプリケーションおよびクライアント・アプリケーションを構築します。詳細は、『Oracle WebLogic Serverアプリケーションの開発』の「WebLogic Serverアプリケーション開発の概要」を参照してください。JDeveloperの詳細は、『Oracle JDeveloperによるアプリケーションの開発』の「Javaプロジェクトのビルド」を参照してください。
すべてのRESTful Webサービス・アプリケーションはWebアプリケーションの一部としてパッケージ化される必要があります。WebサービスがEJBとして実装される場合、WAR内にパッケージ化およびデプロイされる必要があります。
表5-1に、RESTful Webサービス・アプリケーションに使用できる特定のパッケージ化オプションの概要を示します。
表5-1 RESTful Webサービス・アプリケーションのパッケージ化オプション
| パッケージ化オプション | 説明 |
|---|---|
|
アプリケーション・サブクラス |
詳細は、「アプリケーション・サブクラスとのパッケージ化」を参照してください。 |
|
サーブレット |
|
|
デフォルト・リソース |
前述のオプションのいずれかを使用して、構成内にサーブレットのコンテキスト・パスを構成しない場合、WebLogic ServerによってデフォルトのRESTful Webサービス・アプリケーション・サーブレットのコンテキスト・パス |
このパッケージ化シナリオでは、javax.ws.rs.core.Applicationを拡張するクラスを作成して、RESTful Webサービス・アプリケーション・デプロイメントのコンポーネントを定義し、追加のメタデータを提供します。詳細は、Java Platform, Enterprise Edition API仕様Javadocのjavax.ws.rs.core.Applicationを参照してください。
Applicationサブクラス内で、必要に応じて、getClasses()およびgetSingletons()メソッドをオーバーライドし、RESTful Webサービス・リソースのリストを戻します。リソースはそれを戻すApplicationサブクラスにバインドされます。
両方のメソッドが同じリソースを戻す場合、エラーが戻されることに注意してください。
javax.ws.rs.ApplicationPathアノテーションを使用して、サーブレットにマップされる基底URIパターンを定義します。この情報がリソースの基底URIで使用される方法の詳細は、「実行時の処理: 基底URIの構成方法」を参照してください。詳細は、Java Platform, Enterprise Edition 6 API仕様Javadocの@ApplicationPathアノテーションを参照してください。
単純なデプロイメントの場合、web.xmlデプロイメント記述子は必要ありません。より複雑なデプロイメントの場合、たとえばWebサービスの保護や初期化パラメータの指定の際は、「Jersey 1.18 (JAX-RS 1.1 RI)を使用したサーブレットとのパッケージ化」の説明に従って、web.xmlデプロイメント記述子をアプリケーションとパッケージ化できます。
例5-1に、javax.ws.rs.core.Applicationを拡張し、@ApplicationPathアノテーションを使用してリソースの基底URIを定義するクラスの例を示します。
例5-1 javax.ws.rs.core.Applicationを拡張するクラスの例
import javax.ws.rs.core.Application;
javax.ws.rs.ApplicationPath;
...
@ApplicationPath("resources")
public class MyApplication extends Application {
public Set<Class<?>> getClasses() {
Set<Class<?>> s = new HashSet<Class<?>>();
s.add(HelloWorldResource.class);
return s;
}
}
あるいは、次のAPIのいずれかを使用して、指定されたクラスパスまたは一連のパッケージ名がないかルート・リソースおよびプロバイダ・クラスをスキャンします。
com.sun.jersey.api.core.PackagesResourceConfig (『Jersey 1.18 User Guide』の「Deploying a RESTful Web Service」を参照)
|
注意: com.sun.jerseyパッケージ、ネストされたパッケージおよびweblogic.jaxrs.api.clientパッケージのサポートは、WebLogic Serverのこのリリースでは非推奨となっています。Jersey 2.5.1 (JAX-RS 2.0 RI)APIを使用するように、RESTfulアプリケーションを早急にアップデートすることをお薦めします。 |
org.glassfish.jersey.server.ResourceConfig (『Jersey 2.5.1 User Guide』の「JAX-RS Application Model」を参照)
|
注意: com.sun.jerseyパッケージ、ネストされたパッケージおよびweblogic.jaxrs.api.clientパッケージのサポートは、WebLogic Serverのこのリリースでは非推奨となっています。Jersey 2.5.1 (JAX-RS 2.0 RI)APIを使用するように、RESTfulアプリケーションを早急にアップデートすることをお薦めします。 |
次の各項では、Webアプリケーションが使用しているサーブレットが3.0かそれより前かに基づき、web.xmlデプロイメント記述子を使用して、Jersey 1.18 (JAX-RS 1.1 RI)を使用して構築されたRESTful Webサービス・アプリケーションをサーブレットとパッケージ化する方法について説明します。
web.xmlファイルは、アプリケーション・アーカイブのルート・ディレクトリのWEB-INFディレクトリにあります。web.xmlデプロイメント記述子の詳細は、Oracle WebLogic ServerのためのWebアプリケーション、サーブレットおよびJSPの開発のweb.xmlデプロイメント記述子の要素に関する項を参照してください。
RESTful Webサービス・アプリケーションをサーブレット3.0とパッケージ化するには、web.xmlデプロイメント記述子を更新し、次の項に定義された要素を定義します。要素は、javax.ws.rs.core.Applicationを拡張するクラスをパッケージに含めるかどうかで変わります。
アプリケーション・サブクラスのあるweb.xmlを使用したRESTful Webサービス・アプリケーションのパッケージ化
アプリケーション・サブクラスのないweb.xmlを使用したRESTful Webサービス・アプリケーションのパッケージ化
要素の詳細は、『Oracle WebLogic Server Webアプリケーション、サーブレット、JSPの開発』のサーブレットに関する項を参照してください。
javax.ws.rs.core.Applicationを拡張するクラスがweb.xmlとともにパッケージ化されている場合、要素を表5-2に示すように定義します。たとえば、例5-1を参照してください。
表5-2 アプリケーション・サブクラスのあるweb.xmlを使用したRESTful Webサービス・アプリケーションのパッケージ化
| 要素 | 説明 |
|---|---|
|
|
この要素を、 |
|
|
必要ありません。 |
|
|
必要ありません。 |
|
|
サーブレットにマップされる基底URIパターンとして設定します。 指定されない場合、次の優先順位に従って、次の値のいずれかが使用されます。
この情報がリソースの基底URIで使用される方法の詳細は、「実行時の処理: 基底URIの構成方法」を参照してください。 |
次に、javax.ws.rs.core.Applicationを拡張するクラスがweb.xmlとパッケージ化される場合に、web.xmlファイルを更新する方法の例を示します。
javax.ws.rs.core.Applicationを拡張するクラスがweb.xmlとともにパッケージ化されていない場合は、表5-3に示すように要素を定義します。
|
注意: このシナリオでは、複数のRESTful Webサービス・アプリケーションはサポートされません。 |
表5-3 アプリケーション・サブクラスのないweb.xmlを使用したRESTful Webサービス・アプリケーションのパッケージ化
| 要素 | 説明 |
|---|---|
|
|
この要素を対象のサーブレット名に設定します。 |
|
|
この要素を、すべてのWebリクエストをJerseyサーブレットに委任するように、次のいずれかのクラスに設定します。
|
|
|
必要ありません。 |
|
|
サーブレットにマップされる基底URIパターンとして設定します。指定しない場合、この値のデフォルトは この情報がリソースの基底URIで使用される方法の詳細は、「実行時の処理: 基底URIの構成方法」を参照してください。 |
次に、javax.ws.rs.core.Applicationを拡張するクラスがweb.xmlとパッケージ化されない場合、web.xmlファイルを更新する方法の例を示します。
例5-3 アプリケーション・サブクラスがパッケージ内にない場合のサーブレット3.0用web.xmlの更新
<web-app>
<servlet>
<servlet-name>Jersey Web Application</servlet-name>
<servlet-class>com.sun.jersey.spi.container.servlet.ServletContainer</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>Jersey Web Application</servlet-name>
<url-pattern>/*</url-pattern>
</servlet-mapping>
</web-app>
表5-4に、RESTful Webサービス・アプリケーションを3.0より前のサーブレットとパッケージ化するために、web.xmlデプロイメント記述子で更新する要素を示します。
表5-4 RESTful Webサービス・アプリケーションの3.0以前のサーブレットとのパッケージ化
| 要素 | 説明 |
|---|---|
|
|
この要素を対象のサーブレット名に設定します。 |
|
|
この要素を、すべてのWebリクエストをJerseyサーブレットに委任するように、次のいずれかのクラスに設定します。
|
|
|
この要素を、
<init-param>
<param-name>
javax.ws.rs.Application
</param-name>
<param-value>
ApplicationSubclassName
</param-value>
</init-param>
また、次のようにアプリケーション内でパッケージを宣言することもできます。
<init-param>
<param-name>
com.sun.jersey.config.property.packages
</param-name>
<param-value>
project1
</param-value>
</init-param>
|
|
|
サーブレットにマップされる基底URIパターンとして設定します。 指定されない場合、次の優先順位に従って、次の値のいずれかが使用されます。
この情報がリソースの基底URIで使用される方法の詳細は、「実行時の処理: 基底URIの構成方法」を参照してください。 |
次に、javax.ws.rs.core.Applicationを拡張するクラスがweb.xmlとパッケージ化されない場合、web.xmlファイルを更新する方法の例を示します。
例5-4 3.0以前のサーブレット用web.xmlの更新
<web-app>
<servlet>
<servlet-name>Jersey Web Application</servlet-name>
<servlet-class>weblogic.jaxrs.server.portable.servlet.ServletContainer</servlet-class>
<init-param>
<param-name>com.sun.jersey.config.property.resourceConfigClass</param-name>
<param-value>com.sun.jersey.api.core.PackagesResourceConfig</param-value>
</init-param>
<init-param>
<param-name>com.sun.jersey.config.property.packages</param-name>
<param-value>org.foo.rest;org.bar.rest</param-value>
</init-param>
...
</servlet>
...
</web-app>
次の各項では、Webアプリケーションが使用しているサーブレットが3.0かそれより前かに基づき、web.xmlデプロイメント記述子を使用して、Jersey 2.5.1 (JAX-RS 2.0 RI)を使用して構築されたRESTful Webサービス・アプリケーションをサーブレットとパッケージ化する方法について説明します。
web.xmlファイルは、アプリケーション・アーカイブのルート・ディレクトリのWEB-INFディレクトリにあります。web.xmlデプロイメント記述子の詳細は、Oracle WebLogic ServerのためのWebアプリケーション、サーブレットおよびJSPの開発のweb.xmlデプロイメント記述子の要素に関する項を参照してください。
RESTful Webサービス・アプリケーションをサーブレット3.0とパッケージ化するには、web.xmlデプロイメント記述子を更新し、次の項に定義された要素を定義します。要素は、javax.ws.rs.core.Applicationを拡張するクラスをパッケージに含めるかどうかで変わります。
アプリケーション・サブクラスのあるweb.xmlを使用したRESTful Webサービス・アプリケーションのパッケージ化
アプリケーション・サブクラスのないweb.xmlを使用したRESTful Webサービス・アプリケーションのパッケージ化
要素の詳細は、『Oracle WebLogic Server Webアプリケーション、サーブレット、JSPの開発』のサーブレットに関する項を参照してください。
javax.ws.rs.core.Applicationを拡張するクラスがweb.xmlとともにパッケージ化されている場合、表5-5に示すように要素を定義します。例については、例5-5を参照してください。
表5-5 アプリケーション・サブクラスのあるweb.xmlを使用したRESTful Webサービス・アプリケーションのパッケージ化
| 要素 | 説明 |
|---|---|
|
|
この要素を、 |
|
|
必要ありません。 |
|
|
必要ありません。 |
|
|
サーブレットにマップされる基底URIパターンとして設定します。 指定されない場合、次の優先順位に従って、次の値のいずれかが使用されます。
この情報がリソースの基底URIで使用される方法の詳細は、「実行時の処理: 基底URIの構成方法」を参照してください。 |
次に、javax.ws.rs.core.Applicationを拡張するクラスがweb.xmlとパッケージ化される場合に、web.xmlファイルを更新する方法の例を示します。
javax.ws.rs.core.Applicationを拡張するクラスがweb.xmlとともにパッケージ化されていない場合は、表5-3に示すように要素を定義します。
|
注意: このシナリオでは、複数のRESTful Webサービス・アプリケーションはサポートされません。 |
表5-6 アプリケーション・サブクラスのないweb.xmlを使用したRESTful Webサービス・アプリケーションのパッケージ化
| 要素 | 説明 |
|---|---|
|
|
この要素を対象のサーブレット名に設定します。 |
|
|
この要素を、すべてのWebリクエストをJerseyサーブレットに委任するように、 |
|
|
必要ありません。 |
|
|
サーブレットにマップされる基底URIパターンとして設定します。指定しない場合、この値のデフォルトは この情報がリソースの基底URIで使用される方法の詳細は、「実行時の処理: 基底URIの構成方法」を参照してください。 |
次に、javax.ws.rs.core.Applicationを拡張するクラスがweb.xmlとパッケージ化されない場合、web.xmlファイルを更新する方法の例を示します。
例5-6 アプリケーション・サブクラスがパッケージ内にない場合のサーブレット3.0用web.xmlの更新
<web-app>
<servlet>
<servlet-name>Jersey Web Application</servlet-name>
<servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>Jersey Web Application</servlet-name>
<url-pattern>/*</url-pattern>
</servlet-mapping>
</web-app>
表5-7に、RESTful Webサービス・アプリケーションを3.0より前のサーブレットとパッケージ化するために、web.xmlデプロイメント記述子で更新する要素を示します。
表5-7 RESTful Webサービス・アプリケーションの3.0以前のサーブレットとのパッケージ化
| 要素 | 説明 |
|---|---|
|
|
この要素を対象のサーブレット名に設定します。 |
|
|
この要素を、すべてのWebリクエストをJerseyサーブレットに委任するように、 |
|
|
この要素を、
<init-param>
<param-name>
javax.ws.rs.Application
</param-name>
<param-value>
ApplicationSubclassName
</param-value>
</init-param>
あるいは、次のようにして、リソースおよびプロバイダをスキャンするパッケージを指定できます。
<init-param>
<param-name>
jersey.config.server.provider.packages
</param-name>
<param-value>
project1
</param-value>
</init-param>
<init-param>
<param-name>
jersey.config.server.provider.scanning.recursive
</param-name>
<param-value>
false
</param-value>
</init-param>
|
|
|
サーブレットにマップされる基底URIパターンとして設定します。 指定されない場合、次の優先順位に従って、次の値のいずれかが使用されます。
この情報がリソースの基底URIで使用される方法の詳細は、「実行時の処理: 基底URIの構成方法」を参照してください。 |
次に、javax.ws.rs.core.Applicationを拡張するクラスがweb.xmlとパッケージ化されない場合、web.xmlファイルを更新する方法の例を示します。
例5-7 3.0以前のサーブレット用web.xmlの更新
<web-app>
<servlet>
<servlet-name>Jersey Web Application</servlet-name>
<servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>
<init-param>
<param-name>jersey.config.server.provider.packages</param-name>
<param-value>org.foo.myresources,org.bar.otherresources</param-value>
</init-param>
<init-param>
<param-name>jersey.config.server.provider.scanning.recursive</param-name>
<param-value>false</param-value>
</init-param>
...
</servlet>
...
</web-app>
デフォルトでは、WebLogic ServerによってデフォルトのRESTful Webサービス・アプリケーションのコンテキスト・パスresourcesが定義されます。デフォルトのRESTful Webサービス・アプリケーションのコンテキスト・パスは、次に該当する場合に使用されます。
サーブレットのマッピングを含むようにweb.xmlデプロイメント記述子を更新しなかった(「Jersey 1.18 (JAX-RS 1.1 RI)を使用したサーブレットとのパッケージ化」を参照)。
@ApplicationPathアノテーションがjavax.ws.rs.core.Applicationサブクラスで定義されなかった(「アプリケーション・サブクラスとのパッケージ化」を参照)。
|
注意: サーブレットがすでにデフォルトのコンテキスト・パスに登録されている場合、警告が発行されます。 |
たとえば、RESTful Webサービス・アプリケーションのルート・リソース・クラスの相対URIが@Path('/helloworld')と定義され、デフォルトのRESTful Webサービス・アプリケーションのコンテキスト・パスが使用されている場合、RESTful Webサービス・アプリケーションのリソースは次のURIで入手できます。
http://<host>:<port>/<contextPath>/resources/helloworld
Webアプリケーションのデプロイの詳細は、『Oracle WebLogic Serverへのアプリケーションのデプロイ』の「WebLogic Serverデプロイメントの理解」を参照してください。
