Class VertxHttpComponent
java.lang.Object
org.apache.camel.support.service.BaseService
org.apache.camel.support.service.ServiceSupport
org.apache.camel.support.DefaultComponent
org.apache.camel.support.HeaderFilterStrategyComponent
org.apache.camel.component.vertx.http.VertxHttpComponent
- All Implemented Interfaces:
AutoCloseable
,org.apache.camel.CamelContextAware
,org.apache.camel.Component
,org.apache.camel.Service
,org.apache.camel.ShutdownableService
,org.apache.camel.spi.HasCamelContext
,org.apache.camel.spi.HeaderFilterStrategyAware
,org.apache.camel.spi.RestProducerFactory
,org.apache.camel.SSLContextParametersAware
,org.apache.camel.StatefulService
,org.apache.camel.SuspendableService
@Component("vertx-http")
public class VertxHttpComponent
extends org.apache.camel.support.HeaderFilterStrategyComponent
implements org.apache.camel.spi.RestProducerFactory, org.apache.camel.SSLContextParametersAware
-
Field Summary
Fields inherited from class org.apache.camel.support.service.BaseService
BUILT, FAILED, INITIALIZED, INITIALIZING, lock, NEW, SHUTDOWN, SHUTTING_DOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected org.apache.camel.Endpoint
org.apache.camel.Producer
createProducer
(org.apache.camel.CamelContext camelContext, String host, String verb, String basePath, String uriTemplate, String queryParameters, String consumes, String produces, org.apache.camel.spi.RestConfiguration configuration, Map<String, Object> parameters) protected void
doInit()
protected void
doStart()
protected void
doStop()
io.vertx.core.net.ProxyType
org.apache.camel.support.jsse.SSLContextParameters
To configure security using SSLContextParametersio.vertx.core.Vertx
getVertx()
io.vertx.core.VertxOptions
io.vertx.ext.web.client.WebClientOptions
boolean
boolean
boolean
void
setAllowJavaSerializedObject
(boolean allowJavaSerializedObject) Whether to allow java serialization when a request has the Content-Type application/x-java-serialized-objectvoid
setBasicAuthPassword
(String basicAuthPassword) The password to use for basic authenticationvoid
setBasicAuthUsername
(String basicAuthUsername) The user name to use for basic authenticationvoid
setBearerToken
(String bearerToken) The bearer token to use for bearer token authenticationvoid
setProxyHost
(String proxyHost) The proxy server host addressvoid
setProxyPassword
(String proxyPassword) The proxy server password if authentication is requiredvoid
setProxyPort
(Integer proxyPort) The proxy server portvoid
setProxyType
(io.vertx.core.net.ProxyType proxyType) The proxy server typevoid
setProxyUsername
(String proxyUsername) The proxy server username if authentication is requiredvoid
setResponsePayloadAsByteArray
(boolean responsePayloadAsByteArray) Whether the response body should be byte[] or as io.vertx.core.buffer.Buffervoid
setSslContextParameters
(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters) void
setUseGlobalSslContextParameters
(boolean useGlobalSslContextParameters) Enable usage of global SSL context parametersvoid
setVertx
(io.vertx.core.Vertx vertx) To use an existing vertx instead of creating a new instancevoid
setVertxHttpBinding
(VertxHttpBinding vertxHttpBinding) A custom VertxHttpBinding which can control how to bind between Vert.x and Camelvoid
setVertxOptions
(io.vertx.core.VertxOptions vertxOptions) To provide a custom set of vertx options for configuring vertxvoid
setWebClientOptions
(io.vertx.ext.web.client.WebClientOptions webClientOptions) To provide a custom set of options for configuring vertx web clientMethods inherited from class org.apache.camel.support.HeaderFilterStrategyComponent
getHeaderFilterStrategy, setEndpointHeaderFilterStrategy, setHeaderFilterStrategy
Methods inherited from class org.apache.camel.support.DefaultComponent
afterConfiguration, createEndpoint, createEndpoint, doBuild, getAndRemoveOrResolveReferenceParameter, getAndRemoveOrResolveReferenceParameter, getAndRemoveParameter, getAndRemoveParameter, getCamelContext, getComponentPropertyConfigurer, getDefaultName, getEndpointPropertyConfigurer, getExtension, getSupportedExtensions, ifStartsWithReturnRemainder, isAutowiredEnabled, isBridgeErrorHandler, isLazyStartProducer, registerExtension, registerExtension, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceParameter, resolveAndRemoveReferenceParameter, resolveRawParameterValues, setAutowiredEnabled, setBridgeErrorHandler, setCamelContext, setLazyStartProducer, setProperties, setProperties, setProperties, useIntrospectionOnEndpoint, useRawUri, validateParameters, validateURI
Methods inherited from class org.apache.camel.support.service.BaseService
build, doFail, doLifecycleChange, doResume, doShutdown, doSuspend, fail, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apache.camel.CamelContextAware
setCamelContext
Methods inherited from interface org.apache.camel.spi.HasCamelContext
getCamelContext
Methods inherited from interface org.apache.camel.Service
build, close, init, start, stop
Methods inherited from interface org.apache.camel.ShutdownableService
shutdown
Methods inherited from interface org.apache.camel.SSLContextParametersAware
retrieveGlobalSslContextParameters
Methods inherited from interface org.apache.camel.StatefulService
getStatus, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspending
Methods inherited from interface org.apache.camel.SuspendableService
isSuspended, resume, suspend
-
Constructor Details
-
VertxHttpComponent
public VertxHttpComponent()
-
-
Method Details
-
createEndpoint
protected org.apache.camel.Endpoint createEndpoint(String uri, String remaining, Map<String, Object> parameters) throws Exception- Specified by:
createEndpoint
in classorg.apache.camel.support.DefaultComponent
- Throws:
Exception
-
createProducer
public org.apache.camel.Producer createProducer(org.apache.camel.CamelContext camelContext, String host, String verb, String basePath, String uriTemplate, String queryParameters, String consumes, String produces, org.apache.camel.spi.RestConfiguration configuration, Map<String, Object> parameters) throws Exception- Specified by:
createProducer
in interfaceorg.apache.camel.spi.RestProducerFactory
- Throws:
Exception
-
doInit
- Overrides:
doInit
in classorg.apache.camel.support.DefaultComponent
- Throws:
Exception
-
doStart
- Overrides:
doStart
in classorg.apache.camel.support.service.BaseService
- Throws:
Exception
-
doStop
- Overrides:
doStop
in classorg.apache.camel.support.service.BaseService
- Throws:
Exception
-
getVertx
public io.vertx.core.Vertx getVertx() -
setVertx
public void setVertx(io.vertx.core.Vertx vertx) To use an existing vertx instead of creating a new instance -
getVertxOptions
public io.vertx.core.VertxOptions getVertxOptions() -
setVertxOptions
public void setVertxOptions(io.vertx.core.VertxOptions vertxOptions) To provide a custom set of vertx options for configuring vertx -
getVertxHttpBinding
-
setVertxHttpBinding
A custom VertxHttpBinding which can control how to bind between Vert.x and Camel -
isUseGlobalSslContextParameters
public boolean isUseGlobalSslContextParameters()- Specified by:
isUseGlobalSslContextParameters
in interfaceorg.apache.camel.SSLContextParametersAware
-
setUseGlobalSslContextParameters
public void setUseGlobalSslContextParameters(boolean useGlobalSslContextParameters) Enable usage of global SSL context parameters- Specified by:
setUseGlobalSslContextParameters
in interfaceorg.apache.camel.SSLContextParametersAware
-
isAllowJavaSerializedObject
public boolean isAllowJavaSerializedObject() -
setAllowJavaSerializedObject
public void setAllowJavaSerializedObject(boolean allowJavaSerializedObject) Whether to allow java serialization when a request has the Content-Type application/x-java-serialized-object This is disabled by default. If you enable this, be aware that Java will deserialize the incoming data from the request. This can be a potential security risk. -
isResponsePayloadAsByteArray
public boolean isResponsePayloadAsByteArray() -
setResponsePayloadAsByteArray
public void setResponsePayloadAsByteArray(boolean responsePayloadAsByteArray) Whether the response body should be byte[] or as io.vertx.core.buffer.Buffer -
setProxyHost
The proxy server host address -
getProxyHost
-
setProxyPort
The proxy server port -
getProxyPort
-
setProxyUsername
The proxy server username if authentication is required -
getProxyUsername
-
setProxyPassword
The proxy server password if authentication is required -
getProxyPassword
-
setProxyType
public void setProxyType(io.vertx.core.net.ProxyType proxyType) The proxy server type -
getProxyType
public io.vertx.core.net.ProxyType getProxyType() -
setBasicAuthUsername
The user name to use for basic authentication -
getBasicAuthUsername
-
setBasicAuthPassword
The password to use for basic authentication -
getBasicAuthPassword
-
setBearerToken
The bearer token to use for bearer token authentication -
getBearerToken
-
getSslContextParameters
public org.apache.camel.support.jsse.SSLContextParameters getSslContextParameters()To configure security using SSLContextParameters -
setSslContextParameters
public void setSslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters) -
getWebClientOptions
public io.vertx.ext.web.client.WebClientOptions getWebClientOptions() -
setWebClientOptions
public void setWebClientOptions(io.vertx.ext.web.client.WebClientOptions webClientOptions) To provide a custom set of options for configuring vertx web client
-