Java コールアウト エラーの処理方法

Apigee X のドキュメントが表示されています。
Apigee Edge のドキュメントを参照する。

Java コールアウトとは

Java コールアウトを初めて使用する場合は、Java コールアウトの作成方法から始めることをおすすめします。

Java コールアウトのエラー処理

Java コールアウトを記述するときに、Java コードでカスタムエラー処理を行うこともできます。たとえば、カスタムのエラー メッセージとヘッダーを返したり、Apigee でプロキシフローにエラー情報を含むフロー変数を設定したりできます。

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

プロジェクトのダウンロード

簡単に使用できるように、このプロジェクトは GitHub の Apigee api-platform-samples リポジトリからダウンロードできます。

  1. api-platform-samples をシステムにダウンロードするか、クローンを作成します。
  2. ターミナルまたは任意のコードエディタで 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 を使用する場合は、この後の例をご覧ください。

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

javac でコンパイルする

javac でコードをコンパイルする場合は、java-error ディレクトリから次の操作を行います。必要な JAR ファイルは、java-error/lib ディレクトリに用意されています。

  1. cd で api-platform-samples/doc-samples/java-error に移動します。
  2. javac がパスに含まれていることを確認します。

    javac -version
    
  3. 次の javac コマンドを実行します。

    javac -d . -classpath ./lib/expressions-1.0.0.jar:./lib/message-flow-1.0.0.jar:. callout/src/main/java/JavaProperties.java
    
  4. JAR ファイルを apiproxy/resources/java ディレクトリにコピーします。これは、プロキシでデプロイする JAR ファイル用に必要な場所です。

    cp com/apigeesample/JavaProperties.class apiproxy/resources/java
    

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

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

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

    この呼び出しには name クエリ パラメータが含まれていないため、Java コードはランタイム エラーをスローします。プロキシは次のメッセージとヘッダーを返します。

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