Red Hat Summit Red Hat Summitサポートコンソール開発者トライアルの開始お問い合わせ

47.7. 追加オプション

概要
リンクのコピー

extraOptions オプションは通常より簡単なオプションを提供することで、複雑な API パラメーターを計算または非表示するために使用されます。たとえば、API メソッドには POJO オプションが使用される場合がありまが、これは URI 内の POJO の一部としてより簡単に提供することができます。コンポーネントは、パーツを追加オプションとして付与し、内部で POJO パラメーターを作成することでこれを行うことができます。これらの追加オプションの実装を完了するには、EndpointConsumer や EndpointProducer クラスで interceptProperties メソッドをオーバーライドする必要もあります (「プログラミングモデル」 を参照)。

構文
リンクのコピー

extraOptions 要素は、以下のように 1 つ以上の extraOption 子要素で定義できます。 

<extraOptions>
  <extraOption>
    <type>TypeName</type>
    <name>OptionName</name>
  </extraOption>
</extraOptions>
Copy to Clipboard Toggle word wrap

TypeName は追加オプションの完全修飾型名であり、OptionName は追加 URI オプションの名前です。

Scope
リンクのコピー

以下の抜粋で示されているように、extraOptions 要素は、任意で apis 要素の子や api 要素の子として表示できます。 

<configuration>
  <apis>
    <api>
      <apiName>...</apiName>
      ...
      <extraOptions>...</extraOptions>
    </api>
    <extraOptions>...</extraOptions>
    ...
  </apis>
</configuration>
Copy to Clipboard Toggle word wrap

以下のスコープで extraOptions 要素を定義できます。

  • api 要素の子として: extraOptions は api 要素で指定された API クラスにのみ適用されます。
  • apis 要素の子として: extraOptions はデフォルトですべての API クラスに適用されますが、api レベルで上書きできます。

子要素
リンクのコピー

それぞれの extraOptions 要素は、以下の子要素で定義できます。

type
追加オプションの完全修飾型名を指定します。
name
エンドポイント URI に表示されるオプション名を指定します。

例
リンクのコピー

以下の例は、java.util.list<String> タイプの追加の URI オプションである customOption を定義します。 

<extraOptions>
  <extraOption>
    <type>java.util.List<String></type>
    <name>customOption</name>
  </extraOption>
</extraOptions>
Copy to Clipboard Toggle word wrap
トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat