56.6. Excluded Arguments

Overview

Sometimes, you might need to exclude certain arguments, when it comes to mapping Java arguments to URI options. You can filter out unwanted arguments by specifying either the excludeConfigNames element or the excludeConfigTypes element in the camel-api-component-maven-plugin plug-in configuration.

Syntax

The excludeConfigNames element and the excludeConfigTypes element are specified as follows:
<excludeConfigNames>ArgumentNamePattern</excludeConfigNames>
<excludeConfigTypes>TypeNamePattern</excludeConfigTypes>
Where ArgumentNamePattern and TypeNamePattern are regular expressions that match the argument name and the argument type, respectively.

Scope

As shown in the following extract, the excludeConfigNames element and the excludeConfigTypes element can optionally appear as children of the apis element and/or as children of api elements:
<configuration>
  <apis>
    <api>
      <apiName>...</apiName>
      ...
 <excludeConfigNames>...</excludeConfigNames>
 <excludeConfigTypes>...</excludeConfigTypes>
    </api>
 <excludeConfigNames>...</excludeConfigNames>
 <excludeConfigTypes>...</excludeConfigTypes>
    ...
  </apis>
</configuration>
You can define the excludeConfigNames element and the excludeConfigTypes element at the following scopes:
  • As a child of an api element—the exclusions apply only to the API class specified by the api element.
  • As a child of the apis element—the exclusions apply to all API classes by default, but can be overridden at the api level.

Elements

The following elements can be used to exclude arguments from the API mapping (so that they are unavailable as URI options):
excludeConfigNames
Specifies a regular expression (java.util.regex syntax) for excluding arguments, based on matching the argument name.
excludeConfigTypes
Specifies a regular expression (java.util.regex syntax) for excluding arguments, based on matching the argument type.