org.apache.camel.builder.endpoint.dsl

Interface RestApiEndpointBuilderFactory.RestApiEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver

Enclosing interface:

RestApiEndpointBuilderFactory

public static interface RestApiEndpointBuilderFactory.RestApiEndpointBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder

Builder for endpoint for the REST API component.

Method Summary

Modifier and Type	Method and Description
default RestApiEndpointBuilderFactory.AdvancedRestApiEndpointBuilder	advanced()
default RestApiEndpointBuilderFactory.RestApiEndpointBuilder	apiComponentName(String apiComponentName) The Camel Rest API component to use for generating the API of the REST services, such as openapi.
default RestApiEndpointBuilderFactory.RestApiEndpointBuilder	bridgeErrorHandler(boolean bridgeErrorHandler) Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler.
default RestApiEndpointBuilderFactory.RestApiEndpointBuilder	bridgeErrorHandler(String bridgeErrorHandler) Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler.
default RestApiEndpointBuilderFactory.RestApiEndpointBuilder	consumerComponentName(String consumerComponentName) The Camel Rest component to use for (consumer) the REST transport, such as jetty, servlet, undertow.

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Method Detail

advanced

default RestApiEndpointBuilderFactory.AdvancedRestApiEndpointBuilder advanced()

apiComponentName

default RestApiEndpointBuilderFactory.RestApiEndpointBuilder apiComponentName(String apiComponentName)

The Camel Rest API component to use for generating the API of the REST services, such as openapi. The option is a: <code>java.lang.String</code> type. Group: consumer

Parameters:

apiComponentName - the value to set

Returns:

the dsl builder

bridgeErrorHandler

default RestApiEndpointBuilderFactory.RestApiEndpointBuilder bridgeErrorHandler(boolean bridgeErrorHandler)

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. 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

bridgeErrorHandler

default RestApiEndpointBuilderFactory.RestApiEndpointBuilder bridgeErrorHandler(String bridgeErrorHandler)

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. 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 will be converted to a <code>boolean</code> type. Default: false Group: consumer

Parameters:

bridgeErrorHandler - the value to set

Returns:

the dsl builder

consumerComponentName

default RestApiEndpointBuilderFactory.RestApiEndpointBuilder consumerComponentName(String consumerComponentName)

The Camel Rest component to use for (consumer) the REST transport, such as jetty, servlet, undertow. If no component has been explicit configured, then Camel will lookup if there is a Camel component that integrates with the Rest DSL, or if a org.apache.camel.spi.RestConsumerFactory 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