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

Interface RestEndpointComponentBuilderFactory.RestEndpointComponentBuilder

    • Method Detail

      • bridgeErrorHandler

        default RestEndpointComponentBuilderFactory.RestEndpointComponentBuilder 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

      • consumerComponentName

        default RestEndpointComponentBuilderFactory.RestEndpointComponentBuilder 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

      • apiDoc

        default RestEndpointComponentBuilderFactory.RestEndpointComponentBuilder apiDoc​(String apiDoc)
        The swagger api doc resource to use. The resource is loaded from classpath by default and must be in JSON format. The option is a: <code>java.lang.String</code> type. Group: producer
        Parameters:
        apiDoc - the value to set
        Returns:
        the dsl builder

      • componentName

        @Deprecated
default RestEndpointComponentBuilderFactory.RestEndpointComponentBuilder componentName​(String componentName)
        Deprecated.
        The Camel Rest component to use for (producer) the REST transport, such as http, 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.RestProducerFactory 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: producer
        Parameters:
        componentName - the value to set
        Returns:
        the dsl builder

      • lazyStartProducer

        default RestEndpointComponentBuilderFactory.RestEndpointComponentBuilder lazyStartProducer​(boolean lazyStartProducer)
        Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer
        Parameters:
        lazyStartProducer - the value to set
        Returns:
        the dsl builder

      • producerComponentName

        default RestEndpointComponentBuilderFactory.RestEndpointComponentBuilder producerComponentName​(String producerComponentName)
        The Camel Rest component to use for (producer) the REST transport, such as http, 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.RestProducerFactory 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: producer
        Parameters:
        producerComponentName - the value to set
        Returns:
        the dsl builder

      • autowiredEnabled

        default RestEndpointComponentBuilderFactory.RestEndpointComponentBuilder 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