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

Interface HttpsComponentBuilderFactory.HttpsComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.http.HttpComponent>
All Known Implementing Classes:
HttpsComponentBuilderFactory.HttpsComponentBuilderImpl
Enclosing interface:
HttpsComponentBuilderFactory
public static interface HttpsComponentBuilderFactory.HttpsComponentBuilder extends ComponentBuilder<org.apache.camel.component.http.HttpComponent>
Builder for the HTTPS (Secure) component.

  • Method Details

    • followRedirects

      default HttpsComponentBuilderFactory.HttpsComponentBuilder followRedirects(boolean followRedirects)
      Whether to the HTTP request should follow redirects. By default the HTTP request does not follow redirects. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      followRedirects - the value to set
      Returns:
      the dsl builder

    • lazyStartProducer

      default HttpsComponentBuilderFactory.HttpsComponentBuilder 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

    • cookieStore

      default HttpsComponentBuilderFactory.HttpsComponentBuilder cookieStore(org.apache.hc.client5.http.cookie.CookieStore cookieStore)
      To use a custom org.apache.hc.client5.http.cookie.CookieStore. By default the org.apache.hc.client5.http.cookie.BasicCookieStore is used which is an in-memory only cookie store. Notice if bridgeEndpoint=true then the cookie store is forced to be a noop cookie store as cookie shouldn't be stored as we are just bridging (eg acting as a proxy). The option is a: <code>org.apache.hc.client5.http.cookie.CookieStore</code> type. Group: producer (advanced)
      Parameters:
      cookieStore - the value to set
      Returns:
      the dsl builder

    • copyHeaders

      default HttpsComponentBuilderFactory.HttpsComponentBuilder 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 (advanced)
      Parameters:
      copyHeaders - the value to set
      Returns:
      the dsl builder

    • responsePayloadStreamingThreshold

      default HttpsComponentBuilderFactory.HttpsComponentBuilder responsePayloadStreamingThreshold(int responsePayloadStreamingThreshold)
      This threshold in bytes controls whether the response payload should be stored in memory as a byte array or be streaming based. Set this to -1 to always use streaming mode. The option is a: <code>int</code> type. Default: 8192 Group: producer (advanced)
      Parameters:
      responsePayloadStreamingThreshold - the value to set
      Returns:
      the dsl builder

    • skipRequestHeaders

      default HttpsComponentBuilderFactory.HttpsComponentBuilder skipRequestHeaders(boolean skipRequestHeaders)
      Whether to skip mapping all the Camel headers as HTTP request headers. If there are no data from Camel headers needed to be included in the HTTP request then this can avoid parsing overhead with many object allocations for the JVM garbage collector. The option is a: <code>boolean</code> type. Default: false Group: producer (advanced)
      Parameters:
      skipRequestHeaders - the value to set
      Returns:
      the dsl builder

    • skipResponseHeaders

      default HttpsComponentBuilderFactory.HttpsComponentBuilder skipResponseHeaders(boolean skipResponseHeaders)
      Whether to skip mapping all the HTTP response headers to Camel headers. If there are no data needed from HTTP headers then this can avoid parsing overhead with many object allocations for the JVM garbage collector. The option is a: <code>boolean</code> type. Default: false Group: producer (advanced)
      Parameters:
      skipResponseHeaders - the value to set
      Returns:
      the dsl builder

    • allowJavaSerializedObject

      default HttpsComponentBuilderFactory.HttpsComponentBuilder allowJavaSerializedObject(boolean allowJavaSerializedObject)
      Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object. 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: advanced
      Parameters:
      allowJavaSerializedObject - the value to set
      Returns:
      the dsl builder

    • authCachingDisabled

      default HttpsComponentBuilderFactory.HttpsComponentBuilder authCachingDisabled(boolean authCachingDisabled)
      Disables authentication scheme caching. The option is a: <code>boolean</code> type. Default: false Group: advanced
      Parameters:
      authCachingDisabled - the value to set
      Returns:
      the dsl builder

    • automaticRetriesDisabled

      default HttpsComponentBuilderFactory.HttpsComponentBuilder automaticRetriesDisabled(boolean automaticRetriesDisabled)
      Disables automatic request recovery and re-execution. The option is a: <code>boolean</code> type. Default: false Group: advanced
      Parameters:
      automaticRetriesDisabled - the value to set
      Returns:
      the dsl builder

    • autowiredEnabled

      default HttpsComponentBuilderFactory.HttpsComponentBuilder 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

    • clientConnectionManager

      default HttpsComponentBuilderFactory.HttpsComponentBuilder clientConnectionManager(org.apache.hc.client5.http.io.HttpClientConnectionManager clientConnectionManager)
      To use a custom and shared HttpClientConnectionManager to manage connections. If this has been configured then this is always used for all endpoints created by this component. The option is a: <code>org.apache.hc.client5.http.io.HttpClientConnectionManager</code> type. Group: advanced
      Parameters:
      clientConnectionManager - the value to set
      Returns:
      the dsl builder

    • connectionsPerRoute

      default HttpsComponentBuilderFactory.HttpsComponentBuilder connectionsPerRoute(int connectionsPerRoute)
      The maximum number of connections per route. The option is a: <code>int</code> type. Default: 20 Group: advanced
      Parameters:
      connectionsPerRoute - the value to set
      Returns:
      the dsl builder

    • connectionStateDisabled

      default HttpsComponentBuilderFactory.HttpsComponentBuilder connectionStateDisabled(boolean connectionStateDisabled)
      Disables connection state tracking. The option is a: <code>boolean</code> type. Default: false Group: advanced
      Parameters:
      connectionStateDisabled - the value to set
      Returns:
      the dsl builder

    • connectionTimeToLive

      default HttpsComponentBuilderFactory.HttpsComponentBuilder connectionTimeToLive(long connectionTimeToLive)
      The time for connection to live, the time unit is millisecond, the default value is always keep alive. The option is a: <code>long</code> type. Group: advanced
      Parameters:
      connectionTimeToLive - the value to set
      Returns:
      the dsl builder

    • contentCompressionDisabled

      default HttpsComponentBuilderFactory.HttpsComponentBuilder contentCompressionDisabled(boolean contentCompressionDisabled)
      Disables automatic content decompression. The option is a: <code>boolean</code> type. Default: false Group: advanced
      Parameters:
      contentCompressionDisabled - the value to set
      Returns:
      the dsl builder

    • cookieManagementDisabled

      default HttpsComponentBuilderFactory.HttpsComponentBuilder cookieManagementDisabled(boolean cookieManagementDisabled)
      Disables state (cookie) management. The option is a: <code>boolean</code> type. Default: false Group: advanced
      Parameters:
      cookieManagementDisabled - the value to set
      Returns:
      the dsl builder

    • defaultUserAgentDisabled

      default HttpsComponentBuilderFactory.HttpsComponentBuilder defaultUserAgentDisabled(boolean defaultUserAgentDisabled)
      Disables the default user agent set by this builder if none has been provided by the user. The option is a: <code>boolean</code> type. Default: false Group: advanced
      Parameters:
      defaultUserAgentDisabled - the value to set
      Returns:
      the dsl builder

    • httpBinding

      default HttpsComponentBuilderFactory.HttpsComponentBuilder httpBinding(org.apache.camel.http.common.HttpBinding httpBinding)
      To use a custom HttpBinding to control the mapping between Camel message and HttpClient. The option is a: <code>org.apache.camel.http.common.HttpBinding</code> type. Group: advanced
      Parameters:
      httpBinding - the value to set
      Returns:
      the dsl builder

    • httpClientConfigurer

      default HttpsComponentBuilderFactory.HttpsComponentBuilder httpClientConfigurer(org.apache.camel.component.http.HttpClientConfigurer httpClientConfigurer)
      To use the custom HttpClientConfigurer to perform configuration of the HttpClient that will be used. The option is a: <code>org.apache.camel.component.http.HttpClientConfigurer</code> type. Group: advanced
      Parameters:
      httpClientConfigurer - the value to set
      Returns:
      the dsl builder

    • httpConfiguration

      default HttpsComponentBuilderFactory.HttpsComponentBuilder httpConfiguration(org.apache.camel.http.common.HttpConfiguration httpConfiguration)
      To use the shared HttpConfiguration as base configuration. The option is a: <code>org.apache.camel.http.common.HttpConfiguration</code> type. Group: advanced
      Parameters:
      httpConfiguration - the value to set
      Returns:
      the dsl builder

    • httpContext

      default HttpsComponentBuilderFactory.HttpsComponentBuilder httpContext(org.apache.hc.core5.http.protocol.HttpContext httpContext)
      To use a custom org.apache.hc.core5.http.protocol.HttpContext when executing requests. The option is a: <code>org.apache.hc.core5.http.protocol.HttpContext</code> type. Group: advanced
      Parameters:
      httpContext - the value to set
      Returns:
      the dsl builder

    • maxTotalConnections

      default HttpsComponentBuilderFactory.HttpsComponentBuilder maxTotalConnections(int maxTotalConnections)
      The maximum number of connections. The option is a: <code>int</code> type. Default: 200 Group: advanced
      Parameters:
      maxTotalConnections - the value to set
      Returns:
      the dsl builder

    • redirectHandlingDisabled

      default HttpsComponentBuilderFactory.HttpsComponentBuilder redirectHandlingDisabled(boolean redirectHandlingDisabled)
      Disables automatic redirect handling. The option is a: <code>boolean</code> type. Default: false Group: advanced
      Parameters:
      redirectHandlingDisabled - the value to set
      Returns:
      the dsl builder

    • headerFilterStrategy

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

    • proxyAuthDomain

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

    • proxyAuthHost

      default HttpsComponentBuilderFactory.HttpsComponentBuilder 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 HttpsComponentBuilderFactory.HttpsComponentBuilder 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 HttpsComponentBuilderFactory.HttpsComponentBuilder 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 HttpsComponentBuilderFactory.HttpsComponentBuilder 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 HttpsComponentBuilderFactory.HttpsComponentBuilder 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

    • proxyAuthScheme

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

    • proxyAuthUsername

      default HttpsComponentBuilderFactory.HttpsComponentBuilder 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

    • sslContextParameters

      default HttpsComponentBuilderFactory.HttpsComponentBuilder sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)
      To configure security using SSLContextParameters. Important: Only one instance of org.apache.camel.support.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

    • useGlobalSslContextParameters

      default HttpsComponentBuilderFactory.HttpsComponentBuilder useGlobalSslContextParameters(boolean useGlobalSslContextParameters)
      Enable usage of global SSL context parameters. The option is a: <code>boolean</code> type. Default: false Group: security
      Parameters:
      useGlobalSslContextParameters - the value to set
      Returns:
      the dsl builder

    • x509HostnameVerifier

      default HttpsComponentBuilderFactory.HttpsComponentBuilder x509HostnameVerifier(HostnameVerifier 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

    • connectionRequestTimeout

      default HttpsComponentBuilderFactory.HttpsComponentBuilder connectionRequestTimeout(org.apache.hc.core5.util.Timeout connectionRequestTimeout)
      Returns the connection lease request timeout used when requesting a connection from the connection manager. A timeout value of zero is interpreted as a disabled timeout. The option is a: <code>org.apache.hc.core5.util.Timeout</code> type. Default: 3 minutes Group: timeout
      Parameters:
      connectionRequestTimeout - the value to set
      Returns:
      the dsl builder

    • connectTimeout

      default HttpsComponentBuilderFactory.HttpsComponentBuilder connectTimeout(org.apache.hc.core5.util.Timeout connectTimeout)
      Determines the timeout until a new connection is fully established. A timeout value of zero is interpreted as an infinite timeout. The option is a: <code>org.apache.hc.core5.util.Timeout</code> type. Default: 3 minutes Group: timeout
      Parameters:
      connectTimeout - the value to set
      Returns:
      the dsl builder

    • responseTimeout

      default HttpsComponentBuilderFactory.HttpsComponentBuilder responseTimeout(org.apache.hc.core5.util.Timeout responseTimeout)
      Determines the timeout until arrival of a response from the opposite endpoint. A timeout value of zero is interpreted as an infinite timeout. Please note that response timeout may be unsupported by HTTP transports with message multiplexing. The option is a: <code>org.apache.hc.core5.util.Timeout</code> type. Default: 0 Group: timeout
      Parameters:
      responseTimeout - the value to set
      Returns:
      the dsl builder

    • soTimeout

      default HttpsComponentBuilderFactory.HttpsComponentBuilder soTimeout(org.apache.hc.core5.util.Timeout soTimeout)
      Determines the default socket timeout value for blocking I/O operations. The option is a: <code>org.apache.hc.core5.util.Timeout</code> type. Default: 3 minutes Group: timeout
      Parameters:
      soTimeout - the value to set
      Returns:
      the dsl builder