52.2.2. URI の操作

概要

URI コンテキストを使用する主な利点の 1 つとして、サービスのベース URI と選択したリソースの URI のパスセグメントにアクセスできることが挙げられます。この情報は、URI に基づいた処理の決定や、応答の一部として返す URI の計算など、多くの目的に役立ちます。たとえば、要求のベース URI に .com 拡張が含まれる場合に、このサービスでは米国ドルを、ベース URI に .co.uk 拡張が含まれる場合には、英国ポンドを使用するように選択できます。

UriInfo インターフェイスは、URI の一部にアクセスするためのメソッドを提供します。

  • ベース URI
  • リソースパス
  • 完全な URI

ベース URI の取得

ベース URI は、サービスが公開されるルート URI です。サービスの @Path アノテーションで指定された URI の一部は含まれません。たとえば、例47.5「URI のデコードの無効化」 で定義されたリソースを実装するサービスが http://fusesource.org に公開され、リクエストが http://fusesource.org/montersforhire/nightstalker?12 で行われた場合、ベース URI は http://fusesource.org になります。

表52.2「リソースのベース URI にアクセスするメソッド」 は、ベース URI を返すメソッドを示します。

表52.2 リソースのベース URI にアクセスするメソッド

メソッド詳細

URIgetBaseUri

サービスのベース URI を URI オブジェクトとして返します。

UriBuildergetBaseUriBuilder

ベース URI を javax.ws.rs.core.UriBuilder オブジェクトとして返します。UriBuilder クラスは、サービスによって実装された他のリソースの URI を作成するのに役立ちます。

パスの取得

要求 URI の パス 部分は、現在のリソースの選択に使用された URI の部分になります。ベース URI は含まれませんが、URI に含まれる URI テンプレート変数とマトリックスパラメーターは含まれます。

パスの値は選択したリソースによって異なります。たとえば、リソースのパスの取得 で定義されたリソースのパスは以下のようになります。

  • rootPath: /monstersforhire/
  • getterPath: /mostersforhire/nightstalker

    GET リクエストは /monstersforhire/nightstalker で実行されました。

  • putterPath: /mostersforhire/911

    PUT リクエストは /monstersforhire/911 で実行されました。

リソースのパスの取得

@Path("/monstersforhire/")
public class MonsterService
{
  @Context
  UriInfo rootUri;

  ...

  @GET
  public List<Monster> getMonsters(@Context UriInfo getUri)
  {
    String rootPath = rootUri.getPath();
    ...
  }

  @GET
  @Path("/{type}")
  public Monster getMonster(@PathParam("type") String type,
                            @Context UriInfo getUri)
  {
    String getterPath = getUri.getPath();
    ...
  }

  @PUT
  @Path("/{id}")
  public void addMonster(@Encoded @PathParam("type") String type,
                         @Context UriInfo putUri)
  {
    String putterPath = putUri.getPath();
    ...
  }
  ...
}

表52.3「リソースのパスにアクセスするメソッド」 では、リソースパスを返すメソッドについて説明します。

表52.3 リソースのパスにアクセスするメソッド

メソッド詳細

StringgetPath

リソースのパスをデコードされた URI として返します。

StringgetPathbooleandecode

リソースのパスを返します。false を指定すると、URI のデコードが無効になります。

List<PathSegment>getPathSegments

デコードされたパスを javax.ws.rs.core.PathSegment オブジェクトの一覧として返します。マトリックスパラメーターを含むパスの各部分は、リストの一意のエントリーに配置されます。

たとえば、リソースパス box/round#tall の場合は、boxround、および tall の 3 つのエントリーのリストになります。

List<PathSegment>getPathSegmentsbooleandecode

パスを javax.ws.rs.core.PathSegment オブジェクトの一覧として返します。マトリックスパラメーターを含むパスの各部分は、リストの一意のエントリーに配置されます。false を指定すると、URI のデコードが無効になります。

たとえば、リソースパス box#tall/round の場合は、boxtall、および round の 3 つのエントリーのリストになります。

完全な要求 URI の取得

表52.4「完全な要求 URI にアクセスする方法」 では、完全なリクエスト URI を返すメソッドを説明します。要求 URI またはリソースの絶対パスを返すオプションがあります。相違点は、要求 URI には URI に追加されるクエリーパラメーターが含まれ、絶対パスにはクエリーパラメーターが含まれないことです。

表52.4 完全な要求 URI にアクセスする方法

メソッド詳細

URIgetRequestUri

クエリーパラメーターおよびマトリックスパラメーターを含む完全なリクエスト URI を java.net.URI オブジェクトとして返します。

UriBuildergetRequestUriBuilder

クエリーパラメーターおよびマトリックスパラメーターを含む完全なリクエスト URI を javax.ws.rs.UriBuilder オブジェクトとして返します。UriBuilder クラスは、サービスによって実装された他のリソースの URI を作成するのに役立ちます。

URIgetAbsolutePath

マトリックスパラメーターを含む完全なリクエスト URI を java.net.URI オブジェクトとして返します。絶対パスにはクエリーパラメーターは含まれません。

UriBuildergetAbsolutePathBuilder

マトリックスパラメーターを含む完全なリクエスト URI を javax.ws.rs.UriBuilder オブジェクトとして返します。絶対パスにはクエリーパラメーターは含まれません。

URI http://fusesource.org/montersforhire/nightstalker?12 を使用して行われるリクエストの場合は、getRequestUri() メソッドは http://fusesource.org/montersforhire/nightstalker?12 を返します。getAbsolutePath() メソッドは http://fusesource.org/montersforhire/nightstalker を返します。