Interface VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
- Enclosing interface:
- VertxHttpEndpointBuilderFactory
public static interface VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint for the Vert.x HTTP Client component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default VertxHttpEndpointBuilderFactory.AdvancedVertxHttpEndpointBuilder
advanced()
default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder
basicAuthPassword(String basicAuthPassword)
The password to use for basic authentication.default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder
basicAuthUsername(String basicAuthUsername)
The user name to use for basic authentication.default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder
bearerToken(String bearerToken)
The bearer token to use for bearer token authentication.default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder
connectTimeout(int connectTimeout)
The amount of time in milliseconds until a connection is established.default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder
connectTimeout(String connectTimeout)
The amount of time in milliseconds until a connection is established.default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder
cookieStore(Object cookieStore)
A custom CookieStore to use when session management is enabled.default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder
cookieStore(String cookieStore)
A custom CookieStore to use when session management is enabled.default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder
headerFilterStrategy(String headerFilterStrategy)
A custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder
headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
A custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder
httpMethod(String httpMethod)
The HTTP method to use.default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder
httpMethod(VertxHttpEndpointBuilderFactory.HttpMethod httpMethod)
The HTTP method to use.default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder
lazyStartProducer(boolean lazyStartProducer)
Whether the producer should be started lazy (on the first message).default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder
lazyStartProducer(String lazyStartProducer)
Whether the producer should be started lazy (on the first message).default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder
okStatusCodeRange(String okStatusCodeRange)
The status codes which are considered a success response.default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder
proxyHost(String proxyHost)
The proxy server host address.default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder
proxyPassword(String proxyPassword)
The proxy server password if authentication is required.default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder
proxyPort(Integer proxyPort)
The proxy server port.default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder
proxyPort(String proxyPort)
The proxy server port.default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder
proxyType(String proxyType)
The proxy server type.default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder
proxyType(VertxHttpEndpointBuilderFactory.ProxyType proxyType)
The proxy server type.default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder
proxyUsername(String proxyUsername)
The proxy server username if authentication is required.default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder
sessionManagement(boolean sessionManagement)
Enables session management via WebClientSession.default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder
sessionManagement(String sessionManagement)
Enables session management via WebClientSession.default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder
sslContextParameters(Object sslContextParameters)
To configure security using SSLContextParameters.default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder
sslContextParameters(String sslContextParameters)
To configure security using SSLContextParameters.default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder
throwExceptionOnFailure(boolean throwExceptionOnFailure)
Disable throwing HttpOperationFailedException in case of failed responses from the remote server.default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder
throwExceptionOnFailure(String throwExceptionOnFailure)
Disable throwing HttpOperationFailedException in case of failed responses from the remote server.default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder
timeout(long timeout)
The amount of time in milliseconds after which if the request does not return any data within the timeout period a TimeoutException fails the request.default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder
timeout(String timeout)
The amount of time in milliseconds after which if the request does not return any data within the timeout period a TimeoutException fails the request.default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder
transferException(boolean transferException)
If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was sent back serialized in the response as a application/x-java-serialized-object content type.default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder
transferException(String transferException)
If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was sent back serialized in the response as a application/x-java-serialized-object content type.default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder
useCompression(boolean useCompression)
Set whether compression is enabled to handled compressed (E.g gzipped) responses.default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder
useCompression(String useCompression)
Set whether compression is enabled to handled compressed (E.g gzipped) responses.default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder
vertxHttpBinding(Object vertxHttpBinding)
A custom VertxHttpBinding which can control how to bind between Vert.x and Camel.default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder
vertxHttpBinding(String vertxHttpBinding)
A custom VertxHttpBinding which can control how to bind between Vert.x and Camel.default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder
webClientOptions(Object webClientOptions)
Sets customized options for configuring the Vert.x WebClient.default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder
webClientOptions(String webClientOptions)
Sets customized options for configuring the Vert.x WebClient.
-
-
-
Method Detail
-
advanced
default VertxHttpEndpointBuilderFactory.AdvancedVertxHttpEndpointBuilder advanced()
-
connectTimeout
default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder connectTimeout(int connectTimeout)
The amount of time in milliseconds until a connection is established. A timeout value of zero is interpreted as an infinite timeout. The option is a:int
type. Default: 60000 Group: producer
-
connectTimeout
default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder connectTimeout(String connectTimeout)
The amount of time in milliseconds until a connection is established. A timeout value of zero is interpreted as an infinite timeout. The option will be converted to aint
type. Default: 60000 Group: producer
-
cookieStore
default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder cookieStore(Object cookieStore)
A custom CookieStore to use when session management is enabled. If this option is not set then an in-memory CookieStore is used. The option is a:io.vertx.ext.web.client.spi.CookieStore
type. Default: InMemoryCookieStore Group: producer
-
cookieStore
default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder cookieStore(String cookieStore)
A custom CookieStore to use when session management is enabled. If this option is not set then an in-memory CookieStore is used. The option will be converted to aio.vertx.ext.web.client.spi.CookieStore
type. Default: InMemoryCookieStore Group: producer
-
headerFilterStrategy
default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
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. Default: VertxHttpHeaderFilterStrategy Group: producer
-
headerFilterStrategy
default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder headerFilterStrategy(String headerFilterStrategy)
A custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. The option will be converted to aorg.apache.camel.spi.HeaderFilterStrategy
type. Default: VertxHttpHeaderFilterStrategy Group: producer
-
httpMethod
default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder httpMethod(VertxHttpEndpointBuilderFactory.HttpMethod httpMethod)
The HTTP method to use. The HttpMethod header cannot override this option if set. The option is a:io.vertx.core.http.HttpMethod
type. Group: producer
-
httpMethod
default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder httpMethod(String httpMethod)
The HTTP method to use. The HttpMethod header cannot override this option if set. The option will be converted to aio.vertx.core.http.HttpMethod
type. Group: producer
-
lazyStartProducer
default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder 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
-
lazyStartProducer
default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder 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 aboolean
type. Default: false Group: producer
-
okStatusCodeRange
default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder okStatusCodeRange(String okStatusCodeRange)
The status codes which are considered a success response. The values are inclusive. Multiple ranges can be defined, separated by comma, e.g. 200-204,209,301-304. Each range must be a single number or from-to with the dash included. The option is a:java.lang.String
type. Default: 200-299 Group: producer
-
sessionManagement
default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder sessionManagement(boolean sessionManagement)
Enables session management via WebClientSession. By default the client is configured to use an in-memory CookieStore. The cookieStore option can be used to override this. The option is a:boolean
type. Default: false Group: producer
-
sessionManagement
default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder sessionManagement(String sessionManagement)
Enables session management via WebClientSession. By default the client is configured to use an in-memory CookieStore. The cookieStore option can be used to override this. The option will be converted to aboolean
type. Default: false Group: producer
-
throwExceptionOnFailure
default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder throwExceptionOnFailure(boolean throwExceptionOnFailure)
Disable throwing HttpOperationFailedException in case of failed responses from the remote server. The option is a:boolean
type. Default: true Group: producer
-
throwExceptionOnFailure
default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder throwExceptionOnFailure(String throwExceptionOnFailure)
Disable throwing HttpOperationFailedException in case of failed responses from the remote server. The option will be converted to aboolean
type. Default: true Group: producer
-
timeout
default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder timeout(long timeout)
The amount of time in milliseconds after which if the request does not return any data within the timeout period a TimeoutException fails the request. Setting zero or a negative value disables the timeout. The option is a:long
type. Default: -1 Group: producer
-
timeout
default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder timeout(String timeout)
The amount of time in milliseconds after which if the request does not return any data within the timeout period a TimeoutException fails the request. Setting zero or a negative value disables the timeout. The option will be converted to along
type. Default: -1 Group: producer
-
transferException
default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder transferException(boolean transferException)
If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was sent 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 HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Camel will deserialize the incoming data from the request to a Java object, which can be a potential security risk. The option is a:boolean
type. Default: false Group: producer
-
transferException
default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder transferException(String transferException)
If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was sent 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 HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Camel will deserialize the incoming data from the request to a Java object, which can be a potential security risk. The option will be converted to aboolean
type. Default: false Group: producer
-
useCompression
default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder useCompression(boolean useCompression)
Set whether compression is enabled to handled compressed (E.g gzipped) responses. The option is a:boolean
type. Default: false Group: producer
-
useCompression
default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder useCompression(String useCompression)
Set whether compression is enabled to handled compressed (E.g gzipped) responses. The option will be converted to aboolean
type. Default: false Group: producer
-
vertxHttpBinding
default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder vertxHttpBinding(Object vertxHttpBinding)
A custom VertxHttpBinding which can control how to bind between Vert.x and Camel. The option is a:org.apache.camel.component.vertx.http.VertxHttpBinding
type. Group: producer
-
vertxHttpBinding
default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder vertxHttpBinding(String vertxHttpBinding)
A custom VertxHttpBinding which can control how to bind between Vert.x and Camel. The option will be converted to aorg.apache.camel.component.vertx.http.VertxHttpBinding
type. Group: producer
-
webClientOptions
default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder webClientOptions(Object webClientOptions)
Sets customized options for configuring the Vert.x WebClient. The option is a:io.vertx.ext.web.client.WebClientOptions
type. Group: producer
-
webClientOptions
default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder webClientOptions(String webClientOptions)
Sets customized options for configuring the Vert.x WebClient. The option will be converted to aio.vertx.ext.web.client.WebClientOptions
type. Group: producer
-
proxyHost
default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder proxyHost(String proxyHost)
The proxy server host address. The option is a:java.lang.String
type. Group: proxy
-
proxyPassword
default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder proxyPassword(String proxyPassword)
The proxy server password if authentication is required. The option is a:java.lang.String
type. Group: proxy
-
proxyPort
default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder proxyPort(Integer proxyPort)
The proxy server port. The option is a:java.lang.Integer
type. Group: proxy
-
proxyPort
default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder proxyPort(String proxyPort)
The proxy server port. The option will be converted to ajava.lang.Integer
type. Group: proxy
-
proxyType
default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder proxyType(VertxHttpEndpointBuilderFactory.ProxyType proxyType)
The proxy server type. The option is a:io.vertx.core.net.ProxyType
type. Group: proxy
-
proxyType
default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder proxyType(String proxyType)
The proxy server type. The option will be converted to aio.vertx.core.net.ProxyType
type. Group: proxy
-
proxyUsername
default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder proxyUsername(String proxyUsername)
The proxy server username if authentication is required. The option is a:java.lang.String
type. Group: proxy
-
basicAuthPassword
default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder basicAuthPassword(String basicAuthPassword)
The password to use for basic authentication. The option is a:java.lang.String
type. Group: security
-
basicAuthUsername
default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder basicAuthUsername(String basicAuthUsername)
The user name to use for basic authentication. The option is a:java.lang.String
type. Group: security
-
bearerToken
default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder bearerToken(String bearerToken)
The bearer token to use for bearer token authentication. The option is a:java.lang.String
type. Group: security
-
sslContextParameters
default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder sslContextParameters(Object sslContextParameters)
To configure security using SSLContextParameters. The option is a:org.apache.camel.support.jsse.SSLContextParameters
type. Group: security
-
sslContextParameters
default VertxHttpEndpointBuilderFactory.VertxHttpEndpointBuilder sslContextParameters(String sslContextParameters)
To configure security using SSLContextParameters. The option will be converted to aorg.apache.camel.support.jsse.SSLContextParameters
type. Group: security
-
-