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: java.lang.String 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: boolean 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 boolean 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: boolean 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 boolean 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: int type. 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 int type. 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: int type. 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 int type. 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: int 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 int type. Default: 1000 Group: consumer
      Parameters:
      reconnectInterval - the value to set
      Returns:
      the dsl builder

    • allowOriginHeader

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