17.1.6　URIテンプレート

(1)　テンプレートパラメタ

URIテンプレートは，テンプレートパラメタと呼ばれる埋め込みのパラメタを0個以上含めることができます。テンプレートパラメタは，開始括弧（{）で記述し始め，スラッシュ（/）ではない一文字以上の英数字および記号を続けて記述し，最後に閉じ括弧（}）を記述します。テンプレートパラメタの実際の値は，PathParamアノテーションでアノテートされたパラメタ，フィールド，またはbeanプロパティにインジェクトすると，取得できます。テンプレートパラメタの記述方法については，標準仕様を確認してください。

テンプレートパラメタの例を次に示します。

package com.someshop;
 
import javax.ws.rs.PathParam;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
 
//ルートリソースクラス
@Path("/customers")
public class CustomerResource {
  //サブリソースメソッド
  @GET
  @Path("{id}")
  public String getCustomer(@PathParam("id") int id) {
    //割り当てた値を返すために実行する
  }
}

この例では，Pathアノテーションに含まれる表現{id}はテンプレートパラメタです。ルートリソースクラスcom.someshop.CustomerResourceを含むWebアプリケーション（WARファイル）のコンテキストルートが"resource"で，Webアプリケーションが"someshop.com"というホストで公開されているとします。その場合，URL"http://someshop.com/resource/customers/333"に対するHTTP GETリクエストは，サブリソースメソッドgetCustomer()にディスパッチされ，テンプレートパラメタidの実際の値はPathParamアノテーションでアノテートされたパラメタidにインジェクトされます。

一方，URL"http://someshop.com/resource/customers/333/444"に対するHTTP GETリクエストは，どのメソッドにもディスパッチされません。HTTPステータスコードには404が返されます。

テンプレートパラメタは，Pathアノテーションの値（URIテンプレート）のどこにでも埋め込むことができます。テンプレートパラメタを複数使用している例を次に示します。

package com.someshop;
 
import javax.ws.rs.PathParam;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
 
//ルートリソースクラス
@Path("/")
public class CustomerResource {
  //サブリソースクラス
  @GET
  @Path("customers/{firstname}-{lastname}")
  public String getCustomer(@PathParam("firstname") String firstname,
      @PathParam("lastname") String lastname) {
    //割り当てた値を返すために実行する
  }
}

この例では，Pathアノテーションに含まれる表現{firstname}および{lastname}は，ハイフンによって区切られた二つのテンプレートパラメタです。

URL"http://someshop.com/resource/customers/John-Smith"に対するHTTP GETリクエストは，サブリソースメソッドgetCustomer()にディスパッチされ，テンプレートパラメタfirstnameおよびテンプレートパラメタlastnameの実際の値は，それぞれPathParamアノテーションでアノテートされたパラメタfirstnameおよびパラメタlastnameにインジェクトされます。

package com.someshop;
 
import javax.ws.rs.PathParam;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
 
//ルートリソースクラス
@Path("/customers")
public class CustomerResource {
  //サブリソースメソッド1
  @GET
  @Path("{id : \\d+}")
  public String getCustomer(@PathParam("id") int id) {
    // Implementation to return appropriate value
  }
//サブリソースメソッド2
@GET
  @Path("{path : .+}")
  public String getCustomerIdAndName(@PathParam("path") String path) {
    //割り当てた値を返すために実行する
  }
}

ページの先頭へ