Android アプリケーションからのリソース要求

概説

MobileFirst アプリケーションは WLResourceRequest REST API を使用してリソースにアクセスできます。
REST API は、すべてのアダプターおよび外部リソースで機能します。

前提条件:

• 必ずご使用のネイティブ Android プロジェクトに Mobile Foundation SDK を追加しておいてください。
• アダプターの作成方法を参照してください。

WLResourceRequest

WLResourceRequest クラスは、アダプターまたは外部リソースに対するリソース要求を処理します。

WLResourceRequest オブジェクトを作成し、リソースへのパスと HTTP メソッドを指定します。
使用可能なメソッドは、WLResourceRequest.GET、WLResourceRequest.POST、WLResourceRequest.PUT、WLResourceRequest.HEAD、および WLResourceRequest.DELETE です。

URI adapterPath = URI.create("/adapters/JavaAdapter/users");
WLResourceRequest request = new WLResourceRequest(adapterPath,WLResourceRequest.GET);

• JavaScript アダプター の場合は、/adapters/{AdapterName}/{procedureName} を使用します。
• Java アダプターの場合は、/adapters/{AdapterName}/{path} を使用します。 path は、Java コードで @Path アノテーションをどのように定義したかによって決まります。 これには、使用した @PathParam も含まれます。
• プロジェクトの外部にあるリソースにアクセスするには、外部サーバーの要件のとおりに完全な URL を使用してください。
• タイムアウト: オプション。ミリ秒単位の要求タイムアウトです。
• スコープ: オプションです。どのスコープがリソースを保護しているのか分かっている場合は、このスコープを指定することで要求をより効率的にすることができます。

要求の送信

.send() メソッドを使用してリソースを要求します。 WLResponseListener クラス・インスタンスを指定します。

request.send(new WLResponseListener(){
  public void onSuccess(WLResponse response) {
    Log.d("Success", response.getResponseText());
  }
  public void onFailure(WLFailResponse response) {
    Log.d("Failure", response.getResponseText());
  }
});

パラメーター

要求を送信する前に、必要に応じてパラメーターを追加したい場合があります。

パス・パラメーター

上記の説明のとおり、path パラメーター (/path/value1/value2) は、WLResourceRequest オブジェクトの作成中に設定されます。

URI adapterPath = new URI("/adapters/JavaAdapter/users/value1/value2");
WLResourceRequest request = new WLResourceRequest(adapterPath,WLResourceRequest.GET);

照会パラメーター

query パラメーター (/path?param1=value1...) を送信するには、パラメーターごとに setQueryParameter メソッドを使用します。

request.setQueryParameter("param1","value1");
request.setQueryParameter("param2","value2");

JavaScript アダプター

JavaScript アダプターは、名前のない順序付きのパラメーターを使用します。 パラメーターを JavaScript アダプターに渡すには、以下のように名前 params を使用してパラメーターの配列を設定します。

request.setQueryParameter("params","['value1', 'value2']");

これは、WLResourceRequest.GET と一緒に使用してください。

フォーム・パラメーター

本体内のフォーム・パラメーターを送信するには、.send(WLResponseListener) ではなく .send(HashMap<String, String> formParameters, WLResponseListener) を使用します。

HashMap formParams = new HashMap();
formParams.put("height", height.getText().toString());
request.send(formParams, new MyInvokeListener());

パラメーター - JavaScript アダプター

JavaScript アダプターは、名前のない順序付きのパラメーターを使用します。 パラメーターを JavaScript アダプターに渡すには、以下のように名前 params を使用してパラメーターの配列を設定します。

formParams.put("params", "['value1', 'value2']");

これは、WLResourceRequest.POST と一緒に使用してください。

ヘッダー・パラメーター

HTTP ヘッダーとしてパラメーターを送信するには、.addHeader() API を使用します。

request.addHeader("date", date.getText().toString());

その他のカスタム本体パラメーター

• .send(requestBody, WLResponseListener listener) を使用して、本体に任意のストリングを設定できます。
• .send(JSONStore json, WLResponseListener listener) を使用して、本体に任意のディクショナリーを設定できます。
• .send(byte[] data, WLResponseListener listener) を使用して、本体に任意のバイト配列を設定できます。

応答

response オブジェクトには応答データが含まれており、そのメソッドとプロパティーを使用して必要な情報を取得することができます。 よく使用されるプロパティーは、responseText (ストリング)、responseJSON (JSON オブジェクト) (応答が JSON の場合)、および status (整数) (応答の HTTP 状況) です。

WLResponse response オブジェクトおよび WLFailResponse response オブジェクトを使用して、アダプターから取り出されたデータを取得します。

外部マイクロサービスにアクセスするための WLResourceRequest の使用

WLResourceRequest API を使用して、Mobile Foundation の外側でホストされているマイクロサービスにモバイル・アプリがアクセスできるようにすることができます。Mobile Foundation によって、アダプターを使用せずに Mobile Foundation API Connector を介してマイクロサービスまたはエンタープライズ・バックエンド・サービスにセキュアな呼び出しを行うことができます。API Connector は、アダプターと同様に、Mobile Foundation の OAuth 2.0 メカニズムに基づいて確実にセキュアな呼び出しを行うことができるようにします。API Connector を使用すると、Mobile Foundation 管理者は Mobile Foundation でマイクロサービスまたはエンタープライズ・バックエンド・サービスの詳細を構成およびデプロイできます。Mobile Foundation ランタイムはデプロイされた構成を使用して、モバイル・アプリからマイクロサービスまたはバックエンド・サービス要求をセキュアに呼び出します。

Mobile Foundation API Connector の構成を参照してください。

マイクロサービス URL (http://mybluemix.net/resorts/cities など) にアクセスするには、Mobile Foundation ランタイム・バックエンド・サービスを次のように構成します。

{
  "service": "resorts",
  "baseUrl":"http://mybluemix.net/resorts"
}

WLResourceRequest は次のように定義できます。

WLResourceRequest request = new WLResourceRequest(url,WLResourceRequest.GET, backendServiceName, timeout);

• url : マイクロサービス・エンドポイントの相対 URL。例: cities
• method : 使用する HTTP メソッド。例: WLResourceRequest.GET
• backendServiceName : データのフェッチ元となるサーバー上で構成されたバックエンド・サービスの名前。例: resorts
• timeout : この要求のタイムアウト時間 (ミリ秒単位)。

var request = new WLResourceRequest('cities',
  	WLResourceRequest.GET,'resorts',3000);

詳細情報

WLResourceRequest について詳しくは、API リファレンスを参照してください。

サンプル・アプリケーション

ResourceRequestAndroid プロジェクトには、Java アダプターを使用してリソース要求を行うネイティブ Android アプリケーションが含まれています。
アダプター Maven プロジェクトには、リソース要求呼び出し中に使用される Java アダプターが含まれています。

ここをクリック して Android プロジェクトをダウンロードします。
ここをクリック してアダプター Maven プロジェクトをダウンロードします。

サンプルの使用法

サンプルの README.md ファイルの指示に従ってください。