WebOTX Manual V11.1 (第7版) 目次を表示

---

2.12. RESTful Web サービス

2.12.1. RESTful Webサービス・プロジェクトの作成

2.12.1.1. JAX-RS 2.1プロジェクトの作成

(1)新規プロジェクトから作成

(2)既存の動的WebプロジェクトからRESTful Webサービスへ変換

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://xmlns.jcp.org/xml/ns/javaee" xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd" id="WebApp_ID" version="4.0">
  <display-name>RestSample</display-name>
  <welcome-file-list>
    <welcome-file>index.html</welcome-file>
    <welcome-file>index.htm</welcome-file>
    <welcome-file>index.jsp</welcome-file>
    <welcome-file>default.html</welcome-file>
    <welcome-file>default.htm</welcome-file>
    <welcome-file>default.jsp</welcome-file>
  </welcome-file-list>
  <servlet>
    <servlet-name>JAX-RS Servlet</servlet-name>
    <servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>
    <load-on-startup>1</load-on-startup>
  </servlet>
  <servlet-mapping>
    <servlet-name>JAX-RS Servlet</servlet-name>
    <url-pattern>/jaxrs/*</url-pattern>
  </servlet-mapping>
</web-app>

2.12.2. JAX-RSのアノテーション

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

  1 package com.nec.webotx.ws.rest.samples.helloworld.resources;
  2 
  3 import javax.ws.rs.GET;
  4 import javax.ws.rs.Produces;
  5 import javax.ws.rs.Path;
  6 
  7 // The Java class will be hosted at the URI path "/helloworld"
  8 @Path("/helloworld")
  9 public class HelloWorldResource {
 10 
 11     // The Java method will process HTTP GET requests
 12     @GET
 13     // The Java method will produce content identified by the MIME Media
 14     // type "text/plain"
 15     @Produces("text/plain")
 16     public String getClichedMessage() {
 17         // Return some cliched textual content
 18         return "Hello World";
 19     }
 20 }

2.12.3.1. ライフサイクル

• リクエストのライフサイクルと同一
  ルートリソースクラスに@Singletonや@PerSessionアノテーションが定義されていない場合、リクエスト毎に一つのインスタンスを作成します。リクエストを処理した後、そのインスタンスはJavaのガベージ・コレクション対象になります。
• Webアプリケーションのライフサイクルと同一
  ルートリソースクラスに@Singletonアノテーションを定義した場合、Webアプリケーションごとに一つのインスタンスを作成します。Webアプリケーションがガベージ・コレクションされる時、インスタンスもガベージ・コレクションされます。
• セッションのライフサイクルと同一
  ルートリソースクラスに@PerSessionアノテーションを定義した場合、一つのセッションに対して一つのインスタンスを作成します。作成したインスタンスは属性としてsessionに格納しています。セッションがガベージ・コレクションされる時、インスタンスをガベージ・コレクションされます。

2.12.3.2. コンストラクタ

• 明示的に宣言されないコンストラクタ
• パラメータを持たないコンストラクタ
• パラメータを持つコンストラクタ

@Path("ResourceTest1")
public class Resource1{
    private String query1;
    public Resource1(@Encoded @DefaultValue("abc") @QueryParam("queryParam1") String query) {
    query1 = query;
}	
@GET
@Path("/queryParam1Value")
    public String getQuery1Value() {
        return "query1=" + query1;
    }
}

2.12.3.3. フィールドおよびbeanプロパティ

private @Encoded @DefaultValue("value1") @QueryParam("id") String id;

private String property1;
@DefaultValue("10") @QueryParam("paramProperty1")
public void setProperty1(String property1) {
  this.property1 = property1;
}

2.12.3.4. リソースメソッド

@Path("resource_method")
public class ResourceMethodResource {
	@GET
	public String resourceMethod() {
		return "this is a resource method.";
	}
}

2.12.3.5. サブリソースメソッド

@Path("/resourceTest1")
public class Resource1 {
    public Resource1(){
    }
...
    @GET
    @Path("/testPathParam/{arg1}/{arg2}")
    public String listPathParam(@PathParam("arg1") String arg1,@PathParam("arg2") String arg2) {
        return "arg1="+arg1+" and arg2="+arg2;
    }
...
｝

2.12.3.6. サブリソースロケータ

@Path("/resourceTest1")
public class Resource1 {
    @Path("/testSubResourceLocator/{id}")
    public Resource1_1 getResource1_1(@PathParam("id") String id){
        return new Resource1_1(id);
    }
...
}

public class Resource1_1 {
    private String resourceID;
    public Resource1_1(String id){
        resourceID = id;
  }    
    @GET
    public String getDetails(){
        return "This resource id is "+resourceID;
    }
}

@Path("/resourceTest1")
public class Resource1 {
    @Path("/testSubResourceLocator/{id}")
    public Resource1_1 getResource1_1(@PathParam("id") String id){
        return Resource1_1.class;
    }
...
}

2.12.4. サブリソースクラス

public class Resource1_1 {
    private String resourceID;
    public Resource1_1(String id){
        resourceID = id;
  }    
    @GET
    public String getDetails(){
        return "This resource id is "+resourceID;
    }
}

2.12.4.1. ライフサイクル

2.12.4.2. コンストラクタ

2.12.4.3. フィールドおよびbeanプロパティ

2.12.4.4. リソースメソッド、サブリソースメソッドおよびサブリソースロケータ

2.12.5. URIテンプレート

2.12.6. HTTPメソッド

2.12.6.1. @GET

• ルートリソースクラスのpublicメソッド
• サブリソースクラスのpublicメソッド

2.12.6.2. @POST

• ルートリソースクラスのpublicメソッド
• サブリソースクラスのpublicメソッド

2.12.6.3. @PUT

• ルートリソースクラスのpublicメソッド
• サブリソースクラスのpublicメソッド

2.12.6.4. @DELETE

• ルートリソースクラスのpublicメソッド
• サブリソースクラスのpublicメソッド

2.12.6.5. @HEAD

• ルートリソースクラスのpublicメソッド
• サブリソースクラスのpublicメソッド

2.12.6.6. @OPTIONS

• ルートリソースクラスのpublicメソッド
• サブリソースクラスのpublicメソッド

import javax.ws.rs.GET;
import javax.ws.rs.Path;

@Path("optionsmethod")
public class OptionsMethodResource {
	@GET
	public String getHello() {
		return "hello";
	}
}

<?xml version="1.0" encoding="UTF-8"?>
<application xmlns="http://wadl.dev.java.net/2009/02">
    <doc xmlns:jersey="http://jersey.java.net/" jersey:generatedBy="Jersey: 1.11 12/09/2011 10:27 AM"/>
    <grammars/>
    <resources base="http://{server-name:port}/{context-root}/{url-pattern}/">
        <resource path="optionsmethod">
            <method id="getHello" name="GET">
                <response>
                    <representation mediaType="*/*"/>
                </response>
            </method>
        </resource>
    </resources>
