検索

46.3. ルートリソースクラス

download PDF

概要

ルートリソースクラスは、JAX-RS で実装された RESTful Web サービスへのエントリーポイントです。サービスによって実装されるリソースのルート URI を指定する @Path が付いています。そのメソッドは、リソースに対する操作を直接実装するか、サブリソースへのアクセスを提供します。

要件

クラスをルートリソースクラスに指定するには、次の基準を満たしている必要があります。

  • クラスには @Path アノテーションを付ける必要があります。

    指定されたパスは、サービスで実装されるすべてのリソースのルート URI です。ルートリソースクラスで、パスが widgets で、そのメソッドの 1 つが GET 動詞を実装する場合は、widgetsGET がメソッドを呼び出します。サブリソースで、その URI が {id} であると指定されている場合には、サブリソースの完全な URI テンプレートは widgets/{id} で、widgets/12widgets/42 などの URI に対して行われた要求を処理します。

  • ランタイムによる呼び出すには、クラスにパブリックコンストラクターが必要です。

    ランタイムは、コンストラクターのすべてのパラメーターの値を提供できる必要があります。コンストラクターのパラメーターには、JAX-RS パラメーターアノテーションで装飾されたパラメーターを含めることができます。パラメーターアノテーションの詳細については、47章リソースクラスとメソッドへの情報の受け渡し を参照してください。

  • クラスのメソッドの少なくとも 1 つに HTTP 動詞アノテーションまたは @Path アノテーションを付ける必要があります。

例46.3「ルートリソースクラス」 は、サブリソースへのアクセスを提供するルートリソースクラスを示しています。

例46.3 ルートリソースクラス

package demo.jaxrs.server;

import javax.ws.rs.DELETE;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.PUT;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.Response;

@Path("/customerservice/")
public class CustomerService
{
  public CustomerService()
  {
    ...
  }

  @GET
  public Customer getCustomer(@QueryParam("id") String id)
  {
    ...
  }

  @DELETE
  public Response deleteCustomer(@QueryParam("id") String id)
  {
    ...
  }

  @PUT
  public Response updateCustomer(Customer customer)
  {
    ...
  }

  @POST
  public Response addCustomer(Customer customer)
  {
    ...
  }

  @Path("/orders/{orderId}/")
  public Order getOrder(@PathParam("orderId") String orderId)
  {
    ...
  }

}

例46.3「ルートリソースクラス」 のクラスは、ルートリソースクラスのすべての要件を満たしています。

クラスに @Path アノテーションが付けられます。サービスによって公開されるリソースのルート URI は customerservice です。

クラスにはパブリックコンストラクターがあります。この場合には、簡素化するために、引数なしのコンストラクターが使用されます。

このクラスは、リソースに 4 つの HTTP 動詞それぞれを実装します。

このクラスは、getOrder() メソッドを介してサブリソースへのアクセスも提供します。@Path アノテーションを使用して指定されるサブリソースの URI は customerservice/order/id です。サブリソースは Order クラスによって実装されます。

サブリソースの実装の詳細については、「サブリソースの操作」を参照してください。

Red Hat logoGithubRedditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

© 2024 Red Hat, Inc.