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

Interface RestEndpointBuilderFactory.RestEndpointProducerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
    All Known Subinterfaces:
    RestEndpointBuilderFactory.RestEndpointBuilder
    Enclosing interface:
    RestEndpointBuilderFactory
    public static interface RestEndpointBuilderFactory.RestEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
    Builder for endpoint producers for the REST component.

    • Method Detail

      • consumes

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

      • apiDoc

        default RestEndpointBuilderFactory.RestEndpointProducerBuilder apiDoc​(String apiDoc)
        The openapi 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

      • bindingMode

        default RestEndpointBuilderFactory.RestEndpointProducerBuilder bindingMode​(org.apache.camel.spi.RestConfiguration.RestBindingMode bindingMode)
        Configures the binding mode for the producer. If set to anything other than 'off' the producer will try to convert the body of the incoming message from inType to the json or xml, and the response from json or xml to outType. The option is a: <code>org.apache.camel.spi.RestConfiguration.RestBindingMode</code> type. Group: producer
        Parameters:
        bindingMode - the value to set
        Returns:
        the dsl builder

      • bindingMode

        default RestEndpointBuilderFactory.RestEndpointProducerBuilder bindingMode​(String bindingMode)
        Configures the binding mode for the producer. If set to anything other than 'off' the producer will try to convert the body of the incoming message from inType to the json or xml, and the response from json or xml to outType. The option will be converted to a <code>org.apache.camel.spi.RestConfiguration.RestBindingMode</code> type. Group: producer
        Parameters:
        bindingMode - the value to set
        Returns:
        the dsl builder

      • producerComponentName

        default RestEndpointBuilderFactory.RestEndpointProducerBuilder producerComponentName​(String producerComponentName)
        The Camel Rest component to use for the producer REST transport, such as http, 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.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

      • queryParameters

        default RestEndpointBuilderFactory.RestEndpointProducerBuilder queryParameters​(String queryParameters)
        Query parameters for the HTTP service to call. The query parameters can contain multiple parameters separated by ampersand such such as foo=123&amp;bar=456. The option is a: <code>java.lang.String</code> type. Group: producer
        Parameters:
        queryParameters - the value to set
        Returns:
        the dsl builder