Package org.apache.camel.builder.component.dsl

Interface RestApiComponentBuilderFactory.RestApiComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.rest.RestApiComponent>
All Known Implementing Classes:
RestApiComponentBuilderFactory.RestApiComponentBuilderImpl
Enclosing interface:
RestApiComponentBuilderFactory
public static interface RestApiComponentBuilderFactory.RestApiComponentBuilder extends ComponentBuilder<org.apache.camel.component.rest.RestApiComponent>
Builder for the REST API component.

  • Method Details

    • bridgeErrorHandler

      default RestApiComponentBuilderFactory.RestApiComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
      Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • consumerComponentName

      default RestApiComponentBuilderFactory.RestApiComponentBuilder consumerComponentName(String consumerComponentName)
      The Camel Rest API component to use for the consumer REST transport, such as jetty, servlet, undertow. If no component has been explicitly configured, then Camel will lookup if there is a Camel component that integrates with the Rest DSL, or if a org.apache.camel.spi.RestApiConsumerFactory is registered in the registry. If either one is found, then that is being used. The option is a: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      consumerComponentName - the value to set
      Returns:
      the dsl builder

    • autowiredEnabled

      default RestApiComponentBuilderFactory.RestApiComponentBuilder autowiredEnabled(boolean autowiredEnabled)
      Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced
      Parameters:
      autowiredEnabled - the value to set
      Returns:
      the dsl builder