</application>

2.12.7. MIMEタイプ宣言

2.12.7.1. @Consumesアノテーション

• リソースクラス(ルートリソースクラス/サブリソースクラス): クラスレベルで@Consumesアノテーションを指定します。そのリソースクラスにある全てのリソースメソッドとサブリソースメソッドのデフォルトMIMEタイプとなります。
• (サブ)リソースメソッド：メソッドレベルで@Consumesアノテーションを指定します。そのリソースメソッドだけ有効になるリクエストのMIMEタイプです。設定の優先度は、メソッドレベルの@Consumesアノテーション > クラスレベルの@Consumesアノテーション となります。
• エンティティプロバイダ：プロバイダクラスレベルで@Consumesアノテーションを指定します。そのプロバイダが処理できるMIMEタイプとなります。

2.12.7.2. @Producesアノテーション

• リソースクラス(ルートリソースクラス/サブリソースクラス): クラスレベルで@Producesアノテーションを指定します。そのリソースクラスにある全てのリソースメソッドとサブリソースメソッドのデフォルトMIMEタイプとなります。
• (サブ)リソースメソッド：メソッドレベルで@Producesアノテーションを指定します。そのリソースメソッドだけ有効になるレスポンスのMIMEタイプです。設定の優先度は、メソッドレベルの@Producesアノテーション > クラスレベルの@Producesアノテーション となります。
• エンティティプロバイダ: プロバイダクラスレベルで@Producesアノテーションを指定します。そのプロバイダが返却するメッセージのMIMEタイプとなります。

2.12.7.3. 複数なメディアタイプを指定する場合の使用例

• 下記の例では、メディアタイプ「application/xml」と「application/json」のいずれも許容される場合の例を示します。

      @GET
      Produces({"application/xml", "application/json"})
      public String doGetAsXmlOrJson() {
          ... 
      }
      

• 複数なメディアタイプを受ける場合、クライアントは、「q」パラメータとして知られている相対的な品質係数を使用してプリファレンスを示すことができます。
• 「q」パラメータの値或いはq-valueは受け入れたセットをソートするために使用されます。
• 下記の例では、クライアントは「application/xml」と「application/json」の両方を受け入れる場合、「application/xml」がより低い品質係数（「qs=0.9」）を指定されるので、サーバは常に「application/json」で送信します。

      @GET
      @Produces({"application/xml; qs=0.9", "application/json"}) 
      public String doGetAsXmlOrJson() { 
          ... 
      }
      

2.12.8. アノテーションの継承

• 子クラスのメソッドおよびパラメータでJAX-RS仕様のアノテーションが使用されていない場合
• 実装クラスのメソッドおよびパラメータでJAX-RS仕様のアノテーションが使用されていない場合

//インタフェース
public interface A {
    @GET
    public String getValue(@QueryParam("query") String query);
}
//インタフェースを実装するルートリソースクラス
@Path("/root/")
public class Resource implements A {
    public String getValue(String query) {…}
}

//親クラス
public class ParentClassA {
	@GET
	public String getValue(@QueryParam("query1") String query1){
		return "query1 = "+query1;
	}
}
//子クラス
@Path("/inheretance")
public class SubClass extends ParentClassA {
	public String getValue(String query){
		return query;
	}
}

public interface InterfaceA {
	@GET
	public String getValue(@PathParam("path1") String path1);
}
public interface InterfaceB {
	@GET
	public String getValue(@QueryParam("query") String query);
}
@Path("/inheretance/{path1}")
public class SubClass implements InterfaceB, InterfaceA{
	public String getValue(String param){
		return param;
	}
}

@Path("/inheretance/{path1}")
public class SubClass implements InterfaceA, InterfaceB{
	public String getValue(String param){
		return param;
	}
}

2.12.9. アノテーションのパラメータ

2.12.9.1. @HeaderParamアノテーション

2.12.9.2. @CookieParamアノテーション

2.12.9.3. @MatrixParamアノテーション

