Package org.apache.camel.component.vertx.http

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.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
    Constructor
    Description
    VertxHttpComponent()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected org.apache.camel.Endpoint
    createEndpoint(String uri, String remaining, Map<String,Object> parameters)
     
    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()
     
    String
    getBasicAuthPassword()
     
    String
    getBasicAuthUsername()
     
    String
    getBearerToken()
     
    String
    getProxyHost()
     
    String
    getProxyPassword()
     
    Integer
    getProxyPort()
     
    io.vertx.core.net.ProxyType
    getProxyType()
     
    String
    getProxyUsername()
     
    org.apache.camel.support.jsse.SSLContextParameters
    getSslContextParameters()
    To configure security using SSLContextParameters
    io.vertx.core.Vertx
    getVertx()
     
    VertxHttpBinding
    getVertxHttpBinding()
     
    io.vertx.core.VertxOptions
    getVertxOptions()
     
    io.vertx.ext.web.client.WebClientOptions
    getWebClientOptions()
     
    boolean
    isAllowJavaSerializedObject()
     
    boolean
    isResponsePayloadAsByteArray()
     
    boolean
    isUseGlobalSslContextParameters()
     
    void
    setAllowJavaSerializedObject(boolean allowJavaSerializedObject)
    Whether to allow java serialization when a request has the Content-Type application/x-java-serialized-object
    void
    setBasicAuthPassword(String basicAuthPassword)
    The password to use for basic authentication
    void
    setBasicAuthUsername(String basicAuthUsername)
    The user name to use for basic authentication
    void
    setBearerToken(String bearerToken)
    The bearer token to use for bearer token authentication
    void
    setProxyHost(String proxyHost)
    The proxy server host address
    void
    setProxyPassword(String proxyPassword)
    The proxy server password if authentication is required
    void
    setProxyPort(Integer proxyPort)
    The proxy server port
    void
    setProxyType(io.vertx.core.net.ProxyType proxyType)
    The proxy server type
    void
    setProxyUsername(String proxyUsername)
    The proxy server username if authentication is required
    void
    setResponsePayloadAsByteArray(boolean responsePayloadAsByteArray)
    Whether the response body should be byte[] or as io.vertx.core.buffer.Buffer
    void
    setSslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)
     
    void
    setUseGlobalSslContextParameters(boolean useGlobalSslContextParameters)
    Enable usage of global SSL context parameters
    void
    setVertx(io.vertx.core.Vertx vertx)
    To use an existing vertx instead of creating a new instance
    void
    setVertxHttpBinding(VertxHttpBinding vertxHttpBinding)
    A custom VertxHttpBinding which can control how to bind between Vert.x and Camel
    void
    setVertxOptions(io.vertx.core.VertxOptions vertxOptions)
    To provide a custom set of vertx options for configuring vertx
    void
    setWebClientOptions(io.vertx.ext.web.client.WebClientOptions webClientOptions)
    To provide a custom set of options for configuring vertx web client

    Methods 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

    getCamelContext, setCamelContext

    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 class org.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 interface org.apache.camel.spi.RestProducerFactory
      Throws:
      Exception

    • doInit

      protected void doInit() throws Exception
      Overrides:
      doInit in class org.apache.camel.support.DefaultComponent
      Throws:
      Exception

    • doStart

      protected void doStart() throws Exception
      Overrides:
      doStart in class org.apache.camel.support.service.BaseService
      Throws:
      Exception

    • doStop

      protected void doStop() throws Exception
      Overrides:
      doStop in class org.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

      public VertxHttpBinding getVertxHttpBinding()

    • setVertxHttpBinding

      public void setVertxHttpBinding(VertxHttpBinding vertxHttpBinding)
      A custom VertxHttpBinding which can control how to bind between Vert.x and Camel

    • isUseGlobalSslContextParameters

      public boolean isUseGlobalSslContextParameters()
      Specified by:
      isUseGlobalSslContextParameters in interface org.apache.camel.SSLContextParametersAware

    • setUseGlobalSslContextParameters

      public void setUseGlobalSslContextParameters(boolean useGlobalSslContextParameters)
      Enable usage of global SSL context parameters
      Specified by:
      setUseGlobalSslContextParameters in interface org.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

      public void setProxyHost(String proxyHost)
      The proxy server host address

    • getProxyHost

      public String getProxyHost()

    • setProxyPort

      public void setProxyPort(Integer proxyPort)
      The proxy server port

    • getProxyPort

      public Integer getProxyPort()

    • setProxyUsername

      public void setProxyUsername(String proxyUsername)
      The proxy server username if authentication is required

    • getProxyUsername

      public String getProxyUsername()

    • setProxyPassword

      public void setProxyPassword(String proxyPassword)
      The proxy server password if authentication is required

    • getProxyPassword

      public String getProxyPassword()

    • setProxyType

      public void setProxyType(io.vertx.core.net.ProxyType proxyType)
      The proxy server type

    • getProxyType

      public io.vertx.core.net.ProxyType getProxyType()

    • setBasicAuthUsername

      public void setBasicAuthUsername(String basicAuthUsername)
      The user name to use for basic authentication

    • getBasicAuthUsername

      public String getBasicAuthUsername()

    • setBasicAuthPassword

      public void setBasicAuthPassword(String basicAuthPassword)
      The password to use for basic authentication

    • getBasicAuthPassword

      public String getBasicAuthPassword()

    • setBearerToken

      public void setBearerToken(String bearerToken)
      The bearer token to use for bearer token authentication

    • getBearerToken

      public String 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