47.5. 引数名の置換

API コンポーネントフレームワークでは、URI オプション名が 各プロキシークラス (Java API クラス) 内で一意 である必要があります。しかし、メソッドの引数名の場合は、必ずしもそうとは限りません。たとえば、API クラスの以下の Java メソッドについて考えてみましょう。

public void doSomething(int id, String name);
public void doSomethingElse(int id, String name);

Maven プロジェクトのビルド時、camel-api-component-maven-plugin は設定クラス ProxyClassEndpointConfiguration を生成します。これには、ProxyClass クラスのすべての引数の getter および setter メソッドが含まれます。たとえば、上記のメソッドを指定すると、プラグインは設定クラスに以下の getter メソッドと setter メソッドを生成します。

public int  getId();
public void setId(int id);
public String getName();
public void   setName(String name);

ただし、以下の例のように、id 引数が異なるタイプとして複数回表示された場合はどうなるでしょうか。

public void doSomething(int id, String name);
public void doSomethingElse(int id, String name);
public String lookupByID(String id);

この場合、コードの生成に失敗します。これは、int を返す getId メソッドと、String を返す getId メソッドを同じスコープで定義できないためです。この問題に対する解決策は、引数名の置換を使用して、引数名と URI オプション名のマッピングをカスタマイズすることです。

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

<substitutions>
  <substitution>
    <method>MethodPattern</method>
    <argName>ArgumentNamePattern</argName>
    <argType>TypeNamePattern</argType>
    <replacement>SubstituteArgName</replacement>
    <replaceWithType>[true|false]</replaceWithType>
  </substitution>
  ...
</substitutions>

argType 要素と replaceWithType 要素は任意であり、省略できます。

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

<configuration>
  <apis>
    <api>
      <apiName>...</apiName>
      ...
      <substitutions>...</substitutions>
    </api>
    <substitutions>...</substitutions>
    ...
  </apis>
</configuration>

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

各 substitution 要素は以下の子要素で定義できます。

以下の置換例は、接尾辞 Param を引数名に追加して、java.lang.String タイプのすべての引数を変更します。

<substitutions>
  <substitution>
    <method>^.+$</method>
    <argName>^.+$</argName>
    <argType>java.lang.String</argType>
    <replacement>$1Param</replacement>
    <replaceWithType>false</replaceWithType>
  </substitution>
</substitutions>

たとえば、次のようなメソッドの署名があるとします。

public String greetUs(String name1, String name2);

このメソッドの引数は、エンドポイント URI でオプション name1Param および name2Param で指定されます。