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

Interface VertxHttpComponentBuilderFactory.VertxHttpComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.vertx.http.VertxHttpComponent>
All Known Implementing Classes:
VertxHttpComponentBuilderFactory.VertxHttpComponentBuilderImpl
Enclosing interface:
VertxHttpComponentBuilderFactory
public static interface VertxHttpComponentBuilderFactory.VertxHttpComponentBuilder extends ComponentBuilder<org.apache.camel.component.vertx.http.VertxHttpComponent>
Builder for the Vert.x HTTP Client component.

  • Method Details

    • lazyStartProducer

      default VertxHttpComponentBuilderFactory.VertxHttpComponentBuilder 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

    • responsePayloadAsByteArray

      default VertxHttpComponentBuilderFactory.VertxHttpComponentBuilder responsePayloadAsByteArray(boolean responsePayloadAsByteArray)
      Whether the response body should be byte or as io.vertx.core.buffer.Buffer. The option is a: <code>boolean</code> type. Default: true Group: producer
      Parameters:
      responsePayloadAsByteArray - the value to set
      Returns:
      the dsl builder

    • allowJavaSerializedObject

      default VertxHttpComponentBuilderFactory.VertxHttpComponentBuilder allowJavaSerializedObject(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. The option is a: <code>boolean</code> type. Default: false Group: advanced
      Parameters:
      allowJavaSerializedObject - the value to set
      Returns:
      the dsl builder

    • autowiredEnabled

      default VertxHttpComponentBuilderFactory.VertxHttpComponentBuilder 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

    • vertx

      default VertxHttpComponentBuilderFactory.VertxHttpComponentBuilder vertx(io.vertx.core.Vertx vertx)
      To use an existing vertx instead of creating a new instance. The option is a: <code>io.vertx.core.Vertx</code> type. Group: advanced
      Parameters:
      vertx - the value to set
      Returns:
      the dsl builder

    • vertxHttpBinding

      default VertxHttpComponentBuilderFactory.VertxHttpComponentBuilder vertxHttpBinding(org.apache.camel.component.vertx.http.VertxHttpBinding vertxHttpBinding)
      A custom VertxHttpBinding which can control how to bind between Vert.x and Camel. The option is a: <code>org.apache.camel.component.vertx.http.VertxHttpBinding</code> type. Group: advanced
      Parameters:
      vertxHttpBinding - the value to set
      Returns:
      the dsl builder

    • vertxOptions

      default VertxHttpComponentBuilderFactory.VertxHttpComponentBuilder vertxOptions(io.vertx.core.VertxOptions vertxOptions)
      To provide a custom set of vertx options for configuring vertx. The option is a: <code>io.vertx.core.VertxOptions</code> type. Group: advanced
      Parameters:
      vertxOptions - the value to set
      Returns:
      the dsl builder

    • webClientOptions

      default VertxHttpComponentBuilderFactory.VertxHttpComponentBuilder webClientOptions(io.vertx.ext.web.client.WebClientOptions webClientOptions)
      To provide a custom set of options for configuring vertx web client. The option is a: <code>io.vertx.ext.web.client.WebClientOptions</code> type. Group: advanced
      Parameters:
      webClientOptions - the value to set
      Returns:
      the dsl builder

    • headerFilterStrategy

      default VertxHttpComponentBuilderFactory.VertxHttpComponentBuilder 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

    • proxyHost

      default VertxHttpComponentBuilderFactory.VertxHttpComponentBuilder proxyHost(String proxyHost)
      The proxy server host address. The option is a: <code>java.lang.String</code> type. Group: proxy
      Parameters:
      proxyHost - the value to set
      Returns:
      the dsl builder

    • proxyPassword

      default VertxHttpComponentBuilderFactory.VertxHttpComponentBuilder proxyPassword(String proxyPassword)
      The proxy server password if authentication is required. The option is a: <code>java.lang.String</code> type. Group: proxy
      Parameters:
      proxyPassword - the value to set
      Returns:
      the dsl builder

    • proxyPort

      default VertxHttpComponentBuilderFactory.VertxHttpComponentBuilder proxyPort(Integer proxyPort)
      The proxy server port. The option is a: <code>java.lang.Integer</code> type. Group: proxy
      Parameters:
      proxyPort - the value to set
      Returns:
      the dsl builder

    • proxyType

      default VertxHttpComponentBuilderFactory.VertxHttpComponentBuilder proxyType(io.vertx.core.net.ProxyType proxyType)
      The proxy server type. The option is a: <code>io.vertx.core.net.ProxyType</code> type. Group: proxy
      Parameters:
      proxyType - the value to set
      Returns:
      the dsl builder

    • proxyUsername

      default VertxHttpComponentBuilderFactory.VertxHttpComponentBuilder proxyUsername(String proxyUsername)
      The proxy server username if authentication is required. The option is a: <code>java.lang.String</code> type. Group: proxy
      Parameters:
      proxyUsername - the value to set
      Returns:
      the dsl builder

    • basicAuthPassword

      default VertxHttpComponentBuilderFactory.VertxHttpComponentBuilder basicAuthPassword(String basicAuthPassword)
      The password to use for basic authentication. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      basicAuthPassword - the value to set
      Returns:
      the dsl builder

    • basicAuthUsername

      default VertxHttpComponentBuilderFactory.VertxHttpComponentBuilder basicAuthUsername(String basicAuthUsername)
      The user name to use for basic authentication. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      basicAuthUsername - the value to set
      Returns:
      the dsl builder

    • bearerToken

      default VertxHttpComponentBuilderFactory.VertxHttpComponentBuilder bearerToken(String bearerToken)
      The bearer token to use for bearer token authentication. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      bearerToken - the value to set
      Returns:
      the dsl builder

    • sslContextParameters

      default VertxHttpComponentBuilderFactory.VertxHttpComponentBuilder sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)
      To configure security using SSLContextParameters. 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 VertxHttpComponentBuilderFactory.VertxHttpComponentBuilder 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