| Oracle Fusion Middleware Oracle WebLogic Server RESTful Webサービスの開発 12cリリース1 (12.1.1) B65960-02 |
|
 前 |
 次 |
この章では、Java API for RESTful Web Services (JAX-RS)を使用して、Representational State Transfer (REST)アーキテクチャ・スタイルに従ったWebLogic Webサービスをパッケージ化およびデプロイする方法について説明します。
この章では、以下のトピックについて説明します。
すべてのRESTful Webサービス・アプリケーションはWebアプリケーションの一部としてパッケージ化される必要があります。WebサービスがEJBとして実装される場合、WAR内にパッケージ化およびデプロイされる必要があります。Webアプリケーションのデプロイの詳細は、『Oracle WebLogic Serverへのアプリケーションのデプロイ』のWebLogic Serverデプロイメントに関する項を参照してください。
表3-1に、RESTful Webサービス・アプリケーションに使用できる特定のパッケージ化オプションの概要を示します。
表3-1 RESTful Webサービス・アプリケーションのパッケージ化オプション
| パッケージ化オプション | 説明 |
|---|---|
|
アプリケーション・サブクラス |
|
|
サーブレット |
|
|
デフォルト・リソース |
上記のオプションのいずれかを使用して、構成内にサーブレットのコンテキスト・パスを構成しない場合、WebLogic ServerはデフォルトのRESTful Webサービス・アプリケーション・サーブレットのコンテキスト・パス |
このパッケージ化シナリオでは、javax.ws.rs.core.Applicationを拡張するクラスを作成して、RESTful Webサービス・アプリケーション・デプロイメントのコンポーネントを定義し、追加のメタデータを提供します。javax.ws.rs.core.Applicationの詳細は、Javadoc(http://download.oracle.com/javaee/6/api/javax/ws/rs/core/Application.html)を参照してください。
Applicationサブクラス内で、必要に応じて、getClasses()およびgetSingletons()メソッドをオーバーライドし、RESTful Webサービス・リソースのリストを戻します。リソースはそれを戻すApplicationサブクラスにバインドされます。
両方のメソッドが同じリソースを戻す場合、エラーが返ることに注意してください。
javax.ws.rs.ApplicationPathアノテーションを使用して、サーブレットにマップされる基底URIパターンを定義します。この情報がリソースの基底URIで使用される方法の詳細は、「実行時の処理: 基底URIの構成方法」を参照してください。@ApplicationPathアノテーションの詳細は、Javadoc (http://download.oracle.com/javaee/6/api/javax/ws/rs/ApplicationPath.html)を参照してください。
単純なデプロイメントの場合、web.xmlデプロイメント記述子は必要ありません。より複雑なデプロイメントの場合、たとえばWebサービスの保護や初期化パラメータの指定の際は、「サーブレットとのパッケージ化」に示すように、web.xmlデプロイメント記述子をアプリケーションでパッケージ化できます。
例3-1に、javax.ws.rs.core.Applicationを拡張し、@ApplicationPathアノテーションを使用してリソースの基底URIを定義するクラスの例を示します。
例3-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;
}
}
次の項では、Webアプリケーションがサーブレット3.0またはそれ以前を使用しているかどうかに基づき、web.xmlデプロイメント記述子を使用して、RESTful Webサービス・アプリケーションのサーブレットとのパッケージ化の方法について説明します。
web.xmlファイルは、アプリケーション・アーカイブのルート・ディレクトリのWEB-INFディレクトリにあります。web.xmlデプロイメント記述子の詳細は、『Oracle WebLogic ServerのためのWebアプリケーション、サーブレットおよびJSPの開発』のweb.xmlデプロイメント記述子の要素に関する項を参照してください。
|
注意: 3.0以前のサーブレットを使用するWebアプリケーションを実行している場合、「サーブレットとのパッケージ化」を参照してください。この項は、サーブレット3.0を実行しているWebアプリケーションにのみ適用されます。 |
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とともにパッケージ化されている場合、要素を表3-2に示すように定義します。たとえば、例3-1を参照してください。
表3-2 アプリケーション・サブクラスのあるweb.xmlを使用したRESTful Webサービス・アプリケーションのパッケージ化
| 要素 | 設定方法 |
|---|---|
|
|
この要素を、 |
|
|
必要ありません。 |
|
|
この要素を、
<init-param>
<param-name>
javax.ws.rs.Application
</param-name>
<param-value>
ApplicationSubclassName
</param-value>
</init-param>
|
|
|
サーブレットにマップされる基底URIパターンとして設定します。 指定されない場合、次の優先順位に従って、次の値のいずれかが使用されます。
この情報がリソースの基底URIで使用される方法の詳細は、「実行時の処理: 基底URIの構成方法」を参照してください。 |
次に、javax.ws.rs.core.Applicationを拡張するクラスがweb.xmlとパッケージ化される場合に、web.xmlファイルを更新する方法の例を示します。
例3-2 アプリケーション・サブクラスがパッケージ内にある場合のサーブレット3.0用web.xmlの更新
<web-app>
<servlet>
<display-name>My JAX-RS Servlet</display-name>
<servlet-name>jersey.samples.MyApplication</servlet-name>
<init-param>
<param-name>javax.ws.rs.Application</param-name>
<param-value>myPackage.myJaxRsApplication</param-value>
</init-param>
</servlet>
<servlet-mapping>
<servlet-name>MyJaxRsApp</servlet-name>
<url-pattern>/*</url-pattern>
</servlet-mapping>
</web-app>
javax.ws.rs.core.Applicationを拡張するクラスがweb.xmlとともにパッケージ化されていない場合、要素を表3-3に示すように定義します。
|
注意: このシナリオでは、複数のRESTful Webサービス・アプリケーションはサポートされません。 |
表3-3 アプリケーション・サブクラスのないweb.xmlを使用したRESTful Webサービス・アプリケーションのパッケージ化
| 要素 | 説明 |
|---|---|
|
|
この要素を対象のサーブレット名に設定します。 |
|
|
この要素を、すべてのWebリクエストをJerseyサーブレットに委任するように、次のいずれかのクラスに設定します。
|
|
|
この要素を、
<init-param>
<param-name>
javax.ws.rs.Application
</param-name>
<param-value>
ApplicationSubclassName
</param-value>
</init-param>
|
|
|
サーブレットにマップされる基底URIパターンとして設定します。指定しない場合、この値のデフォルトは この情報がリソースの基底URIで使用される方法の詳細は、「実行時の処理: 基底URIの構成方法」を参照してください。 |
次に、javax.ws.rs.core.Applicationを拡張するクラスがweb.xmlとパッケージ化されない場合、web.xmlファイルを更新する方法の例を示します。
例3-3 アプリケーション・サブクラスがパッケージ内にない場合のサーブレット3.0用web.xmlの更新
<web-app>
<servlet>
<servlet-name>RestServlet</servlet-name>
<servlet-class>com.sun.jersey.spi.container.servlet.ServletContainer</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>RestServlet</servlet-name>
<url-pattern>/*</url-pattern>
</servlet-mapping>
</web-app>
表3-4に、RESTful Webサービス・アプリケーションを3.0以前のサーブレットとパッケージ化するために、web.xmlデプロイメント記述子で更新する要素を示します。
表3-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ファイルを更新する方法の例を示します。
例3-4 3.0以前のサーブレット用web.xmlの更新
<web-app>
<servlet>
<display-name>My JAX-RS Servlet</display-name>
<servlet-name>javax.ws.rs.core.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>project1</param-value>
</init-param>
</servlet>
</web-app>
デフォルトでは、WebLogic ServerはデフォルトのRESTful Webサービス・アプリケーションのコンテキスト・パスresourcesを定義します。デフォルトRESTful Webサービス・アプリケーションのコンテキスト・パスは、次のことが当てはまる場合に使用されます。
サーブレットのマッピングを含むweb.xmlデプロイメント記述子を更新しなかった(「サーブレットとのパッケージ化」を参照)。
@ApplicationPathアノテーションがjavax.ws.rs.core.Applicationサブクラスで定義されなかった(「アプリケーション・サブクラスとのパッケージ化」を参照)。
|
注意: サーブレットがすでにデフォルトのコンテキスト・パスに登録されている場合、警告が発行されます。 |
たとえば、RESTful Webサービス・アプリケーションのルート・リソース・クラスの相対URIが@Path('/helloworld')として定義され、デフォルトのRESTful Webサービス・アプリケーションのコンテキスト・パスが使用されている場合、RESTful Webサービス・アプリケーションのリソースは次で使用可能です。
http://<host>:<port>/contextPath/resources/helloworld
