org.apache.camel.component.websocket

Class WebsocketEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.component.websocket.WebsocketEndpoint

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasId, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

@UriEndpoint(scheme="websocket",
             title="Jetty Websocket",
             syntax="websocket:host:port/resourceUri",
             consumerClass=WebsocketConsumer.class,
             label="websocket")
public class WebsocketEndpoint
extends org.apache.camel.impl.DefaultEndpoint

The websocket component provides websocket endpoints for communicating with clients using websocket. This component uses Jetty as the websocket implementation.

Field Summary

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
WebsocketEndpoint(WebsocketComponent component, String uri, String resourceUri, Map<String,Object> parameters)

Method Summary

Modifier and Type	Method and Description
void	connect(WebsocketConsumer consumer)
void	connect(WebsocketProducer producer)
org.apache.camel.Consumer	createConsumer(org.apache.camel.Processor processor)
org.apache.camel.Producer	createProducer()
void	disconnect(WebsocketConsumer consumer)
void	disconnect(WebsocketProducer producer)
String	getAllowedOrigins()
Integer	getBufferSize()
WebsocketComponent	getComponent()
String	getFilterPath()
List<org.eclipse.jetty.server.Handler>	getHandlers()
String	getHost()
Integer	getMaxBinaryMessageSize()
Integer	getMaxIdleTime()
Integer	getMaxTextMessageSize()
Integer	getMinVersion()
String	getPath()
Integer	getPort()
String	getProtocol()
String	getResourceUri()
Integer	getSendTimeout()
Boolean	getSendToAll()
org.apache.camel.util.jsse.SSLContextParameters	getSslContextParameters()
String	getStaticResources()
URI	getUri()
boolean	isCrossOriginFilterOn()
boolean	isEnableJmx()
boolean	isSessionSupport()
boolean	isSingleton()
void	setAllowedOrigins(String allowedOrigins) The CORS allowed origins.
void	setBufferSize(Integer bufferSize) Set the buffer size of the websocketServlet, which is also the max frame byte size (default 8192)
void	setCrossOriginFilterOn(boolean crossOriginFilterOn) Whether to enable CORS
void	setEnableJmx(boolean enableJmx) If this option is true, Jetty JMX support will be enabled for this endpoint.
void	setFilterPath(String filterPath) Context path for filtering CORS
void	setHandlers(List<org.eclipse.jetty.server.Handler> handlers)
void	setHost(String host) The hostname.
void	setMaxBinaryMessageSize(Integer maxBinaryMessageSize) Can be used to set the size in bytes that the websocket created by the websocketServlet may be accept before closing.
void	setMaxIdleTime(Integer maxIdleTime) Set the time in ms that the websocket created by the websocketServlet may be idle before closing.
void	setMaxTextMessageSize(Integer maxTextMessageSize) Can be used to set the size in characters that the websocket created by the websocketServlet may be accept before closing.
void	setMinVersion(Integer minVersion) Can be used to set the minimum protocol version accepted for the websocketServlet.
void	setPort(int port) The port number.
void	setResourceUri(String resourceUri) Name of the websocket channel to use
void	setSendTimeout(Integer sendTimeout) Timeout in millis when sending to a websocket channel.
void	setSendToAll(Boolean sendToAll) To send to all websocket subscribers.
void	setSessionSupport(boolean support) Whether to enable session support which enables HttpSession for each http request.
void	setSslContextParameters(org.apache.camel.util.jsse.SSLContextParameters sslContextParameters) To configure security using SSLContextParameters
void	setStaticResources(String staticResources) Set a resource path for static resources (such as .html files etc).

Methods inherited from class org.apache.camel.impl.DefaultEndpoint

configureConsumer, configurePollingConsumer, configureProperties, createEndpointConfiguration, createEndpointUri, createExchange, createExchange, createExchange, createPollingConsumer, doStart, doStop, equals, getCamelContext, getConsumerProperties, getEndpointConfiguration, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isBridgeErrorHandler, isLenientProperties, isPollingConsumerBlockWhenFull, isSynchronous, setBridgeErrorHandler, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerQueueSize, setProperties, setSynchronous, toString

Methods inherited from class org.apache.camel.support.ServiceSupport

doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.camel.Service

start, stop

Constructor Detail

WebsocketEndpoint

public WebsocketEndpoint(WebsocketComponent component,
                         String uri,
                         String resourceUri,
                         Map<String,Object> parameters)

Method Detail

getComponent

public WebsocketComponent getComponent()

Overrides:

getComponent in class org.apache.camel.impl.DefaultEndpoint

