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

Class VertxWebsocketEndpointBuilderFactory.VertxWebsocketHeaderNameBuilder

java.lang.Object
org.apache.camel.builder.endpoint.dsl.VertxWebsocketEndpointBuilderFactory.VertxWebsocketHeaderNameBuilder
Enclosing interface:
VertxWebsocketEndpointBuilderFactory
public static class VertxWebsocketEndpointBuilderFactory.VertxWebsocketHeaderNameBuilder extends Object
The builder of headers' name for the Vert.x WebSocket component.

  • Constructor Details

    • VertxWebsocketHeaderNameBuilder

      public VertxWebsocketHeaderNameBuilder()

  • Method Details

    • vertxwebsocketConnectionkey

      public String vertxwebsocketConnectionkey()
      Sends the message to the client with the given connection key. You can use a comma separated list of keys to send a message to multiple clients. 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: String type. Group: common
      Returns:
      the name of the header VertxWebsocket.connectionKey.

    • vertxwebsocketSendtoall

      public String vertxwebsocketSendtoall()
      Sends the message to all clients which are currently connected. You can use the sendToAll option on the endpoint instead of using this header. 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. Group: producer
      Returns:
      the name of the header VertxWebsocket.sendToAll.

    • vertxwebsocketRemoteaddress

      public String vertxwebsocketRemoteaddress()
      The remote address. The option is a: io.vertx.core.net.SocketAddress type. Group: consumer
      Returns:
      the name of the header VertxWebsocket.remoteAddress.

    • vertxwebsocketEvent

      public String vertxwebsocketEvent()
      The WebSocket event that triggered the message exchange. The option is a: org.apache.camel.component.vertx.websocket.VertxWebsocketEvent type. Group: consumer
      Returns:
      the name of the header VertxWebsocket.event.