JavaCallout ポリシー

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

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

ポリシーアイコン

内容

Java を使用すると、デフォルトの Apigee ポリシーに含まれていないカスタム動作を実装できます。Java コードでメッセージプロパティ（ヘッダー、クエリパラメータ、コンテンツ）とプロキシフローのフロー変数にアクセスできます。このポリシーを初めて使用する場合は、Java Callout の作成方法をご覧ください。

サポートされる Java のバージョンは、Oracle JDK 11 と OpenJDK 11 です。

このポリシーは拡張可能なポリシーです。Apigee ライセンスによっては、このポリシーの使用によって費用や使用量に影響する場合があります。ポリシータイプと使用量への影響については、ポリシータイプをご覧ください。

タイミング

ガイドラインについては、Java コールアウトの作成方法の「JavaCallout を使用すべき状況」をご覧ください。

概要

JavaCallout ポリシーを使用すると、フロー変数の取得と設定、カスタムロジックの実行とエラー処理の実施、リクエストやレスポンスからのデータ抽出などを行うことができます。また、標準の Apigee ポリシーに含まれていないカスタム動作を実装することもできます。

必要な JAR パッケージファイルと Java アプリケーションをパッケージ化できます。ただし、JavaCallout の使用には制限があります。制限事項に Java Callout の使用の制限について示しています。

サンプル

簡単な例

Java Callout の作成方法

Java コードのプロパティを取得する

ポリシーの <Property> 要素を使用すると、Java コードでランタイム時に取得できる名前と値のペアを指定できます。プロパティを使用する実際の例については、JavaCallout ポリシーのプロパティの使用方法をご覧ください。

<Property> 要素の name 属性を使用して、Java コードからプロパティにアクセスするために使用する名前を指定します。<Property> 要素の値（開始タグと終了タグの間の値）は、Java コードによって受け取られる値です。この値は文字列にする必要があります。フロー変数を参照して値を取得することはできません。

プロパティを構成します。ここで、プロパティ値は変数名 response.status.code です。

<JavaCallout async="false" continueOnError="false" enabled="true" name="JavaCallout">
    <DisplayName>JavaCallout</DisplayName>
    <ClassName>com.example.mypolicy.MyJavaCallout</ClassName>
    <ResourceURL>java://MyJavaCallout.jar</ResourceURL>
    <Properties>
        <Property name="source">response.status.code</Property>
    </Properties>
</Javascript>

Java コード（下を参照）で、Execution クラスに次のコンストラクタを実装します。

public class MyJavaCallout implements Execution{
    public MyJavaCallout(Map<string, string> props){
        
            // Extract property values from map.
    }
    ...
}

Java コードでフロー変数を設定する

Java コードでメッセージコンテキストの変数（フロー変数）を設定する方法については、Apigee コミュニティの投稿をご覧ください。

要素リファレンス

要素リファレンスでは、JavaCallout ポリシーの要素と属性について説明します。

<JavaCallout name="MyJavaCalloutPolicy">
   <ClassName>com.example.mypolicy.MyJavaCallout</ClassName>
   <ResourceURL>java://MyJavaCallout.jar</ResourceURL>
</JavaCallout>

<JavaCallout> 属性

<JavaCallout name="MyJavaCalloutPolicy" enabled="true" continueOnError="false" async="false" >

次の表に、すべてのポリシーの親要素に共通する属性を示します。

属性	説明	デフォルト	要否
`name`	ポリシーの内部名。`name` 属性の値には、英字、数字、スペース、ハイフン、アンダースコア、ピリオドを使用できます。この値は 255 文字を超えることはできません。管理 UI プロキシエディタで `<DisplayName>` 要素を追加して、ポリシーのラベルに使用する別の自然言語名を指定することもできます。	なし	必須
`continueOnError`	ポリシーが失敗したときにエラーを返す場合は、`false` に設定します。これは、ほとんどのポリシーで想定される動作です。ポリシーが失敗した後もフローの実行を続行する場合は、`true` に設定します。関連項目: 障害ルールはエラー状態の場合にのみトリガーされる（continueOnError について）現在のフローにおける障害処理ヒント: Java コードが例外をスローすると、`continueOnError` 属性が true に設定されている場合でも、Apigee プロキシフローは障害ステータスに移行します。例外がスローされてプロキシで障害ステータスが発生しないようにするには、エラーをスローしないように Java Callout コードを設計します。代わりに、例外をキャッチして、例外情報を取得するためのコンテキスト変数を設定します。詳しくは、Apigee コミュニティのこちらの投稿をご覧ください。	false	省略可
`enabled`	ポリシーを適用するには、`true` に設定します。ポリシーを無効にするには、`false` に設定します。ポリシーがフローに接続されている場合でも適用されません。	true	省略可
`async`	この属性は非推奨となりました。	false	非推奨

