11 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 WebLogic Server JAX-WS Webサービス・スタート・ガイド』を参照してください。

表11-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 WebLogic Server JAX-WS Webサービス・スタート・ガイド』のjwsc WebLogic WebサービスAntタスクの実行に関する項を参照してください。
3	Antターゲットを実行して、RESTfulなWebサービスをビルドします。	例: prompt> ant build-rest
4	RESTfulなWebサービスを通常どおりデプロイします。	『Oracle WebLogic Server JAX-WS 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();

        // Obtain the HTTP mehtod of the input request.
        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 {
   // This operation only supports "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アプリケーションおよびEJBリソースの保護のオプションに関する項を参照してください。