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

    • 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

    • 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: boolean type. Default: true Group: security
      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 boolean type. Default: true Group: security
      Parameters:
      allowOriginHeader - the value to set
      Returns:
      the dsl builder

    • handshakeHeaders

      default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder handshakeHeaders(String key, Object value)
      Headers to send in the HTTP handshake request. When the endpoint is a consumer, it only works when it consumes a remote host as a client (i.e. consumeAsClient is true). This is a multi-value option with prefix: handshake. The option is a: java.util.Map<java.lang.String, java.lang.Object> type. The option is multivalued, and you can use the handshakeHeaders(String, Object) method to add a value (call the method multiple times to set more values). Group: security
      Parameters:
      key - the option key
      value - the option value
      Returns:
      the dsl builder

    • handshakeHeaders

      default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder handshakeHeaders(Map values)
      Headers to send in the HTTP handshake request. When the endpoint is a consumer, it only works when it consumes a remote host as a client (i.e. consumeAsClient is true). This is a multi-value option with prefix: handshake. The option is a: java.util.Map<java.lang.String, java.lang.Object> type. The option is multivalued, and you can use the handshakeHeaders(String, Object) method to add a value (call the method multiple times to set more values). Group: security
      Parameters:
      values - the values
      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: java.lang.String type. Group: security
      Parameters:
      originHeaderUrl - 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