JavaCallout ポリシーエラーの処理方法

このページは Apigee と Apigee ハイブリッドに適用されます。

Apigee Edge のドキュメントを表示する。

JavaCallout とは

JavaCallout を初めて使用する場合は、JavaCallout の作成方法から始めることをおすすめします。

JavaCallout ポリシーのエラー処理

JavaCallout ポリシーを記述する際に、Java コードでカスタムエラー処理を行いたい場合があります。例えば、Apigee のプロキシフロー内で、エラーメッセージやヘッダーをカスタマイズして返したり、エラー情報を使ってフロー変数を設定したりしたい場合です。

基本的なカスタムエラー処理のパターンを示す、単純な JavaCallout ポリシーの例を見てみましょう。このサンプルは、例外が発生するとカスタムのエラーメッセージを返します。また、エラーのスタックトレースをフロー変数に保存します。これは便利なデバッグ方法といえます。

プロジェクトをダウンロードする

処理を簡単に行うため、プロジェクトを GitHub の Apigee api-platform-samples リポジトリからダウンロードします。

api-platform-samples をシステムにダウンロードするか、クローンを作成します。
ターミナルまたは任意のコードエディタで api-platform-samples/doc-samples/java-error プロジェクトに移動します。

サンプル Java コード

エラー処理パターンは単純です。messageContext.setVariable() メソッドを使用すると、現在の Apigee フローコンテキストでフロー変数を設定できます。カスタムエラー情報を返すには、ExecutionResult インスタンスを作成し、そのインスタンスでメソッドを呼び出してエラーレスポンスとヘッダーを設定します。

package com.apigeesample;

import com.apigee.flow.execution.ExecutionContext;
import com.apigee.flow.execution.ExecutionResult;
import com.apigee.flow.execution.spi.Execution;
import com.apigee.flow.message.MessageContext;
import com.apigee.flow.execution.Action;

import org.apache.commons.lang.exception.ExceptionUtils;


public class JavaError implements Execution {
    public ExecutionResult execute(MessageContext messageContext, ExecutionContext executionContext) {

        try {

                String name = messageContext.getMessage().getHeader("username");

                if (name != null && name.length()>0) {
                        messageContext.getMessage().setContent("Hello, " + name + "!");
                        messageContext.getMessage().removeHeader("username");

                } else {
                        throw new RuntimeException("Please specify a name parameter!");
                }

                return ExecutionResult.SUCCESS;

        } catch (RuntimeException ex) {

            ExecutionResult executionResult = new ExecutionResult(false, Action.ABORT);

            //--Returns custom error message and header
            executionResult.setErrorResponse(ex.getMessage());
            executionResult.addErrorResponseHeader("ExceptionClass", ex.getClass().getName());

            //--Set flow variables -- may be useful for debugging.
            messageContext.setVariable("JAVA_ERROR", ex.getMessage());
            messageContext.setVariable("JAVA_STACKTRACE", ExceptionUtils.getStackTrace(ex));
            return executionResult;
        }
    }
}

Maven でコードをコンパイルする

このプロジェクトは Maven でコンパイルできるように設定されています。javac を使用する場合は、この後の例をご覧ください。

Maven がインストールされていることを確認します。
```
mvn -version
```
java-error/buildsetup.sh スクリプトを実行します。このスクリプトにより、必要な JAR 依存関係がローカルの Maven リポジトリにインストールされます。
cd で java-error/callout ディレクトリに移動します。
Maven を実行します。
```
mvn clean package
```
注: Maven エラーが発生した場合は、現在のディレクトリが java-error/callout ディレクトリであることを確認してください。
必要であれば、JAR ファイル edge-custom-policy-java-error.jar が java-error/apiproxy/resources/java にコピーされていることも確認してください。これは、プロキシでデプロイする JAR ファイルに必要な場所です。

プロキシをデプロイして呼び出す

デプロイスクリプトは ./java-error ディレクトリにあります。ただし、スクリプトを実行する前に、クイック設定を行う必要があります。

cd で api-platform-samples/doc-samples/java-error に移動します。
プロキシをデプロイする最も簡単な方法は、ZIP ファイルにバンドルし、Apigee 組織内の環境にプロキシバンドルをアップロードすることです。API プロキシの作成をご覧ください。必ず [Upload Proxy Bundle] オプションを使用してください。Apigee コミュニティでプロキシバンドルに API プロキシをアップロードするためのヒントもご覧ください。
プロキシがデプロイされたら、次のように呼び出してみてください。
```
curl  https://$HOSTNAME/java-error
```
この呼び出しには name クエリパラメータが含まれていないため、Java コードはランタイムエラーをスローします。プロキシは次のメッセージとヘッダーを返します。

エラーメッセージ: Please specify a name parameter!
ヘッダー: ExceptionClass: java.lang.RuntimeException