2.12.9.4. @QueryParamアノテーション

2.12.9.5. @PathParamアノテーション

2.12.9.6. @Contextアノテーション

javax.ws.rs.core.UriInfo

@Path("/root")
public class Resource {
  private @Context UriInfo uriInfo;
  @GET
  public String getValue() {
    String value = this.uriInfo.getQueryParameters().getFirst("query");
    return value;
  }
}

javax.ws.rs.core.HttpHeaders

@Path("/root")
public class Resource {
  private @Context HttpHeaders httpHeaders;
  @GET
  public String getValue () {
    String value = this.httpHeaders.getRequestHeader("Accept").get(0);
    return value;
  }
}

javax.ws.rs.core.Providers

@Path("/root")
public class Resource {
  private @Context Providers providers;
  @GET
  public String getValue() {
    //providersフィールドから例外マッピングプロバイダを取得します
    return this.providers.getExceptionMapper(RuntimeException.class);
  }
}

javax.ws.rs.core.SecurityContext

@Path("/root")
public class Resource {
private @Context SecurityContext securityContext;
  @GET
  public String getValue () {
    String value = "Authentication Scheme: "
        + this.securityContext.getAuthenticationScheme()
        + ", User Principal: " + this.securityContext.getUserPrincipal()
        + ", Is secure: " + this.securityContext.isSecure()
        + ", Is user in role: " + this.securityContext.isUserInRole("admin");
    return value;
  }
}

<?xml version="1.0" encoding="UTF-8"?>
<web-app ...>
  ...
  <security-constraint>
     <web-resource-collection>
       <web-resource-name>Test Resource</web-resource-name>
       <url-pattern>/*</url-pattern>
       <http-method>GET</http-method>
     </web-resource-collection>
     <auth-constraint>
       <role-name>admin</role-name>
     </auth-constraint>
  </security-constraint>
  <login-config>
     <auth-method>BASIC</auth-method>
     <realm-name>jaxrs_server</realm-name>
  </login-config>
  <security-role>
     <role-name>admin</role-name>
  </security-role>
</web-app>

javax.ws.rs.core.HttpServletRequest

@Path("/root")
public class Resource {
  private @Context HttpServletRequest httpRequest;
  @GET
  public String getValue() {
    return this.httpRequest.getParameter("TestParam");
  }
}

javax.ws.rs.core.HttpServletResponse

@Path("/root")
public class Resource {
  private @Context HttpServletResponse httpResponse;
  @GET
  public void getValue() throws IOException {
    String entity = "Response mentioned using HttpServletResponse";
    httpResponse.setHeader("abc","xyz");
    httpResponse.getOutputStream().write(entity.getBytes());
    httpResponse.getOutputStream().flush();
    httpResponse.getOutputStream().close(); 
  }
}

javax.ws.rs.core.ServletConfig

@Path("/root")
public class Resource {
  private @Context ServletConfig config;
  @GET
  public String getValue() {
    return this.config.getInitParameter("TestParam");    
  }
}

<web-app ...>
<servlet>
<init-param>
      <param-name>TestParam</param-name>
      <param-value>TestValue</param-value>
</init-param>
……
</servlet>
</web-app>

javax.ws.rs.core.ServletContext

@Path("/root")
public class Resource {
  private @Context ServletContext context;
  @GET
  public String getValue() {
    return this.context.getInitParameter("TestParam");    
  }
}

<?xml version="1.0" encoding="UTF-8"?>
<web-app ...>
  ...
  <context-param>
    <param-name>TestParam</param-name>
    <param-value>TestValue</param-value>
  </context-param>
</web-app>

javax.ws.rs.core.Request

2.12.9.7. @FormParamアノテーション

<html>
<head>
<meta http-equiv="content-type" content="text/xml;charset=utf-8">
<title> test RESTFulWebService @FromParam</title>
</head>
<body>
<form action="http://localhost:8080/WebProject1/myApplication1/testFormParam" method="post" >
<table>
<tr>
<td>FirstName:</td>
<td><input type="text" name="firstname"></td>
</tr>
<tr>
<td>Age:</td>
<td><input type="text" name="age"></td>
</tr>
</table>
<input type="submit" value="Submit" >
</form>
</body>
</html>

@Path("testFormParam")
public class FormResource {
@POST
@Consumes("application/x-www-form-urlencoded")
public String getFormString(@FormParam("firstname") String name, @FormParam("age") int age){
	return "firstname="+name+";age="+age;
	}
}

2.12.9.8. @Encodedアノテーション

2.12.9.9. @DefaultValueアノテーション

2.12.9.10. @BeanParamアノテーション

public class MyBeanParam {
    @PathParam("p")
    private String pathParam;

    @MatrixParam("m")
    @Encoded
    @DefaultValue("default")
    private String matrixParam;

    @HeaderParam("header")
    private String headerParam;

    private String queryParam;

    public MyBeanParam(@QueryParam("q") String queryParam) {
        this.queryParam = queryParam;
    }

    public String getPathParam() { 
        return pathParam; 
    }
    ...
}

@POST
public void post(@BeanParam MyBeanParam beanParam, String entity) { 
    final String pathParam = beanParam.getPathParam();
    ... 
}

2.12.10. エンティティパラメータ

@Path("EntityParameter")
public class EntityParameter {
	@POST
	@Path("getFileBody")
	public String getFileBody(File fileBody) throws IOException{
		BufferedReader br = new BufferedReader(new InputStreamReader(new FileInputStream(fileBody),"UTF-8"));
		String line=null;
		StringBuffer sb = new StringBuffer();
		while((line=br.readLine()) != null){
			sb.append(line);
		}
		return sb.toString();
	}
}

2.12.11. レスポンスの作成

2.12.11.1. 内蔵エンティティプロバイダ対応するJavaの型

@Path("/inputStreamRes")
public class InputStreamResource {
	private Map<String, String> fileRecord = new HashMap<String, String>();
	public InputStreamResource() {
		fileRecord.put("id1", "ファイルパス");
	}
	@GET
	@Path("/{fileId}")
	public InputStream getInputStream(@PathParam("fileId") String fileId) {
		FileInputStream inStream = null;
		String filePath = fileRecord.get(fileId);
		if (filePath != null) {
			try {
				inStream = new FileInputStream(filePath);
			} catch (FileNotFoundException e) {
				e.printStackTrace();
			}
		}
		return inStream;
	}
}

2.12.11.2. Responseタイプ

@Path("ResponseResource")
public class ResponseResource {
    @GET
    @Path("helloworld")
    public Response getHelloWorldByResponse() {
	    String entityBody = "HelloWorld";
	    return Response.ok(entityBody, MediaType.TEXT_HTML_TYPE).build();
    }
}

2.12.11.3. カスタムエンティティプロバイダ対応するJavaの型

2.12.12. プロバイダ

2.12.12.1. エンティティプロバイダ

• (1)リクエストボディからJavaインスタンスに変換します。
• (2)Javaのインスタンスからレスポンスボディに変換します。

内蔵エンティティプロバイダ

• javax.xml.transform.stream.StreamSource
• javax.xml.transform.sax.SAXSource
• javax.xml.transform.dom.DOMSource

カスタムエンティティプロバイダ

    カスタムMessageBodyReaderエンティティプロバイダ

  @Provider
 public class NamePasswordBeanReader implements MessageBodyReader<NamePasswordBean> {

	@Override
	public boolean isReadable(Class<?> arg0, Type arg1, Annotation[] arg2,MediaType arg3) {
		return arg0 == NamePasswordBean.class;
	}

	@Override
	public NamePasswordBean readFrom(Class<NamePasswordBean> arg0, Type arg1,Annotation[] arg2, MediaType arg3, MultivaluedMap<String, String> arg4, InputStream arg5) throws IOException, WebApplicationException {
		//NamePasswordBeanインスタンスを作成。
                ……
	}
}
 

(1)MessageBodyReaderエンティティプロバイダのマッチルール

    カスタムMessageBodyWriterエンティティプロバイダ

 @Provider
public class NamePasswordBeanWriter implements MessageBodyWriter<NamePasswordBean> {

	@Override
	public long getSize(NamePasswordBean arg0, Class<?> arg1, Type arg2,Annotation[] arg3, MediaType arg4) {
		return -1;
	}

	@Override
	public boolean isWriteable(Class<?> classType, Type arg1, Annotation[] arg2,MediaType arg3) {
		return classType == NamePasswordBean.class;
	}

	@Override
	public void writeTo(NamePasswordBean arg0, Class<?> arg1, Type arg2,Annotation[] arg3, MediaType arg4,MultivaluedMap<String, Object> arg5, OutputStream arg6) throws IOException, WebApplicationException {
		// NamePasswordBeanのインスタンスをシリアライズするロジック
     …………
	}
}
 

(1)MessageBodyWriterエンティティプロバイダのマッチルール

• (1)：HTTPレスポンスエンティティボディに対応するObjectの型を取得します。
• (2)：レスポンスのMIMEタイプを決めります。
• (3)：(1)と(2)から取得したJavaタイプとMIMEタイプをサポートするプロバイダの集合を取得します。
  マッチルールは下記に従います。
  「x/y < x/* < */*」
  特定のMIMEタイプをサポートするプロバイダは全てのMIMEタイプをサポートするプロバイダより優先マッチします。
