9 RESTful な Web サービスのログラミング

以下の節では、RESTful な Web サービスプログラミング方法について説明します。

RESTful な Web サービスの概要
RESTful な Web サービスのプログラミング : 主な手順
RESTful な Web サービスのプログラミングのガイドライン
クライアントから RESTful な Web サービスへのアクセス
RESTful な Web サービスのセキュリティ

RESTful な Web サービスの概要

REST (Representational State Transfer) とは、SOAP のように追加のメッセージ層を使用することなく、HTTP などの標準化されたインタフェースでデータを転送するためのシンプルなインタフェースを記述したものです。REST は、ユニークな URI で特定できるステートレスサービスをリソース (特定の情報のソース) とみなし、これらを作成するための設計ルールを提供します。クライアントは URI、標準化されたメソッドの固定セットを使用してリソースにアクセスし、リソースの「表現」が返されます。クライアントは、新しいリソース表現を受け取るたびに「転送」状態に設定されます。

HTTP プロトコルを使用して RESTful リソースをアクセスする場合、リソース識別子はリソースの URL であり、このリソースで実行される標準のオペレーションは HTTP の 1 つのメソッド (GET、PUT、DELETE、POST、または HEAD) です。

注意 :

この JAX-WS 実行で、サポートされた HTTP メソッドのセットが GET および POST に限定されています。DELETE、PUT および HEAD がサポートされません。これらのメソッドを含むどの HTTP 要求も 405 不可のメソッドというエラーメッセージが表示され、拒否されます。

PUT および DELETE の機能が必須の場合、POST メソッドで実行される実際のメソッドをトンネリングすることによって目的のアクションを実行できます。これは、オーバーロードされた POST という解決策です。「REST 過負荷 POST」での Web 検索は、これを実行するためのいくつかの方法を返します。

javax.xml.ws.Provider<T> インタフェースの invoke() メソッドを使用して RESTful エンドポイントを構築します。（http://java.sun.com/javaee/5/docs/api/javax/xml/ws/Provider.html を参照）。Provider インタフェースは、サービスエンドポイントインタフェース (SEI) を構築するための動的な代替手段を提供します。

RESTful な Web サービスのプログラミング : 主な手順

この節では、RESTful な Web サービスを実装するために必要な JWS ファイルをプログラミングおよびコンパイルする方法について説明します。この手順では、これらの JWS ファイルをゼロから作成する方法を示しています。既存の JWS ファイルを更新する場合は、この手順をガイドとして利用してください。

Ant ベースの開発環境を設定済みであり、かつ jwsc Ant タスクを実行して、Web サービスをデプロイするためのターゲットを追加できる、作業用の build.xml ファイルがあることが前提となっています。詳細については、『Oracle Fusion Middleware JAX-ＷＳを使用した Oracle WebLogic Ｓｅｒｖｅｒ Web サービス入門』を参照してください。

表 9-1 RESTful な Web サービスのプログラミング手順

#	手順	説明
1	RESTful な Web サービスを実装する、新しい JWS ファイルを作成するか、既存の JWS ファイルを更新する。	使い慣れた IDE またはテキストエディタを使用します。「RESTful な Web サービスのプログラミングのガイドライン」を参照してください。
2	`build.xml` ファイルを更新して、RESTful な JWS ファイルを Web サービスにコンパイルするための `jwsc` Ant タスクの呼び出しを含める。	次に例を示します。 <jwsc srcdir="." destdir="output/restEar"> <jws file="NearbyCity.java" type="JAXWS"/> </jwsc> 詳細については、『Oracle Fusion Middleware JAX-ＷＳを使用した Oracle WebLogic Ｓｅｒｖｅｒ Web サービス入門』の「jwsc WebLogic Web サービス Ant タスクの実行」を参照してください。
3	Ant ターゲットを実行して、RESTful な Web サービスをビルドする。	次に例を示します。 prompt> ant build-rest
4	RESTful な Web サービスを、通常どおりデプロイする。	『Oracle Fusion Middleware JAX-ＷＳを使用した Oracle WebLogic Ｓｅｒｖｅｒ Web サービス入門』の「WebLogic Web サービスのデプロイとアンデプロイ」を参照してください。
5	Web サービスクライアントから RESTful な Web サービスにアクセスする。	「クライアントから RESTful な Web サービスへのアクセス」

RESTful な Web サービスのプログラミングのガイドライン

次のサンプルでは、RESTful な Web サービスを実装する簡単な JWS ファイルを示します。太字で示された Java コードに対応するコーディングのガイドラインについては、サンプルの後の説明を参照してください。

package examples.webservices.jaxws.rest;
import javax.xml.ws.WebServiceProvider;
import javax.xml.ws.BindingType;
import javax.xml.ws.Provider; 
import javax.xml.ws.WebServiceContext;
import javax.xml.ws.handler.MessageContext;
import javax.xml.ws.http.HTTPBinding;
import javax.xml.ws.http.HTTPException;
import javax.xml.transform.Source;
import javax.xml.transform.stream.StreamSource;
import javax.annotation.Resource;
import java.io.ByteArrayInputStream;
import java.util.StringTokenizer;

@WebServiceProvider(
   targetNamespace="http://example.org",
   serviceName = "NearbyCityService")
@BindingType(value = HTTPBinding.HTTP_BINDING) 

public class NearbyCity implements Provider<Source> { 
  @Resource(type=Object.class)
  protected WebServiceContext wsContext;

