46.4. プログラミングモデル

(任意) コンポーネントが停止している間にコードを呼び出すコールバック。コンポーネントを停止すると、そのリソースがすべてシャットダウンされ、内部状態が削除され、キャッシュが消去されることを意味します。

この方法で必要なのは、API 名に一致するプロキシークラス (API クラス) を作成することです。継承された apiName フィールドまたは getApiName アクセッサーを介して、(すでにエンドポイント URI から抽出されている) API 名を利用できます。通常、apiName フィールドでスイッチを実行して、対応するプロキシークラスを作成します。以下に例を示します。

// Java
private Object apiProxy;
...
@Override
protected void afterConfigureProperties() {
    // TODO create API proxy, set connection properties, etc.
    switch (apiName) {
        case HELLO_FILE:
            apiProxy = new ExampleFileHello();
            break;
        case HELLO_JAVADOC:
            apiProxy = new ExampleJavadocHello();
            break;
        default:
            throw new IllegalArgumentException("Invalid API name " + apiName);
    }
}

このメソッドを上書きして、afterConfigureProperties で作成したプロキシーインスタンスを返します。以下に例を示します。

@Override
public Object getApiProxy(ApiMethod method, Map<String, Object> args) {
    return apiProxy;
}

特殊なケースでは、API メソッドおよび引数に依存するプロキシーを選択する必要がある場合があります。必要に応じて、getApiProxy で、このアプローチを柔軟に行うことができます。

(任意) API コンポーネントフレームワークは、エンドポイント URI と指定されたオプション値を使用して、呼び出す方法を決定します (オーバーロードおよびエイリアスによる曖昧さ)。ただし、コンポーネントが内部的にオプションまたはメソッドパラメーターを追加する場合、このフレームワークでは呼び出す適切な方法を判断するためにヘルプが必要になる場合があります。この場合、interceptPropertyNames メソッドをオーバーライドし、追加の (非表示または暗黙的) オプションを propertyNames セットに追加する必要があります。メソッドパラメーターの完全なリストが propertyNames セットにあると、フレームワークは呼び出す適切なメソッドを特定できます。

(任意) このメソッドを上書きすると、API メソッドが呼び出される前に、オプションの実際の値を変更または設定できます。たとえば、この方法を使用して、必要に応じて、一部のオプションにデフォルト値を設定できます。実際には、interceptPropertyNames メソッドおよび interceptProperty メソッドの両方を上書きする必要があることが多いです。

(任意) このメソッドを上書きすると、Java API メソッドの呼び出しを妨害できます。このメソッドを上書きする最も一般的な理由は、メソッド呼び出しに関するエラー処理をカスタマイズすることです。たとえば、以下のコードフラグメントに doInvokeMethod を上書きする一般的な方法が示されています。

// Java
@Override
protected Object doInvokeMethod(Map<String, Object> args) {
    try {
        return super.doInvokeMethod(args);
    } catch (RuntimeCamelException e) {
        // TODO - Insert custom error handling here!
        ...
    }
}

Java API メソッドが呼び出されるように、この実装のある時点で doInvokeMethod をスーパークラスで呼び出す必要があります。

(任意) デフォルトでは、メソッド API 呼び出しの結果が java.util.Collection オブジェクトまたは Java 配列である場合、API コンポーネントフレームワークは結果を 複数 のエクスチェンジオブジェクトに分割します (したがって、単一の呼び出しの結果が複数のメッセージに変換されます)。

デフォルトの動作を変更する場合は、コンシューマーエンドポイントで splitResult メソッドを上書きすることができます。result 引数には、API メッセージ呼び出しの結果が含まれます。結果を分割する場合は、配列タイプを返す必要があります。