• (4)：(3)に選択したプロバイダをソート(Sort)します。
• (5)：ソートした毎プロバイダのisWriteable()メソッドをコールし、「true」を返すプロバイダを利用します。複数のプロバイダを定義し、それらのプロバイダが全てisWriteable ()でtrueを返却する場合：
  Applicationを継承する場合サブクラスに先に追加されたプロバイダを利用します。
• (6)：いずれのプロバイダも利用できない場合は、例外が発生し、ログに「A message body writer for Java class {ユーザ実装のJavaクラス}, and Java type class {ユーザ実装のJavaクラス}, and MIME media type {MIMEタイプ} was not found」を出力します。HTTPステータスコードには500が返されます。

XML

    JAXBアノテーション

   @XmlRootElement
   public class Planet {
       public int id;
       public String name;
       public double radius;
   }
  

   @Path("planet")
   public class Resource {
   
       @GET
       @Produces(MediaType.APPLICATION_XML)
       public Planet getPlanet() {
           Planet p = new Planet();
           p.id = 1;
           p.name = "Earth";
          p.radius = 1.0;  
          return p;
      }
 }
  

  <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <planet>
      <id>1</id>
      <name>Earth</name>
      <radius>1.0</radius>
   </planet>
  

    JAXBElementクラス

   public class Planet {
       public int id;
       public String name;
       public double radius;
   }
  

   @Path("planet")
   public class Resource {
       @GET
       @Produces(MediaType.APPLICATION_XML)
       public JAXBElement<Planet> getPlanet() {
           Planet p = new Planet();
           p.id = 1;
           p.name = "Earth";
          p.radius = 1.0;
  
          return new JAXBElement<Planet>(new QName(“myplanet”), Planet.class, p);
      }
   }
  

  <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <myplanet>
        <id>1</id>
        <name>Earth</name>
        <radius>1.0</radius>
    <myplanet>
  