createConsumer

public org.apache.camel.Consumer createConsumer(org.apache.camel.Processor processor)
                                         throws Exception

Throws:

Exception

createProducer

public org.apache.camel.Producer createProducer()
                                         throws Exception

Throws:

Exception

connect

public void connect(WebsocketConsumer consumer)
             throws Exception

Throws:

Exception

disconnect

public void disconnect(WebsocketConsumer consumer)
                throws Exception

Throws:

Exception

connect

public void connect(WebsocketProducer producer)
             throws Exception

Throws:

Exception

disconnect

public void disconnect(WebsocketProducer producer)
                throws Exception

Throws:

Exception

isSingleton

public boolean isSingleton()

getUri

public URI getUri()

getPort

public Integer getPort()

getHost

public String getHost()

setHost

public void setHost(String host)

The hostname. The default value is 0.0.0.0. Setting this option on the component will use the component configured value as default.

setPort

public void setPort(int port)

The port number. The default value is 9292. Setting this option on the component will use the component configured value as default.

getStaticResources

public String getStaticResources()

setStaticResources

public void setStaticResources(String staticResources)

Set a resource path for static resources (such as .html files etc).

The resources can be loaded from classpath, if you prefix with classpath:, otherwise the resources is loaded from file system or from JAR files.

For example to load from root classpath use classpath:., or classpath:WEB-INF/static

If not configured (eg null) then no static resource is in use.

getSendToAll

public Boolean getSendToAll()

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 the WebsocketConstants.SEND_TO_ALL header on the message.

getSendTimeout

public Integer getSendTimeout()

setSendTimeout

public void setSendTimeout(Integer sendTimeout)

Timeout in millis when sending to a websocket channel. The default timeout is 30000 (30 seconds).

getProtocol

public String getProtocol()

getPath

public String getPath()

setSessionSupport

public void setSessionSupport(boolean support)

Whether to enable session support which enables HttpSession for each http request.

isSessionSupport

public boolean isSessionSupport()

getBufferSize

public Integer getBufferSize()

setBufferSize

public void setBufferSize(Integer bufferSize)

Set the buffer size of the websocketServlet, which is also the max frame byte size (default 8192)

getMaxIdleTime

public Integer getMaxIdleTime()

setMaxIdleTime

public void setMaxIdleTime(Integer maxIdleTime)

Set the time in ms that the websocket created by the websocketServlet may be idle before closing. (default is 300000)

getMaxTextMessageSize

public Integer getMaxTextMessageSize()

setMaxTextMessageSize

public void setMaxTextMessageSize(Integer maxTextMessageSize)

Can be used to set the size in characters that the websocket created by the websocketServlet may be accept before closing.

getMaxBinaryMessageSize

public Integer getMaxBinaryMessageSize()

setMaxBinaryMessageSize

public void setMaxBinaryMessageSize(Integer maxBinaryMessageSize)

Can be used to set the size in bytes that the websocket created by the websocketServlet may be accept before closing. (Default is -1 - or unlimited)

getMinVersion

public Integer getMinVersion()

setMinVersion

public void setMinVersion(Integer minVersion)

Can be used to set the minimum protocol version accepted for the websocketServlet. (Default 13 - the RFC6455 version)

getHandlers

public List<org.eclipse.jetty.server.Handler> getHandlers()

setHandlers

public void setHandlers(List<org.eclipse.jetty.server.Handler> handlers)

getSslContextParameters

public org.apache.camel.util.jsse.SSLContextParameters getSslContextParameters()

setSslContextParameters

public void setSslContextParameters(org.apache.camel.util.jsse.SSLContextParameters sslContextParameters)

To configure security using SSLContextParameters

isEnableJmx

public boolean isEnableJmx()

setEnableJmx

public void setEnableJmx(boolean enableJmx)

If this option is true, Jetty JMX support will be enabled for this endpoint. See Jetty JMX support for more details.

getAllowedOrigins

public String getAllowedOrigins()

setAllowedOrigins

public void setAllowedOrigins(String allowedOrigins)

The CORS allowed origins. Use * to allow all.

isCrossOriginFilterOn

public boolean isCrossOriginFilterOn()

setCrossOriginFilterOn

public void setCrossOriginFilterOn(boolean crossOriginFilterOn)

Whether to enable CORS

getFilterPath

public String getFilterPath()

setFilterPath

public void setFilterPath(String filterPath)

Context path for filtering CORS

getResourceUri

public String getResourceUri()

setResourceUri

public void setResourceUri(String resourceUri)

Name of the websocket channel to use