  public Source invoke(Source source)  { 
    try {
        MessageContext messageContext = wsContext.getMessageContext();

        // 入力要求のHTTP メソッドを取得します。
        javax.servlet.http.HttpServletRequest servletRequest = 
          (javax.servlet.http.HttpServletRequest)messageContext.get(
           MessageContext.SERVLET_REQUEST);
        String httpMethod = servletRequest.getMethod();
        if (httpMethod.equalsIgnoreCase("GET"));
        {

            String query =
                 (String)messageContext.get(MessageContext.QUERY_STRING); 
            if (query != null && query.contains("lat=") &&
                query.contains("long=")) {
                return createSource(query); 
            } else {
                System.err.println("Query String = "+query);
                throw new HTTPException(404);
            }
            } catch(Exception e) {
              e.printStackTrace();
              throw new HTTPException(500);
            }
        }
        } else {
   // この操作は、GETのみサポートします。
       throw new HTTPException405);
   }
    private Source createSource(String str) throws Exception {
        StringTokenizer st = new StringTokenizer(str, "=&/");
        String latLong = st.nextToken();
        double latitude = Double.parseDouble(st.nextToken());
        latLong = st.nextToken();
        double longitude = Double.parseDouble(st.nextToken());
        City nearby = City.findNearBy(latitude, longitude);
        String body = nearby.toXML();
        return new StreamSource(new ByteArrayInputStream(body.getBytes()));
    }

    static class City {
         String city;
         String state;
         double latitude;
         double longitude;
         City(String city, double lati, double longi, String st) {
             this.city = city;
             this.state = st;
             this.latitude = lati;
             this.longitude = longi;
         }

         double distance(double lati, double longi) {
            return Math.sqrt((lati-this.latitude)*(lati-this.latitude) + 
                (longi-this.longitude)*(longi-this.longitude)) ;
         }

         static final City[] cities = {
            new City("San Francisco",37.7749295,-122.4194155,"CA"),
            new City("Columbus",39.9611755,-82.9987942,"OH"),
            new City("Indianapolis",39.7683765,-86.1580423,"IN"),
            new City("Jacksonville",30.3321838,-81.655651,"FL"),
            new City("San Jose",37.3393857,-121.8949555,"CA"),
            new City("Detroit",42.331427,-83.0457538,"MI"),
            new City("Dallas",32.7830556,-96.8066667,"TX"),
            new City("San Diego",32.7153292,-117.1572551,"CA"),
            new City("San Antonio",29.4241219,-98.4936282,"TX"),
            new City("Phoenix",33.4483771,-112.0740373,"AZ"),
            new City("Philadelphia",39.952335,-75.163789,"PA"),
            new City("Houston",29.7632836,-95.3632715,"TX"),
            new City("Chicago",41.850033,-87.6500523,"IL"),
            new City("Los Angeles",34.0522342,-118.2436849,"CA"),
            new City("New York",40.7142691,-74.0059729,"NY")};
        static City findNearBy(double lati, double longi) {
            int n = 0;
            for (int i = 1; i < cities.length; i++)  {
                if (cities[i].distance(lati, longi) <  
                     cities[n].distance(lati, longi)) {
                    n = i;
                }
            }
            return cities[n];
        }

        public String toXML() {
             return "<ns:NearbyCity xmlns:ns=\"http://example.org\"><City>"
                  +this.city+"</City><State>"+ this.state+"</State><Lat>"
                  +this.latitude +
                  "</Lat><Lng>"+this.longitude+"</Lng></ns:NearbyCity>";
        }
    }
}

RESTful な Web サービスを実装する JWS ファイルをプログラミングする際には、以下のガイドラインに従います。ガイドラインのサンプルコードは、上述のサンプルでは太字で示されています。

RESTful な Web サービスを実装するために必要なパッケージをインポートする。

import javax.xml.ws.WebServiceProvider;
import javax.xml.ws.BindingType;
import javax.xml.ws.Provider;

Provider 実装クラスにアノテーションを追加し、HTTP に対するバインディングタイプを設定する。

@WebServiceProvider(
   targetNamespace="http://example.org",
   serviceName = "NearbyCityService")
@BindingType(value = HTTPBinding.HTTP_BINDING)

Provider インタフェースの invoke() メソッドを実装する。

public class NearbyCity implements Provider<Source> {
  @Resource(type=Object.class)
  protected WebServiceContext wsContext;

  public Source invoke(Source source)  {
  ...
  }

処理のためQUERY_STRINGのフィールドで、処理するのにjavax.xml.ws.handler.MessageContext で QUERY_STRING フィールドを使用した要求文字列を取得します。(メッセージ URL http://java.sun.com/javase/6/docs/api/javax/xml/ws/handler/MessageContext.html を参照。)その後、クエリ文字列が createSource() メソッドに渡され、指定した値に最も近い市、州、緯度、経度が返されます。
```
String query =
             (String)messageContext.get(MessageContext.QUERY_STRING); 
.
.
.
return createSource(query);
```

クライアントから RESTful な Web サービスへのアクセス

Web サービスクライアントから RESTful な Web サービスにアクセスするには、リソースの URI を使用します。次に例を示します。

URL url = new URL (http://localhost:7001/NearbyCity/NearbyCityService?lat=35&long=-120);
HttpURLConnection conn = (HttpURLConnection)url.openConnection();
connection.setRequestMethod("POST");
// Get result
InputStream is = connection.getInputStream();

この例では、緯度 (lat) と経度 (long) の値を指定して、必要なリソースにアクセスしています。

RESTful な Web サービスのセキュリティ

Web アプリケーションを保護するために使用するメソッドと同じメソッドを使用して RESTful な Web サービスを保護することができます。詳細については、『Oracle WebLogic Server ロールおよびポリシーによるリソースの保護』の「Web アプリケーションの保護のオプション」を参照してください。