JSON

    JSONObject/JSONArrayクラス

   public class Contact {
  
       public int id;
       public String name;
        
       public Contact(int id, String name) {
           this.name = name;
           this.id = id;
          
      }
  }
  

	 @Path("/JSONObject")
	 public class MyJSONObjectResource {
		@GET
		@Produces("application/json")
		public JSONObject getContact() {
			
			Contact contact = new Contact(2, "BOb");
			JSONObject jsonOb = new JSONObject();
			try {
				jsonOb.put("id", contact.id).put("name", contact.name);
			} catch (JSONException e) {
				e.printStackTrace();
			}
			return jsonOb;
		}
   }
  

  {"id":2,"name":"BOb"}
  

2.12.12.2. コンテキストプロバイダ

    @Provider
   public class JAXBContextResolver implements ContextResolver<JAXBContext> {
   
       private JAXBContext context;
       private Class[] types = {MyJaxbBean.class};
   
       public JAXBContextResolver() throws Exception {
           this.context = 
   	  new JSONJAXBContext( 
  	    JSONConfiguration.natural().build(), types); 
      }
  
      public JAXBContext getContext(Class<?> objectType) {
          for (Class type : types) {
              if (type == objectType) {
                  return context;
              }
          }
          return null;
      }
 }
   

     @Provider
     @Produces(“application/json”)
      public class JAXBContextResolver implements ContextResolver<JAXBContext> {
         ……
      }
   

コンテキストプロバイダのマッチルール

2.12.12.3. 例外マッピングプロバイダ

2.12.13. JAX-RSクライアントAPIのサポート

import javax.ws.rs.client.Client;
import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.Entity;
import javax.ws.rs.client.WebTarget;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;

public class UserClient {

   private static String serverUri = "http://localhost:80/WSDemo/rest";

private static void addUser() {
     User user = new User("219","山口","25");
     Client client = ClientBuilder.newClient();
     WebTarget target = client.target(serverUri + "/users");
     Response response = target.request().buildPost(Entity.entity(user, MediaType.APPLICATION_XML)).invoke();
     response.close();
}

ClientConfig clientConfig = new ClientConfig();
clientConfig.register(MyClientResponseFilter.class);
clientConfig.register(new AnotherClientFilter());
Client client = ClientBuilder.newClient(clientConfig);

WebTarget webTarget = client.target("http://example.com/rest");
WebTarget resourceWebTarget = webTarget.path("resource");		// URI "http://example.com/rest/resource"
WebTarget helloworldWebTarget = resourceWebTarget.path("helloworld");	//"http://example.com/rest/resource/helloworld".
WebTarget helloworldWebTargetWithQueryParam = helloworldWebTarget.queryParam("greeting", "Hi World!");

Invocation.Builder invocationBuilder = helloworldWebTargetWithQueryParam.request(MediaType.TEXT_PLAIN_TYPE);
invocationBuilder.header("some-header", "true");

Response response = invocationBuilder.get();

Response response = invocationBuilder.post(Entity.entity("A string entity to be POSTed", MediaType.TEXT_PLAIN));

System.out.println(response.getStatus());
System.out.println(response.readEntity(String.class));

2.12.14. フィルターの作成

フィルターはHttpヘッダなどリクエストとレスポンスのパラメータを変更したい場合に使用します。サーバー側のフィルターとクライアント側のフィルター、2種類に分かれています。

2.12.14.1. サーバ側のフィルター：

2.12.14.2. クライアント側のフィルター:

Memo
フィルターは JAX-RS 2.1 規範に定義される機能であるため、フィルター作成で選択されるプロジェクトは JAX-RS 2.1 ファセットを持つ必要があります。

2.12.14.3. ContainerResponseFilter

import java.io.IOException;
import javax.ws.rs.container.ContainerRequestContext;
import javax.ws.rs.container.ContainerResponseContext;
import javax.ws.rs.container.ContainerResponseFilter;
import javax.ws.rs.core.Response;

@Provider
public class PoweredByResponseFilter implements ContainerResponseFilter {
 
    @Override
    public void filter(ContainerRequestContext requestContext, ContainerResponseContext responseContext)
        throws IOException { 
            responseContext.getHeaders().add("X-Powered-By", "Jersey :-)");
    }
}

2.12.14.4. ContainerRequestFilter

import java.io.IOException;
import javax.ws.rs.container.ContainerRequestContext;
import javax.ws.rs.container.ContainerRequestFilter;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.SecurityContext;

@Provider
public class AuthorizationRequestFilter implements ContainerRequestFilter {
 
    @Override
    public void filter(ContainerRequestContext requestContext)
                    throws IOException {
 
        final SecurityContext securityContext =
                    requestContext.getSecurityContext();
        if (securityContext == null ||
                    !securityContext.isUserInRole("privileged")) {
 
                requestContext.abortWith(Response
                    .status(Response.Status.UNAUTHORIZED)
                    .entity("User cannot access the resource.")
                    .build());
        }
    }
}

2.12.14.5. ClientRequestFilter

public class CheckRequestFilter implements ClientRequestFilter {
 
