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

Interface VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
All Known Subinterfaces:
VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointBuilder
Enclosing interface:
VertxWebsocketEndpointBuilderFactory
public static interface VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the Vert.x WebSocket component.

  • Method Details

    • advanced

      default VertxWebsocketEndpointBuilderFactory.AdvancedVertxWebsocketEndpointConsumerBuilder advanced()

    • allowedOriginPattern

      default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder allowedOriginPattern(String allowedOriginPattern)
      Regex pattern to match the origin header sent by WebSocket clients. The option is a: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      allowedOriginPattern - the value to set
      Returns:
      the dsl builder

    • consumeAsClient

      default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder consumeAsClient(boolean consumeAsClient)
      When set to true, the consumer acts as a WebSocket client, creating exchanges on each received WebSocket event. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      consumeAsClient - the value to set
      Returns:
      the dsl builder

    • consumeAsClient

      default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder consumeAsClient(String consumeAsClient)
      When set to true, the consumer acts as a WebSocket client, creating exchanges on each received WebSocket event. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      consumeAsClient - the value to set
      Returns:
      the dsl builder

    • fireWebSocketConnectionEvents

      default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder fireWebSocketConnectionEvents(boolean fireWebSocketConnectionEvents)
      Whether the server consumer will create a message exchange when a new WebSocket peer connects or disconnects. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      fireWebSocketConnectionEvents - the value to set
      Returns:
      the dsl builder

    • fireWebSocketConnectionEvents

      default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder fireWebSocketConnectionEvents(String fireWebSocketConnectionEvents)
      Whether the server consumer will create a message exchange when a new WebSocket peer connects or disconnects. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      fireWebSocketConnectionEvents - the value to set
      Returns:
      the dsl builder

    • maxReconnectAttempts

      default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder maxReconnectAttempts(int maxReconnectAttempts)
      When consumeAsClient is set to true this sets the maximum number of allowed reconnection attempts to a previously closed WebSocket. A value of 0 (the default) will attempt to reconnect indefinitely. The option is a: <code>int</code> type. Default: 0 Group: consumer
      Parameters:
      maxReconnectAttempts - the value to set
      Returns:
      the dsl builder

    • maxReconnectAttempts

      default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder maxReconnectAttempts(String maxReconnectAttempts)
      When consumeAsClient is set to true this sets the maximum number of allowed reconnection attempts to a previously closed WebSocket. A value of 0 (the default) will attempt to reconnect indefinitely. The option will be converted to a <code>int</code> type. Default: 0 Group: consumer
      Parameters:
      maxReconnectAttempts - the value to set
      Returns:
      the dsl builder

    • reconnectInitialDelay

      default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder reconnectInitialDelay(int reconnectInitialDelay)
      When consumeAsClient is set to true this sets the initial delay in milliseconds before attempting to reconnect to a previously closed WebSocket. The option is a: <code>int</code> type. Default: 0 Group: consumer
      Parameters:
      reconnectInitialDelay - the value to set
      Returns:
      the dsl builder

    • reconnectInitialDelay

      default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder reconnectInitialDelay(String reconnectInitialDelay)
      When consumeAsClient is set to true this sets the initial delay in milliseconds before attempting to reconnect to a previously closed WebSocket. The option will be converted to a <code>int</code> type. Default: 0 Group: consumer
      Parameters:
      reconnectInitialDelay - the value to set
      Returns:
      the dsl builder

    • reconnectInterval

      default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder reconnectInterval(int reconnectInterval)
      When consumeAsClient is set to true this sets the interval in milliseconds at which reconnecting to a previously closed WebSocket occurs. The option is a: <code>int</code> type. Default: 1000 Group: consumer
      Parameters:
      reconnectInterval - the value to set
      Returns:
      the dsl builder

    • reconnectInterval

      default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder reconnectInterval(String reconnectInterval)
      When consumeAsClient is set to true this sets the interval in milliseconds at which reconnecting to a previously closed WebSocket occurs. The option will be converted to a <code>int</code> type. Default: 1000 Group: consumer
      Parameters:
      reconnectInterval - the value to set
      Returns:
      the dsl builder

    • router

      default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder router(io.vertx.ext.web.Router router)
      To use an existing vertx router for the HTTP server. The option is a: <code>io.vertx.ext.web.Router</code> type. Group: consumer
      Parameters:
      router - the value to set
      Returns:
      the dsl builder

    • router

      default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder router(String router)
      To use an existing vertx router for the HTTP server. The option will be converted to a <code>io.vertx.ext.web.Router</code> type. Group: consumer
      Parameters:
      router - the value to set
      Returns:
      the dsl builder

    • serverOptions

      default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder serverOptions(io.vertx.core.http.HttpServerOptions serverOptions)
      Sets customized options for configuring the HTTP server hosting the WebSocket for the consumer. The option is a: <code>io.vertx.core.http.HttpServerOptions</code> type. Group: consumer
      Parameters:
      serverOptions - the value to set
      Returns:
      the dsl builder

    • serverOptions

      default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder serverOptions(String serverOptions)
      Sets customized options for configuring the HTTP server hosting the WebSocket for the consumer. The option will be converted to a <code>io.vertx.core.http.HttpServerOptions</code> type. Group: consumer
      Parameters:
      serverOptions - the value to set
      Returns:
      the dsl builder

    • sslContextParameters

      default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder 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.VertxWebsocketEndpointConsumerBuilder 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