<DisplayName> 要素

管理 UI プロキシエディタで name 属性と一緒に使用して、ポリシーのラベルに使用する自然言語名を指定します。

<DisplayName>Policy Display Name</DisplayName>

デフォルト

デフォルト	なしこの要素を省略した場合、ポリシーの `name` 属性の値が使用されます。
要否	省略可
タイプ	文字列

なし

この要素を省略した場合、ポリシーの name 属性の値が使用されます。

要否省略可

タイプ文字列

<ClassName> 要素

JavaCallout ポリシーで実行される Java クラスの名前を指定します。クラスは、<ResourceURL> で指定された JAR ファイルに含める必要があります。Java Callout の作成方法もご覧ください。

<JavaCallout name="MyJavaCalloutPolicy">
   <ResourceURL>java://MyJavaCallout.jar</ResourceURL>
   <ClassName>com.example.mypolicy.MyJavaCallout</ClassName>
</JavaCallout>

デフォルト:	なし
要否:	必須
型:	文字列

<Properties> 要素

Java コードからランタイム時にアクセスできるプロパティを追加します。

<Properties>
    <Property name="propName">propertyValue</Property>
</Properties>

デフォルト:	なし
要否:	省略可
型:	文字列

<Property> 要素

Java コードからランタイム時にアクセスできるプロパティを指定します。各プロパティにリテラル文字列値を指定する必要があります。この要素ではフロー変数を参照できません。プロパティを使用する実際の例については、JavaCallout ポリシーのプロパティの使用方法をご覧ください。

<Properties>
    <Property name="propName">propertyValue</Property>
</Properties>

デフォルト:	なし
要否:	省略可
型:	文字列

属性

属性	説明	デフォルト	要否
name	プロパティの名前を指定します。	なし	必須。

<ResourceURL> 要素

この要素には、JavaCallout ポリシーで実行される Java JAR ファイルを指定します。

このファイルを、API プロキシスコープ（API プロキシバンドルの /apiproxy/resources/java または API プロキシエディタの [Navigator] ペインの [Scripts] セクション）で、もしくは組織または環境スコープで保存して、複数の API プロキシ間で再利用できます。詳しくは、リソースファイルをご覧ください。

<JavaCallout name="MyJavaCalloutPolicy">
   <ResourceURL>java://MyJavaCallout.jar</ResourceURL>
   <ClassName>com.example.mypolicy.MyJavaCallout</ClassName>
</JavaCallout>

デフォルト:	なし
要否:	必須
型:	文字列

エラーリファレンス

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Cause	Fix
`steps.javacallout.ExecutionError`	`500`	Occurs when Java code throws an exception or returns null during the execution of a `JavaCallout policy`.

Deployment errors

These errors can occur when the proxy containing the policy is deployed.

Error name	Fault string	HTTP status	Occurs when
`ResourceDoesNotExist`	`Resource with name [name] and type [type] does not exist`	N/A	The file specified in the `<ResourceURL>` element does not exist.
`JavaCalloutInstantiationFailed`	`Failed to instantiate the JavaCallout Class [classname]`	N/A	The class file specified in the `<ClassName>` element is not in the jar.
`IncompatibleJavaVersion`	`Failed to load java class [classname] definition due to - [reason]`	N/A	See fault string. Supported Java versions include: Oracle JDK 7/8 and OpenJDK 7/8
`JavaClassNotFoundInJavaResource`	`Failed to find the ClassName in java resource [jar_name] - [class_name]`	N/A	See fault string.
`JavaClassDefinitionNotFound`	`Failed to load java class [class_name] definition due to - [reason]`	N/A	See fault string.
`NoAppropriateConstructor`	`No appropriate constructor found in JavaCallout class [class_name]`	N/A	See fault string.
`NoResourceForURL`	`Could not locate a resource with URL [string]`	N/A	See fault string.

Fault variables

These variables are set when this policy triggers an error. For more information, see What you need to know about policy errors.

