Package org.apache.camel.builder.endpoint.dsl

Interface RestEndpointBuilderFactory.RestEndpointConsumerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
    All Known Subinterfaces:
    RestEndpointBuilderFactory.RestEndpointBuilder
    Enclosing interface:
    RestEndpointBuilderFactory
    public static interface RestEndpointBuilderFactory.RestEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
    Builder for endpoint consumers for the REST component.

    • Method Detail

      • consumes

        default RestEndpointBuilderFactory.RestEndpointConsumerBuilder consumes​(String consumes)
        Media type such as: 'text/xml', or 'application/json' this REST service accepts. By default we accept all kinds of types. The option is a: <code>java.lang.String</code> type. Group: common
        Parameters:
        consumes - the value to set
        Returns:
        the dsl builder

      • produces

        default RestEndpointBuilderFactory.RestEndpointConsumerBuilder produces​(String produces)
        Media type such as: 'text/xml', or 'application/json' this REST service returns. The option is a: <code>java.lang.String</code> type. Group: common
        Parameters:
        produces - the value to set
        Returns:
        the dsl builder

      • bridgeErrorHandler

        default RestEndpointBuilderFactory.RestEndpointConsumerBuilder 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 RestEndpointBuilderFactory.RestEndpointConsumerBuilder 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 RestEndpointBuilderFactory.RestEndpointConsumerBuilder 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

      • description

        default RestEndpointBuilderFactory.RestEndpointConsumerBuilder description​(String description)
        Human description to document this REST service. The option is a: <code>java.lang.String</code> type. Group: consumer
        Parameters:
        description - the value to set
        Returns:
        the dsl builder