Package org.apache.camel.builder.endpoint.dsl

Interface VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
All Known Subinterfaces:
VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointBuilder
Enclosing interface:
VertxWebsocketEndpointBuilderFactory
public static interface VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint producers for the Vert.x WebSocket component.

  • Method Details

    • advanced

      default VertxWebsocketEndpointBuilderFactory.AdvancedVertxWebsocketEndpointProducerBuilder advanced()

    • clientOptions

      default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder clientOptions(io.vertx.core.http.HttpClientOptions clientOptions)
      Sets customized options for configuring the WebSocket client used in the producer. The option is a: io.vertx.core.http.HttpClientOptions type. Group: producer
      Parameters:
      clientOptions - the value to set
      Returns:
      the dsl builder

    • clientOptions

      default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder clientOptions(String clientOptions)
      Sets customized options for configuring the WebSocket client used in the producer. The option will be converted to a io.vertx.core.http.HttpClientOptions type. Group: producer
      Parameters:
      clientOptions - the value to set
      Returns:
      the dsl builder

    • clientSubProtocols

      default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder clientSubProtocols(String clientSubProtocols)
      Comma separated list of WebSocket subprotocols that the client should use for the Sec-WebSocket-Protocol header. The option is a: java.lang.String type. Group: producer
      Parameters:
      clientSubProtocols - the value to set
      Returns:
      the dsl builder

    • sendToAll

      default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder sendToAll(boolean sendToAll)
      To send to all websocket subscribers. Can be used to configure at the endpoint level, instead of providing the VertxWebsocketConstants.SEND_TO_ALL header on the message. Note that when using this option, the host name specified for the vertx-websocket producer URI must match one used for an existing vertx-websocket consumer. Note that this option only applies when producing messages to endpoints hosted by the vertx-websocket consumer and not to an externally hosted WebSocket. The option is a: boolean type. Default: false Group: producer
      Parameters:
      sendToAll - the value to set
      Returns:
      the dsl builder

    • sendToAll

      default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder sendToAll(String sendToAll)
      To send to all websocket subscribers. Can be used to configure at the endpoint level, instead of providing the VertxWebsocketConstants.SEND_TO_ALL header on the message. Note that when using this option, the host name specified for the vertx-websocket producer URI must match one used for an existing vertx-websocket consumer. Note that this option only applies when producing messages to endpoints hosted by the vertx-websocket consumer and not to an externally hosted WebSocket. The option will be converted to a boolean type. Default: false Group: producer
      Parameters:
      sendToAll - the value to set
      Returns:
      the dsl builder

    • sslContextParameters

      default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)
      To configure security using SSLContextParameters. The option is a: org.apache.camel.support.jsse.SSLContextParameters type. Group: security
      Parameters:
      sslContextParameters - the value to set
      Returns:
      the dsl builder

    • sslContextParameters

      default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder sslContextParameters(String sslContextParameters)
      To configure security using SSLContextParameters. The option will be converted to a org.apache.camel.support.jsse.SSLContextParameters type. Group: security
      Parameters:
      sslContextParameters - the value to set
      Returns:
      the dsl builder