Class VertxWebsocketConfiguration
- java.lang.Object
-
- org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration
-
@UriParams public class VertxWebsocketConfiguration extends Object
-
-
Constructor Summary
Constructors Constructor Description VertxWebsocketConfiguration()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetAllowedOriginPattern()io.vertx.core.http.HttpClientOptionsgetClientOptions()StringgetClientSubProtocols()StringgetHost()StringgetPath()intgetPort()io.vertx.ext.web.RoutergetRouter()io.vertx.core.http.HttpServerOptionsgetServerOptions()org.apache.camel.support.jsse.SSLContextParametersgetSslContextParameters()To configure security using SSLContextParametersbooleanisSendToAll()voidsetAllowedOriginPattern(String allowedOriginPattern)Regex pattern to match the origin header sent by WebSocket clientsvoidsetClientOptions(io.vertx.core.http.HttpClientOptions clientOptions)Sets customized options for configuring the WebSocket client used in the producervoidsetClientSubProtocols(String clientSubProtocols)Comma separated list of WebSocket subprotocols that the client should use for the Sec-WebSocket-Protocol headervoidsetHost(String host)The host that the consumer should bind to or the host of the remote websocket destination that the producer should connect tovoidsetPath(String path)The path that the consumer should bind to or path of the remote websocket destination that the producer should connect tovoidsetPort(int port)The port that the consumer should bind to or port of the remote websocket destination that the producer should connect tovoidsetRouter(io.vertx.ext.web.Router router)To use an existing vertx router for the HTTP servervoidsetSendToAll(boolean sendToAll)To send to all websocket subscribers.voidsetServerOptions(io.vertx.core.http.HttpServerOptions serverOptions)Sets customized options for configuring the HTTP server hosting the WebSocket for the consumervoidsetSslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)
-
-
-
Method Detail
-
getHost
public String getHost()
-
setHost
public void setHost(String host)
The host that the consumer should bind to or the host of the remote websocket destination that the producer should connect to
-
getPort
public int getPort()
-
setPort
public void setPort(int port)
The port that the consumer should bind to or port of the remote websocket destination that the producer should connect to
-
getPath
public String getPath()
-
setClientOptions
public void setClientOptions(io.vertx.core.http.HttpClientOptions clientOptions)
Sets customized options for configuring the WebSocket client used in the producer
-
getServerOptions
public io.vertx.core.http.HttpServerOptions getServerOptions()
-
setServerOptions
public void setServerOptions(io.vertx.core.http.HttpServerOptions serverOptions)
Sets customized options for configuring the HTTP server hosting the WebSocket for the consumer
-
setPath
public void setPath(String path)
The path that the consumer should bind to or path of the remote websocket destination that the producer should connect to
-
getClientOptions
public io.vertx.core.http.HttpClientOptions getClientOptions()
-
setSendToAll
public void setSendToAll(boolean sendToAll)
To send to all websocket subscribers. Can be used to configure on endpoint level, instead of having to use theVertxWebsocketConstants.SEND_TO_ALLheader on the message.
-
isSendToAll
public boolean isSendToAll()
-
getSslContextParameters
public org.apache.camel.support.jsse.SSLContextParameters getSslContextParameters()
To configure security using SSLContextParameters
-
setSslContextParameters
public void setSslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)
-
getAllowedOriginPattern
public String getAllowedOriginPattern()
-
setAllowedOriginPattern
public void setAllowedOriginPattern(String allowedOriginPattern)
Regex pattern to match the origin header sent by WebSocket clients
-
getRouter
public io.vertx.ext.web.Router getRouter()
-
setRouter
public void setRouter(io.vertx.ext.web.Router router)
To use an existing vertx router for the HTTP server
-
setClientSubProtocols
public void setClientSubProtocols(String clientSubProtocols)
Comma separated list of WebSocket subprotocols that the client should use for the Sec-WebSocket-Protocol header
-
getClientSubProtocols
public String getClientSubProtocols()
-
-