    @Override
    public void filter(ClientRequestContext requestContext)
                        throws IOException {
        if (requestContext.getHeaders(
                        ).get("Client-Name") == null) {
            requestContext.abortWith(
                        Response.status(Response.Status.BAD_REQUEST)
                .entity("Client-Name header must be defined.")
                        .build());
         }
    }
}

2.12.14.6. ClientResponseFilter

public class ClientResponseLoggingFilter implements ClientResponseFilter {

	@Override
	public void filter(final ClientRequestContext reqCtx,
			final ClientResponseContext resCtx) throws IOException {
		System.out.println("status: " + resCtx.getStatus());
		System.out.println("media-type: " + resCtx.getMediaType().getType());
}

2.12.15. インターセプターの作成

インターセプターは、入出力ストリームを通じてエンティティーの読み書き処理を行う時に使います。サーバー側とクライアント側は共通APIを利用します。
インターセプターは

• 入力ストリームをラップするReaderInterceptorと、
• 出力ストリームをラップするWriterInterceptor

Memo
インターセプターは JAX-RS 2.1 規範に定義される機能であるため、インターセプター作成で選択されるプロジェクトは JAX-RS 2.1 ファセットを持つ必要があります。

2.12.15.1. ReaderInterceptor

public class GZIPReaderInterceptor implements ReaderInterceptor {
 
    @Override
    public Object aroundReadFrom(ReaderInterceptorContext context)
                    throws IOException, WebApplicationException {
        final InputStream originalInputStream = context.getInputStream();
        context.setInputStream(new GZIPInputStream(originalInputStream));
        return context.proceed();
    }
}

2.12.15.2. WriterInterceptor

public class GZIPWriterInterceptor implements WriterInterceptor {
 
    @Override
    public void aroundWriteTo(WriterInterceptorContext context)
                    throws IOException, WebApplicationException {
        final OutputStream outputStream = context.getOutputStream();
        context.setOutputStream(new GZIPOutputStream(outputStream));
        context.proceed();
    }
}

2.12.16. SpringDI機能のサポート

• Springのトランザクション管理機能(@Transactional注解を利用)
• SpringのセキュリティとAOP(aspect oriented programming)機能(@Aspect注解を利用)

• @Component
• @Service
• @Controller
• @Repository

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import org.springframework.stereotype.Component;
@Component
@Path("/")
public class SomeResource { 
    @Transactional
    @GET
    public void updateResource() {
        // ...
    }.
}

• jersey-spring4.jar

<?xml version="1.0" encoding"UTF-8"?>
<nec-web-app>
        <context-root>sse-item-store-webapp</context-root>
	<class-loader delegate="false" extra-class-path="C:/WebOTX/lib/gf-client.jar;C:/WebOTX/modules/jersey-spring4.jar">
		<property name="overrideablejavaxpackages" value="javax.ws.rs,javax.annotation,javax.validation" />
        </class-loader>
	......
</nec-web-app>

2.12.17. 非同期処理

2.12.17.1. サーバ側

@Path("/resource")
public class AsyncResource {
    @GET
    public void asyncGet(@Suspended final AsyncResponse asyncResponse) {
 
        new Thread(new Runnable() {
            @Override
            public void run() {
                String result = veryExpensiveOperation();
                asyncResponse.resume(result);
            }
 
            private String veryExpensiveOperation() {
                // ... very expensive operation
            }
        }).start();
    }
}

@GET
public void asyncGetWithTimeout(@Suspended final AsyncResponse asyncResponse) {
    asyncResponse.setTimeoutHandler(new TimeoutHandler() {
 
        @Override
        public void handleTimeout(AsyncResponse asyncResponse) {
            asyncResponse.resume(Response.status(Response.Status.SERVICE_UNAVAILABLE)
                    .entity("Operation time out.").build());
        }
    });
    asyncResponse.setTimeout(20, TimeUnit.SECONDS);
 
    new Thread(new Runnable() {
 
        @Override
        public void run() {
            String result = veryExpensiveOperation();
            asyncResponse.resume(result);
        }
 
        private String veryExpensiveOperation() {
            // ... very expensive operation that typically finishes within 20 seconds
        }
    }).start();
}

2.12.17.2. クライアント側

final AsyncInvoker asyncInvoker = target().path("http://example.com/resource/")
        .request().async();
final Future<Response> responseFuture = asyncInvoker.get();
System.out.println("Request is being processed asynchronously.");
final Response response = responseFuture.get();
    // get() waits for the response to be ready
System.out.println("Response received.");

2.12.17.3. CompletionStageを使用した非同期処理の代替実装

@Path("/resource")
public class AsyncResource {
  @GET
  public CompletionStage<String> asyncGet() {
    CompletableFuture<String> cs = new CompletableFuture<>();
      new Thread(new Runnable() {
        @Override
        public void run() {
          String result = veryExpensiveOperation();
          cs.complete(result);
        }
      private String veryExpensiveOperation() {
        // ... very expensive operation
      }
    }).start();
    return cs;
  }
}

2.12.17.4. Reactive Clients

client = ClientBuilder.newClient()
CompletionStage<Number> csp = client.target("price/{destination}")
    .resolveTemplate("destination", "mars")
    .request()
    .rx()
    .get(Number.class);
CompletionStage<String> csd = client.target("distance/{destination}")
    .resolveTemplate("destination", "mars")
    .request()
    .rx()
    .get(String.class);
csp.thenCombine(csd, (price, distance) ->
reserveIfAffordableAndWarm(price, distance));

2.12.17.5. Executor Service

