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 Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default HttpsComponentBuilderFactory.HttpsComponentBuilder
allowJavaSerializedObject(boolean allowJavaSerializedObject)
Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object.default HttpsComponentBuilderFactory.HttpsComponentBuilder
autowiredEnabled(boolean autowiredEnabled)
Whether autowiring is enabled.default HttpsComponentBuilderFactory.HttpsComponentBuilder
clientConnectionManager(org.apache.http.conn.HttpClientConnectionManager clientConnectionManager)
To use a custom and shared HttpClientConnectionManager to manage connections.default HttpsComponentBuilderFactory.HttpsComponentBuilder
connectionRequestTimeout(int connectionRequestTimeout)
The timeout in milliseconds used when requesting a connection from the connection manager.default HttpsComponentBuilderFactory.HttpsComponentBuilder
connectionsPerRoute(int connectionsPerRoute)
The maximum number of connections per route.default HttpsComponentBuilderFactory.HttpsComponentBuilder
connectionTimeToLive(long connectionTimeToLive)
The time for connection to live, the time unit is millisecond, the default value is always keep alive.default HttpsComponentBuilderFactory.HttpsComponentBuilder
connectTimeout(int connectTimeout)
Determines the timeout in milliseconds until a connection is established.default HttpsComponentBuilderFactory.HttpsComponentBuilder
cookieStore(org.apache.http.client.CookieStore cookieStore)
To use a custom org.apache.http.client.CookieStore.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.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.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.default HttpsComponentBuilderFactory.HttpsComponentBuilder
httpConfiguration(org.apache.camel.http.common.HttpConfiguration httpConfiguration)
To use the shared HttpConfiguration as base configuration.default HttpsComponentBuilderFactory.HttpsComponentBuilder
httpContext(org.apache.http.protocol.HttpContext httpContext)
To use a custom org.apache.http.protocol.HttpContext when executing requests.default HttpsComponentBuilderFactory.HttpsComponentBuilder
lazyStartProducer(boolean lazyStartProducer)
Whether the producer should be started lazy (on the first message).default HttpsComponentBuilderFactory.HttpsComponentBuilder
maxTotalConnections(int maxTotalConnections)
The maximum number of connections.default HttpsComponentBuilderFactory.HttpsComponentBuilder
proxyAuthDomain(String proxyAuthDomain)
Proxy authentication domain to use.default HttpsComponentBuilderFactory.HttpsComponentBuilder
proxyAuthHost(String proxyAuthHost)
Proxy authentication host.default HttpsComponentBuilderFactory.HttpsComponentBuilder
proxyAuthMethod(String proxyAuthMethod)
Proxy authentication method to use.default HttpsComponentBuilderFactory.HttpsComponentBuilder
proxyAuthNtHost(String proxyAuthNtHost)
Proxy authentication domain (workstation name) to use with NTML.default HttpsComponentBuilderFactory.HttpsComponentBuilder
proxyAuthPassword(String proxyAuthPassword)
Proxy authentication password.default HttpsComponentBuilderFactory.HttpsComponentBuilder
proxyAuthPort(Integer proxyAuthPort)
Proxy authentication port.default HttpsComponentBuilderFactory.HttpsComponentBuilder
proxyAuthUsername(String proxyAuthUsername)
Proxy authentication username.default HttpsComponentBuilderFactory.HttpsComponentBuilder
socketTimeout(int socketTimeout)
Defines the socket timeout in milliseconds, which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets).default HttpsComponentBuilderFactory.HttpsComponentBuilder
sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)
To configure security using SSLContextParameters.default HttpsComponentBuilderFactory.HttpsComponentBuilder
useGlobalSslContextParameters(boolean useGlobalSslContextParameters)
Enable usage of global SSL context parameters.default HttpsComponentBuilderFactory.HttpsComponentBuilder
x509HostnameVerifier(HostnameVerifier x509HostnameVerifier)
To use a custom X509HostnameVerifier such as DefaultHostnameVerifier or NoopHostnameVerifier.-
Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder
build, build, doSetProperty, register
-
-
-
-
Method Detail
-
cookieStore
default HttpsComponentBuilderFactory.HttpsComponentBuilder cookieStore(org.apache.http.client.CookieStore cookieStore)
To use a custom org.apache.http.client.CookieStore. By default the org.apache.http.impl.client.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:org.apache.http.client.CookieStore
type. Group: producer
-
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:boolean
type. Default: false Group: producer
-
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:boolean
type. Default: false Group: advanced
-
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:boolean
type. Default: true Group: advanced
-
clientConnectionManager
default HttpsComponentBuilderFactory.HttpsComponentBuilder clientConnectionManager(org.apache.http.conn.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:org.apache.http.conn.HttpClientConnectionManager
type. Group: advanced
-
connectionsPerRoute
default HttpsComponentBuilderFactory.HttpsComponentBuilder connectionsPerRoute(int connectionsPerRoute)
The maximum number of connections per route. The option is a:int
type. Default: 20 Group: advanced
-
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:long
type. Group: advanced
-
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:org.apache.camel.http.common.HttpBinding
type. Group: advanced
-
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:org.apache.camel.component.http.HttpClientConfigurer
type. Group: advanced
-
httpConfiguration
default HttpsComponentBuilderFactory.HttpsComponentBuilder httpConfiguration(org.apache.camel.http.common.HttpConfiguration httpConfiguration)
To use the shared HttpConfiguration as base configuration. The option is a:org.apache.camel.http.common.HttpConfiguration
type. Group: advanced
-
httpContext
default HttpsComponentBuilderFactory.HttpsComponentBuilder httpContext(org.apache.http.protocol.HttpContext httpContext)
To use a custom org.apache.http.protocol.HttpContext when executing requests. The option is a:org.apache.http.protocol.HttpContext
type. Group: advanced
-
maxTotalConnections
default HttpsComponentBuilderFactory.HttpsComponentBuilder maxTotalConnections(int maxTotalConnections)
The maximum number of connections. The option is a:int
type. Default: 200 Group: advanced
-
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:org.apache.camel.spi.HeaderFilterStrategy
type. Group: filter
-
proxyAuthDomain
default HttpsComponentBuilderFactory.HttpsComponentBuilder proxyAuthDomain(String proxyAuthDomain)
Proxy authentication domain to use. The option is a:java.lang.String
type. Group: proxy
-
proxyAuthHost
default HttpsComponentBuilderFactory.HttpsComponentBuilder proxyAuthHost(String proxyAuthHost)
Proxy authentication host. The option is a:java.lang.String
type. Group: proxy
-
proxyAuthMethod
default HttpsComponentBuilderFactory.HttpsComponentBuilder proxyAuthMethod(String proxyAuthMethod)
Proxy authentication method to use. The option is a:java.lang.String
type. Group: proxy
-
proxyAuthNtHost
default HttpsComponentBuilderFactory.HttpsComponentBuilder proxyAuthNtHost(String proxyAuthNtHost)
Proxy authentication domain (workstation name) to use with NTML. The option is a:java.lang.String
type. Group: proxy
-
proxyAuthPassword
default HttpsComponentBuilderFactory.HttpsComponentBuilder proxyAuthPassword(String proxyAuthPassword)
Proxy authentication password. The option is a:java.lang.String
type. Group: proxy
-
proxyAuthPort
default HttpsComponentBuilderFactory.HttpsComponentBuilder proxyAuthPort(Integer proxyAuthPort)
Proxy authentication port. The option is a:java.lang.Integer
type. Group: proxy
-
proxyAuthUsername
default HttpsComponentBuilderFactory.HttpsComponentBuilder proxyAuthUsername(String proxyAuthUsername)
Proxy authentication username. The option is a:java.lang.String
type. Group: proxy
-
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:org.apache.camel.support.jsse.SSLContextParameters
type. Group: security
-
useGlobalSslContextParameters
default HttpsComponentBuilderFactory.HttpsComponentBuilder useGlobalSslContextParameters(boolean useGlobalSslContextParameters)
Enable usage of global SSL context parameters. The option is a:boolean
type. Default: false Group: security
-
x509HostnameVerifier
default HttpsComponentBuilderFactory.HttpsComponentBuilder x509HostnameVerifier(HostnameVerifier x509HostnameVerifier)
To use a custom X509HostnameVerifier such as DefaultHostnameVerifier or NoopHostnameVerifier. The option is a:javax.net.ssl.HostnameVerifier
type. Group: security
-
connectionRequestTimeout
default HttpsComponentBuilderFactory.HttpsComponentBuilder connectionRequestTimeout(int connectionRequestTimeout)
The timeout in milliseconds used when requesting a connection from the connection manager. A timeout value of zero is interpreted as an infinite timeout. A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default). The option is a:int
type. Default: -1 Group: timeout
-
connectTimeout
default HttpsComponentBuilderFactory.HttpsComponentBuilder connectTimeout(int connectTimeout)
Determines the timeout in milliseconds until a connection is established. A timeout value of zero is interpreted as an infinite timeout. A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default). The option is a:int
type. Default: -1 Group: timeout
-
socketTimeout
default HttpsComponentBuilderFactory.HttpsComponentBuilder socketTimeout(int socketTimeout)
Defines the socket timeout in milliseconds, which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets). A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default). The option is a:int
type. Default: -1 Group: timeout
-
-