Variables	Where	Example
`fault.name="fault_name"`	`fault_name` is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code.	`fault.name Matches "ExecutionError"`
`javacallout.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`javacallout.JC-GetUserData.failed = true`

Example error response

{  
   "fault":{  
      "faultstring":"Failed to execute JavaCallout. [policy_name]",
      "detail":{  
         "errorcode":"javacallout.ExecutionError"
      }
   }
}

Example fault rule

<FaultRule name="JavaCalloutFailed">
    <Step>
        <Name>AM-JavaCalloutError</Name>
    </Step>
    <Condition>(fault.name Matches "ExecutionError") </Condition>
</FaultRule>

スキーマ

サンプル: 各ポリシータイプは XML スキーマ（.xsd）によって定義されます。参照用のポリシースキーマは GitHub から入手できます。

コンパイルとデプロイ

カスタム Java コードをコンパイルしてプロキシと一緒にデプロイする方法については、Java Callout の作成方法をご覧ください。

制限事項

Java Callout コードを作成する場合は、次の制限事項に注意してください。

システムコールの大部分は許可されません。たとえば、内部ファイルシステムの読み込み、書き込みはできません。
ネットワークにはソケット経由でアクセスします。Apigee では sitelocal、anylocal、loopback、linklocal の各アドレスへのアクセスが制限されます。
Java Callout ではマシン上の現在のプロセス、プロセスリスト、CPU / メモリ使用率に関する情報を取得できません。このような呼び出しには機能するものもありますが、サポート対象外のため、無効化される可能性があります。上位互換性を維持するため、このような呼び出しはコード内に作成しないでください。
Apigee に含まれる Java ライブラリへの依存はサポートされていません。こうしたライブラリは Apigee プロダクトの機能専用であり、ライブラリがリリース間で使用できることが保証されているわけではありません。
Java Callout でパッケージ名として io.apigee または com.apigee を使用しないでください。これらの名前は予約されており、他の Apigee モジュールで使用されています。

パッケージ化

JAR を API プロキシの /resources/java の下に配置します。JavaCallout コードが、独立した JAR ファイルとしてパッケージされた追加のライブラリに依存している場合は、実行時に正しく読み込まれるように /resources/java ディレクトリに配置します。

管理 UI を使用してプロキシを作成または変更している場合は、新しいリソースを追加し、追加の JAR 従属ファイルを指定します。複数の JAR がある場合は、追加リソースとして追加するだけで済みます。追加の JAR ファイルを参照するようにポリシーの構成を変更する必要はありません。/resources/java で指定するだけで十分です。

Java JAR のアップロードの詳細については、リソースファイルをご覧ください。

Maven または javac を使用して、JavaCallout ポリシーをパッケージ化してデプロイする方法の詳細な例については、Java コールアウトの作成方法をご覧ください。

Javadoc

Java Callout コードを作成するための Javadoc は GitHub のこちらにあります。HTML のクローンを作成するか、システムにダウンロードしてから、ブラウザで index.html ファイルを開く必要があります。

使用上の注意とベストプラクティス

複数の JavaCallout ポリシーを使用して操作する場合は、共通の JAR を環境スコープのリソースとしてアップロードすることを検討してください。この手法は、同じ環境にデプロイする場合に、同じ JAR を複数のプロキシバンドルとともにパッケージ化するよりも効率的です。
同じ JAR ファイルの複数のコピーやバージョンをパッケージ化して環境にデプロイしないでください。たとえば、以下を避けることをおすすめします。
- プロキシバンドルの一部として、または環境リソースとして同じ JAR をデプロイする。
- JAR ファイルの 1 つのバージョンを環境リソースとして、もう 1 つをプロキシバンドルの一部としてデプロイする。
同じ JAR の複数のコピーをデプロイすると、ClassLoader が競合する可能性があるため、実行時に非決定的な動作が発生する可能性があります。
JavaCallout ポリシーに実際のコードは含まれていません。代わりに、ポリシーは Java のリソースを参照し、Java コードが実行される API フローにステップを定義します。Management UI のプロキシエディタで Java JAR をアップロードするか、ローカルで開発している API プロキシの /resources/java ディレクトリにスクリプトを含めることができます。
リモートサービスに対する API 呼び出しなど、単純な操作には、ServiceCallout ポリシーを使用することをおすすめします。ServiceCallout ポリシーをご覧ください。
HTTP ヘッダー、パラメータ、メッセージコンテンツの変更や抽出など、比較的単純なメッセージコンテンツの操作には、JavaScript ポリシーを使用することをおすすめします。