  @Resource
  ManagedScheduledExecutorService Pool;
  Client client = ClientBuilder.newBuilder().scheduledExecutorService(pool).build();
  Future>String< result = client.target("http://hoge.com").path("xxx").request().async().get(String.class);
  

2.12.18. セキュリティ

SslConfigurator sslConfig = SslConfigurator.newInstance()
        .trustStoreFile("./truststore_client")
        .trustStorePassword("secret-password-for-truststore")
        .keyStoreFile("./keystore_client")
        .keyPassword("secret-password-for-keystore");
 
SSLContext sslContext = sslConfig.createSSLContext();
Client client = ClientBuilder.newBuilder().sslContext(sslContext).build();
Response response = client.target("https://example.com/resource").request().get();

HttpAuthenticationFeature feature = HttpAuthenticationFeature.basic("user", "superSecretPassword");

HttpAuthenticationFeature feature = HttpAuthenticationFeature.basicBuilder()
    .nonPreemptive().credentials("user", "superSecretPassword").build();

2.12.19. Jakarta JSON Processing (JSON-P)

       ClientBuilder.newClient(new ClientConfig()
             .register(JsonProcessingFeature.class)
             .property(JsonGenerator.PRETTY_PRINTING, true));
     

      public class MyApplication extends ResourceConfig {
          public MyApplication() {
              packages("com.nec.webotx.jersey.examples.jsonp.resource");
              register(LoggingFilter.class);
              property(JsonGenerator.PRETTY_PRINTING, true);
          }
      }
     

  <web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
   <servlet>
     <servlet-name>com.nec.webotx.jersey.examples.jsonp.MyApplication</servlet-name>
     <servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>
     <init-param>
         <param-name>javax.ws.rs.Application</param-name>
         <param-value>com.nec.webotx.jersey.examples.jsonp.MyApplication</param-value>
     </init-param>
     <init-param>
         <param-name>javax.json.stream.JsonGenerator.prettyPrinting</param-name>
         <param-value>true</param-value>
     </init-param>
     <load-on-startup>1</load-on-startup>
   </servlet>
   <servlet-mapping>
     <servlet-name>com.nec.webotx.jersey.examples.jsonp.MyApplication</servlet-name>
     <url-pattern>/*</url-pattern>
   </servlet-mapping>
  </web-app>
  

• Object Model API
• Streaming API

2.12.19.1. Object Model API

2.12.19.2. 主なObject Model APIのクラス

      URL url = new URL("http://sample.com/example/?q=java&type=post");
      try (InputStream is = url.openStream();
          JsonReader rdr = Json.createReader(is)) {
          JsonObject obj = rdr.readObject();
          JsonArray results = obj.getJsonArray("data");
          for (JsonObject result : results.getValuesAs(JsonObject.class)) {
              System.out.print(result.getJsonObject("from").getString("name"));
              System.out.print(": ");
              System.out.println(result.getString("message", ""));
              System.out.println("-----------");
          }
     

     	{
          "data" : [
              { "from" : { "name" : "xxx", ... }, "message" : "yyy", ... },
              { "from" : { "name" : "ppp", ... }, "message" : "qqq", ... },
              ...
          ],
          ...
      }
     

2.12.19.3. Streaming API

2.12.19.4. 主なStreaming APIのクラス

      URL url = new URL("https://graph.facebook.com/search?q=java&type=post");
      try (InputStream is = url.openStream();
           JsonParser parser = Json.createParser(is)) {
           while (parser.hasNext()) {
             Event e = parser.next();
             if (e == Event.KEY_NAME) {
                   switch (parser.getString()) {
                      case "name":
                          parser.next();
                         System.out.print(parser.getString());
                         System.out.print(": ");
                         break;
                     case "message":
                         parser.next();
                          System.out.println(parser.getString());
                         System.out.println("---------");
                         break;
                  }
               }
           }
       }
     

2.12.20. Jakarta JSON Binding (JSON-B)

  @Provider
  public class JsonParserBodyReader implements MessageBodyReader<JsonParser> {
    @Override
    public boolean isReadable(Class<?> arg0, Type arg1, Annotation[] arg2,MediaType arg3) {
      return arg0 == JsonParser.class;
    }
    @Override
    public JsonParser readFrom(Class<JsonParser> arg0, Type arg1,Annotation[] arg2,
          MediaType arg3, MultivaluedMap<String, String> arg4, InputStream arg5) throws IOException, WebApplicationException {
      //JsonParserインスタンスを作成。

    }
  }

2.12.21. Server-Sent Events (SSE)サポート

2.12.21.1. 概要

2.12.21.2. Server-Sent Events API

2.12.21.3. サーバ実装とクライアント実装(Jersey)

     	...
      import org.glassfish.jersey.media.sse.EventOutput;
      import org.glassfish.jersey.media.sse.OutboundEvent;
      import org.glassfish.jersey.media.sse.SseFeature;
      ...
      @Path("events")
      public static class SseResource {
          @GET
          @Produces(SseFeature.SERVER_SENT_EVENTS)
          public EventOutput getServerSentEvents() {
              final EventOutput eventOutput = new EventOutput();
              new Thread(new Runnable() {
                  @Override
                  public void run() {
                      try {
                          for (int i = 0; i < 10; i++) {
                              // ... code that waits 1 second
                              final OutboundEvent.Builder eventBuilder
                              = new OutboundEvent.Builder();
                              eventBuilder.name("message-to-client");
                              eventBuilder.data(String.class,
                                  "Hello world " + i + "!");
                              final OutboundEvent event = eventBuilder.build();
                              eventOutput.write(event);
                          }
                      } catch (IOException e) {
                          throw new RuntimeException(
                              "Error when writing the event.", e);
                      } finally {
                          try {
                              eventOutput.close();
                          } catch (IOException ioClose) {
                              throw new RuntimeException(
                                  "Error when closing the event output.", ioClose);
                          }
                      }
                  }
              }).start();
              return eventOutput;
          }
      }
     

      Client client = ClientBuilder.newBuilder()
        .register(SseFeature.class).build();
      WebTarget target = client.target("http://localhost:9998/events");
 
      EventInput eventInput = target.request().get(EventInput.class);
      while (!eventInput.isClosed()) {
          final InboundEvent inboundEvent = eventInput.read();
          if (inboundEvent == null) {
              // connection has been closed
              break;
          }
          System.out.println(inboundEvent.getName() + "; "
              + inboundEvent.readData(String.class));
      }
     

2.12.21.4. サーバ実装とクライアント実装(JAX-RS 2.1)

     	...
      @GET
      @Path("eventStream")
      @Produces(MediaType.SERVER_SENT_EVENTS)
      public void eventStream(@Context SseEventSink eventSink,@Context Sse sse) {
        executor.execute(() -> {
          try (SseEventSink sink = eventSink) {
            eventSink.send(sse.newEvent("event1"));
            eventSink.send(sse.newEvent("event2"));
            eventSink.send(sse.newEvent("event3"));
          }      
        });
      }
     

      WebTarget target = client.target("http://...");
      try (SseEventSource source = SseEventSource.target(target).build()) {
      source.register(System.out::println);
      source.open();
      Thread.sleep(500); // Consume events for just 500 ms
      } catch (InterruptedException e) {
        // falls through
      }
     

2.12.22. 異常の処理

2.12.22.1. WebApplicationException

public class NotFoundException extends WebApplicationException {
   
   /**
     * Create a HTTP 404 (Not Found) exception.
     *
     * @param message the String that is the entity of the 404 response.
     */
    public NotFoundException(String message) {
        this(message, null);
    }

