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()

    • allowOriginHeader

      default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder allowOriginHeader(boolean allowOriginHeader)
      Whether the WebSocket client should add the Origin header to the WebSocket handshake request. The option is a: <code>boolean</code> type. Default: true Group: consumer
      Parameters:
      allowOriginHeader - the value to set
      Returns:
      the dsl builder

    • allowOriginHeader

      default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder allowOriginHeader(String allowOriginHeader)
      Whether the WebSocket client should add the Origin header to the WebSocket handshake request. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer
      Parameters:
      allowOriginHeader - the value to set
      Returns:
      the dsl builder

    • originHeaderUrl

      default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder originHeaderUrl(String originHeaderUrl)
      The value of the Origin header that the WebSocket client should use on the WebSocket handshake request. When not specified, the WebSocket client will automatically determine the value for the Origin from the request URL. The option is a: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      originHeaderUrl - the value to set
      Returns:
      the dsl builder

    • 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: <code>io.vertx.core.http.HttpClientOptions</code> 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 <code>io.vertx.core.http.HttpClientOptions</code> 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: <code>java.lang.String</code> 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: <code>boolean</code> 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 <code>boolean</code> 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: <code>org.apache.camel.support.jsse.SSLContextParameters</code> 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 <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security
      Parameters:
      sslContextParameters - the value to set
      Returns:
      the dsl builder