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

Interface HttpEndpointBuilderFactory.HttpEndpointBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
    Enclosing interface:
    HttpEndpointBuilderFactory
    public static interface HttpEndpointBuilderFactory.HttpEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
    Builder for endpoint for the HTTP component.

    • Method Detail

      • chunked

        default HttpEndpointBuilderFactory.HttpEndpointBuilder chunked​(boolean chunked)
        If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response. The option is a: <code>boolean</code> type. Default: true Group: producer
        Parameters:
        chunked - the value to set
        Returns:
        the dsl builder

      • chunked

        default HttpEndpointBuilderFactory.HttpEndpointBuilder chunked​(String chunked)
        If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response. The option will be converted to a <code>boolean</code> type. Default: true Group: producer
        Parameters:
        chunked - the value to set
        Returns:
        the dsl builder

      • disableStreamCache

        default HttpEndpointBuilderFactory.HttpEndpointBuilder disableStreamCache​(boolean disableStreamCache)
        Determines whether or not the raw input stream from Servlet is cached or not (Camel will read the stream into a in memory/overflow to file, Stream caching) cache. By default Camel will cache the Servlet input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream, such as streaming it directly to a file or other persistent store. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. If you use Servlet to bridge/proxy an endpoint then consider enabling this option to improve performance, in case you do not need to read the message payload multiple times. The http producer will by default cache the response body stream. If setting this option to true, then the producers will not cache the response body stream but use the response stream as-is as the message body. The option is a: <code>boolean</code> type. Default: false Group: common
        Parameters:
        disableStreamCache - the value to set
        Returns:
        the dsl builder

      • disableStreamCache

        default HttpEndpointBuilderFactory.HttpEndpointBuilder disableStreamCache​(String disableStreamCache)
        Determines whether or not the raw input stream from Servlet is cached or not (Camel will read the stream into a in memory/overflow to file, Stream caching) cache. By default Camel will cache the Servlet input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream, such as streaming it directly to a file or other persistent store. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. If you use Servlet to bridge/proxy an endpoint then consider enabling this option to improve performance, in case you do not need to read the message payload multiple times. The http producer will by default cache the response body stream. If setting this option to true, then the producers will not cache the response body stream but use the response stream as-is as the message body. The option will be converted to a <code>boolean</code> type. Default: false Group: common
        Parameters:
        disableStreamCache - the value to set
        Returns:
        the dsl builder

      • headerFilterStrategy

        default HttpEndpointBuilderFactory.HttpEndpointBuilder headerFilterStrategy​(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
        To use a custom HeaderFilterStrategy to filter header to and from Camel message. The option is a: <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: common
        Parameters:
        headerFilterStrategy - the value to set
        Returns:
        the dsl builder

      • headerFilterStrategy

        default HttpEndpointBuilderFactory.HttpEndpointBuilder headerFilterStrategy​(String headerFilterStrategy)
        To use a custom HeaderFilterStrategy to filter header to and from Camel message. The option will be converted to a <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: common
        Parameters:
        headerFilterStrategy - the value to set
        Returns:
        the dsl builder

      • bridgeEndpoint

        default HttpEndpointBuilderFactory.HttpEndpointBuilder bridgeEndpoint​(boolean bridgeEndpoint)
        If the option is true, HttpProducer will ignore the Exchange.HTTP_URI header, and use the endpoint's URI for request. You may also set the option throwExceptionOnFailure to be false to let the HttpProducer send all the fault response back. The option is a: <code>boolean</code> type. Default: false Group: producer
        Parameters:
        bridgeEndpoint - the value to set
        Returns:
        the dsl builder

      • bridgeEndpoint

        default HttpEndpointBuilderFactory.HttpEndpointBuilder bridgeEndpoint​(String bridgeEndpoint)
        If the option is true, HttpProducer will ignore the Exchange.HTTP_URI header, and use the endpoint's URI for request. You may also set the option throwExceptionOnFailure to be false to let the HttpProducer send all the fault response back. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
        Parameters:
        bridgeEndpoint - the value to set
        Returns:
        the dsl builder

      • clearExpiredCookies

        default HttpEndpointBuilderFactory.HttpEndpointBuilder clearExpiredCookies​(boolean clearExpiredCookies)
        Whether to clear expired cookies before sending the HTTP request. This ensures the cookies store does not keep growing by adding new cookies which is newer removed when they are expired. If the component has disabled cookie management then this option is disabled too. The option is a: <code>boolean</code> type. Default: true Group: producer
        Parameters:
        clearExpiredCookies - the value to set
        Returns:
        the dsl builder

      • clearExpiredCookies

        default HttpEndpointBuilderFactory.HttpEndpointBuilder clearExpiredCookies​(String clearExpiredCookies)
        Whether to clear expired cookies before sending the HTTP request. This ensures the cookies store does not keep growing by adding new cookies which is newer removed when they are expired. If the component has disabled cookie management then this option is disabled too. The option will be converted to a <code>boolean</code> type. Default: true Group: producer
        Parameters:
        clearExpiredCookies - the value to set
        Returns:
        the dsl builder

      • connectionClose

        default HttpEndpointBuilderFactory.HttpEndpointBuilder connectionClose​(boolean connectionClose)
        Specifies whether a Connection Close header must be added to HTTP Request. By default connectionClose is false. The option is a: <code>boolean</code> type. Default: false Group: producer
        Parameters:
        connectionClose - the value to set
        Returns:
        the dsl builder

      • connectionClose

        default HttpEndpointBuilderFactory.HttpEndpointBuilder connectionClose​(String connectionClose)
        Specifies whether a Connection Close header must be added to HTTP Request. By default connectionClose is false. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
        Parameters:
        connectionClose - the value to set
        Returns:
        the dsl builder

      • copyHeaders

        default HttpEndpointBuilderFactory.HttpEndpointBuilder copyHeaders​(boolean copyHeaders)
        If this option is true then IN exchange headers will be copied to OUT exchange headers according to copy strategy. Setting this to false, allows to only include the headers from the HTTP response (not propagating IN headers). The option is a: <code>boolean</code> type. Default: true Group: producer
        Parameters:
        copyHeaders - the value to set
        Returns:
        the dsl builder

      • copyHeaders

        default HttpEndpointBuilderFactory.HttpEndpointBuilder copyHeaders​(String copyHeaders)
        If this option is true then IN exchange headers will be copied to OUT exchange headers according to copy strategy. Setting this to false, allows to only include the headers from the HTTP response (not propagating IN headers). The option will be converted to a <code>boolean</code> type. Default: true Group: producer
        Parameters:
        copyHeaders - the value to set
        Returns:
        the dsl builder

      • customHostHeader

        default HttpEndpointBuilderFactory.HttpEndpointBuilder customHostHeader​(String customHostHeader)
        To use custom host header for producer. When not set in query will be ignored. When set will override host header derived from url. The option is a: <code>java.lang.String</code> type. Group: producer
        Parameters:
        customHostHeader - the value to set
        Returns:
        the dsl builder

      • httpMethod

        default HttpEndpointBuilderFactory.HttpEndpointBuilder httpMethod​(String httpMethod)
        Configure the HTTP method to use. The HttpMethod header cannot override this option if set. The option will be converted to a <code>org.apache.camel.http.common.HttpMethods</code> type. Group: producer
        Parameters:
        httpMethod - the value to set
        Returns:
        the dsl builder

      • ignoreResponseBody

        default HttpEndpointBuilderFactory.HttpEndpointBuilder ignoreResponseBody​(boolean ignoreResponseBody)
        If this option is true, The http producer won't read response body and cache the input stream. The option is a: <code>boolean</code> type. Default: false Group: producer
        Parameters:
        ignoreResponseBody - the value to set
        Returns:
        the dsl builder

      • ignoreResponseBody

        default HttpEndpointBuilderFactory.HttpEndpointBuilder ignoreResponseBody​(String ignoreResponseBody)
        If this option is true, The http producer won't read response body and cache the input stream. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
        Parameters:
        ignoreResponseBody - the value to set
        Returns:
        the dsl builder

      • lazyStartProducer

        default HttpEndpointBuilderFactory.HttpEndpointBuilder 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

      • lazyStartProducer

        default HttpEndpointBuilderFactory.HttpEndpointBuilder lazyStartProducer​(String 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 will be converted to a <code>boolean</code> type. Default: false Group: producer
        Parameters:
        lazyStartProducer - the value to set
        Returns:
        the dsl builder

      • preserveHostHeader

        default HttpEndpointBuilderFactory.HttpEndpointBuilder preserveHostHeader​(boolean preserveHostHeader)
        If the option is true, HttpProducer will set the Host header to the value contained in the current exchange Host header, useful in reverse proxy applications where you want the Host header received by the downstream server to reflect the URL called by the upstream client, this allows applications which use the Host header to generate accurate URL's for a proxied service. The option is a: <code>boolean</code> type. Default: false Group: producer
        Parameters:
        preserveHostHeader - the value to set
        Returns:
        the dsl builder

      • preserveHostHeader

        default HttpEndpointBuilderFactory.HttpEndpointBuilder preserveHostHeader​(String preserveHostHeader)
        If the option is true, HttpProducer will set the Host header to the value contained in the current exchange Host header, useful in reverse proxy applications where you want the Host header received by the downstream server to reflect the URL called by the upstream client, this allows applications which use the Host header to generate accurate URL's for a proxied service. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
        Parameters:
        preserveHostHeader - the value to set
        Returns:
        the dsl builder

      • throwExceptionOnFailure

        default HttpEndpointBuilderFactory.HttpEndpointBuilder throwExceptionOnFailure​(boolean throwExceptionOnFailure)
        Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code. The option is a: <code>boolean</code> type. Default: true Group: producer
        Parameters:
        throwExceptionOnFailure - the value to set
        Returns:
        the dsl builder

      • throwExceptionOnFailure

        default HttpEndpointBuilderFactory.HttpEndpointBuilder throwExceptionOnFailure​(String throwExceptionOnFailure)
        Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code. The option will be converted to a <code>boolean</code> type. Default: true Group: producer
        Parameters:
        throwExceptionOnFailure - the value to set
        Returns:
        the dsl builder

      • transferException

        default HttpEndpointBuilderFactory.HttpEndpointBuilder transferException​(boolean transferException)
        If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. On the producer side the exception will be deserialized and thrown as is, instead of the HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. The option is a: <code>boolean</code> type. Default: false Group: producer
        Parameters:
        transferException - the value to set
        Returns:
        the dsl builder

      • transferException

        default HttpEndpointBuilderFactory.HttpEndpointBuilder transferException​(String transferException)
        If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. On the producer side the exception will be deserialized and thrown as is, instead of the HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
        Parameters:
        transferException - the value to set
        Returns:
        the dsl builder

      • proxyAuthDomain

        default HttpEndpointBuilderFactory.HttpEndpointBuilder proxyAuthDomain​(String proxyAuthDomain)
        Proxy authentication domain to use with NTML. The option is a: <code>java.lang.String</code> type. Group: proxy
        Parameters:
        proxyAuthDomain - the value to set
        Returns:
        the dsl builder

      • proxyAuthHost

        default HttpEndpointBuilderFactory.HttpEndpointBuilder proxyAuthHost​(String proxyAuthHost)
        Proxy authentication host. The option is a: <code>java.lang.String</code> type. Group: proxy
        Parameters:
        proxyAuthHost - the value to set
        Returns:
        the dsl builder

      • proxyAuthMethod

        default HttpEndpointBuilderFactory.HttpEndpointBuilder proxyAuthMethod​(String proxyAuthMethod)
        Proxy authentication method to use. The option is a: <code>java.lang.String</code> type. Group: proxy
        Parameters:
        proxyAuthMethod - the value to set
        Returns:
        the dsl builder

      • proxyAuthNtHost

        default HttpEndpointBuilderFactory.HttpEndpointBuilder proxyAuthNtHost​(String proxyAuthNtHost)
        Proxy authentication domain (workstation name) to use with NTML. The option is a: <code>java.lang.String</code> type. Group: proxy
        Parameters:
        proxyAuthNtHost - the value to set
        Returns:
        the dsl builder

      • proxyAuthPassword

        default HttpEndpointBuilderFactory.HttpEndpointBuilder proxyAuthPassword​(String proxyAuthPassword)
        Proxy authentication password. The option is a: <code>java.lang.String</code> type. Group: proxy
        Parameters:
        proxyAuthPassword - the value to set
        Returns:
        the dsl builder

      • proxyAuthPort

        default HttpEndpointBuilderFactory.HttpEndpointBuilder proxyAuthPort​(Integer proxyAuthPort)
        Proxy authentication port. The option is a: <code>java.lang.Integer</code> type. Group: proxy
        Parameters:
        proxyAuthPort - the value to set
        Returns:
        the dsl builder

      • proxyAuthPort

        default HttpEndpointBuilderFactory.HttpEndpointBuilder proxyAuthPort​(String proxyAuthPort)
        Proxy authentication port. The option will be converted to a <code>java.lang.Integer</code> type. Group: proxy
        Parameters:
        proxyAuthPort - the value to set
        Returns:
        the dsl builder

      • proxyAuthScheme

        default HttpEndpointBuilderFactory.HttpEndpointBuilder proxyAuthScheme​(String proxyAuthScheme)
        Proxy authentication scheme to use. The option is a: <code>java.lang.String</code> type. Group: proxy
        Parameters:
        proxyAuthScheme - the value to set
        Returns:
        the dsl builder

      • proxyAuthUsername

        default HttpEndpointBuilderFactory.HttpEndpointBuilder proxyAuthUsername​(String proxyAuthUsername)
        Proxy authentication username. The option is a: <code>java.lang.String</code> type. Group: proxy
        Parameters:
        proxyAuthUsername - the value to set
        Returns:
        the dsl builder

      • proxyPort

        default HttpEndpointBuilderFactory.HttpEndpointBuilder proxyPort​(int proxyPort)
        Proxy port to use. The option is a: <code>int</code> type. Group: proxy
        Parameters:
        proxyPort - the value to set
        Returns:
        the dsl builder

      • authDomain

        default HttpEndpointBuilderFactory.HttpEndpointBuilder authDomain​(String authDomain)
        Authentication domain to use with NTML. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        authDomain - the value to set
        Returns:
        the dsl builder

      • authenticationPreemptive

        default HttpEndpointBuilderFactory.HttpEndpointBuilder authenticationPreemptive​(boolean authenticationPreemptive)
        If this option is true, camel-http sends preemptive basic authentication to the server. The option is a: <code>boolean</code> type. Default: false Group: security
        Parameters:
        authenticationPreemptive - the value to set
        Returns:
        the dsl builder

      • authenticationPreemptive

        default HttpEndpointBuilderFactory.HttpEndpointBuilder authenticationPreemptive​(String authenticationPreemptive)
        If this option is true, camel-http sends preemptive basic authentication to the server. The option will be converted to a <code>boolean</code> type. Default: false Group: security
        Parameters:
        authenticationPreemptive - the value to set
        Returns:
        the dsl builder

      • authHost

        default HttpEndpointBuilderFactory.HttpEndpointBuilder authHost​(String authHost)
        Authentication host to use with NTML. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        authHost - the value to set
        Returns:
        the dsl builder

      • authMethod

        default HttpEndpointBuilderFactory.HttpEndpointBuilder authMethod​(String authMethod)
        Authentication methods allowed to use as a comma separated list of values Basic, Digest or NTLM. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        authMethod - the value to set
        Returns:
        the dsl builder

      • authMethodPriority

        default HttpEndpointBuilderFactory.HttpEndpointBuilder authMethodPriority​(String authMethodPriority)
        Which authentication method to prioritize to use, either as Basic, Digest or NTLM. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        authMethodPriority - the value to set
        Returns:
        the dsl builder

      • authPassword

        default HttpEndpointBuilderFactory.HttpEndpointBuilder authPassword​(String authPassword)
        Authentication password. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        authPassword - the value to set
        Returns:
        the dsl builder

      • authUsername

        default HttpEndpointBuilderFactory.HttpEndpointBuilder authUsername​(String authUsername)
        Authentication username. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        authUsername - the value to set
        Returns:
        the dsl builder

      • sslContextParameters

        default HttpEndpointBuilderFactory.HttpEndpointBuilder sslContextParameters​(Object sslContextParameters)
        To configure security using SSLContextParameters. Important: Only one instance of org.apache.camel.util.jsse.SSLContextParameters is supported per HttpComponent. If you need to use 2 or more different instances, you need to define a new HttpComponent per instance you need. The option is a: <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security
        Parameters:
        sslContextParameters - the value to set
        Returns:
        the dsl builder

      • sslContextParameters

        default HttpEndpointBuilderFactory.HttpEndpointBuilder sslContextParameters​(String sslContextParameters)
        To configure security using SSLContextParameters. Important: Only one instance of org.apache.camel.util.jsse.SSLContextParameters is supported per HttpComponent. If you need to use 2 or more different instances, you need to define a new HttpComponent per instance you need. The option will be converted to a <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security
        Parameters:
        sslContextParameters - the value to set
        Returns:
        the dsl builder

      • x509HostnameVerifier

        default HttpEndpointBuilderFactory.HttpEndpointBuilder x509HostnameVerifier​(Object x509HostnameVerifier)
        To use a custom X509HostnameVerifier such as DefaultHostnameVerifier or NoopHostnameVerifier. The option is a: <code>javax.net.ssl.HostnameVerifier</code> type. Group: security
        Parameters:
        x509HostnameVerifier - the value to set
        Returns:
        the dsl builder

      • x509HostnameVerifier

        default HttpEndpointBuilderFactory.HttpEndpointBuilder x509HostnameVerifier​(String x509HostnameVerifier)
        To use a custom X509HostnameVerifier such as DefaultHostnameVerifier or NoopHostnameVerifier. The option will be converted to a <code>javax.net.ssl.HostnameVerifier</code> type. Group: security
        Parameters:
        x509HostnameVerifier - the value to set
        Returns:
        the dsl builder