    /**
     * Create a HTTP 404 (Not Found) exception.
     *
     * @param message the String that is the entity of the 404 response.exception A URI-parameter-based exception for errors with QueryParam.Contain a response with a 404 (Client error) status code.
     *  ParamException.HeaderParamException	A parameter exception for errors with HeaderParam.Contain a response with a 400 (Client error) status code.
     *  ParamException.CookieParamException	A parameter exception for errors with CookieParam.Contain a response with a 400 (Client error) status code.
     *  ParamException.FormParamException	A parameter exception for errors with FormParam.Contain a response with a 400 (Client error) status code.
     * @param notFoundUri the URI that cannot be found.
     */
    public NotFoundException(String message, URI notFoundUri) {
        super(Responses.notFound().
                entity(message).type("text/plain").build());
        this.notFoundUri = notFoundUri;
    }
}

2.12.22.2. ExceptionMapperの使用

   @Provider
   public class EntityNotFoundMapper implements
           ExceptionMapper<EntityNotFoundException> {
       public Response toResponse(EntityNotFoundException ex) {
          return Response.status(404).
               entity(ex.getMessage()).
               type("text/plain").
              build();
       }
  }
 

• Applicationを継承する場合サブクラスに先に追加されたプロバイダを利用します。

2.12.23. warファイルの構成

2.12.23.1. warファイルの構成

（凡例）

−：説明や補足事項が特にないことを示します。

2.12.23.2. ルートリソースクラスの作成

• classesディレクトリ以下
• libディレクトリ以下に含まれるJARファイル内

2.12.23.3. JAX-RS機能の配備

      package com.nec.jersey.application;
      @ApplicationPath(“resources”)
      public class MyApplication extends Application {
        public Set<Class<?>> getClasses() {
            Set<Class<?>> s = new HashSet<Class<?>>();
            s.add(HelloWorldResource.class);
            return s;
        }
    }
    

2.12.24. WADL

2.12.24.1. WADLの概要

2.12.24.2. 使用例の説明

  @Path("wadlResource")
  public class WADLResource {
	 @GET
	 public String executeGetRequest() {
		//do something
		return "success";
	 }
	 @POST
	 public String executePostRequest() {
		//do something
		return "success";
	 }
  }
  

  <web-app ……>
     ……
    <servlet>
  	   <servlet-name>wadlTest</servlet-name>
	   <servlet-class>
         org.glassfish.jersey.servlet.ServletContainer
       </servlet-class>
  	    ……
    </servlet>
    <servlet-mapping>
  	   <servlet-name>wadlTest</servlet-name>
  	   <url-pattern>/jersey/*</url-pattern>
    </servlet-mapping>
    ……
  </web-app>
  

  <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <application xmlns="http://wadl.dev.java.net/2009/02">
     <doc xmlns:jersey=http://jersey.java.net/ …… />
     <grammars/>
     <resources base="http://{server-name}:{port}/{context-root}/{url-pattern}/">
         <resource path="wadlResource">
             <method id="executeGetRequest" name="GET">
                <response>
                    <representation mediaType="*/*"/>
                </response>
             </method>
             <method id="executePostRequest" name="POST">
                 <response>
                     <representation mediaType="*/*"/>
                 </response>
             </method>
         </resource>
     </resources>
    </application>