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:

CamelContextAware, Endpoint, IsSingleton, Service, ShutdownableService, HasId, StatefulService, SuspendableService

public class WebsocketEndpoint
extends DefaultEndpoint

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 remaining, Map<String,Object> parameters)

Method Summary

Methods

Modifier and Type	Method and Description
void	connect(WebsocketConsumer consumer)
void	connect(WebsocketProducer producer)
Consumer	createConsumer(Processor processor) Creates a new Event Driven Consumer which consumes messages from the endpoint using the given processor
Producer	createProducer() Creates a new producer which is used send messages into the endpoint
void	disconnect(WebsocketConsumer consumer)
void	disconnect(WebsocketProducer producer)
protected void	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
String	getAllowedOrigins()
WebsocketComponent	getComponent() Returns the component that created this endpoint.
String	getFilterPath()
List<org.eclipse.jetty.server.Handler>	getHandlers()
String	getHost()
String	getPath()
Integer	getPort()
String	getProtocol()
Boolean	getSendToAll()
SSLContextParameters	getSslContextParameters()
String	getStaticResources()
URI	getUri()
boolean	isCrossOriginFilterOn()
boolean	isEnableJmx()
boolean	isSessionSupport()
boolean	isSingleton() Whether this class supports being singleton or not.
void	setAllowedOrigins(String allowedOrigins)
void	setCrossOriginFilterOn(boolean crossOriginFilterOn)
void	setEnableJmx(boolean enableJmx)
void	setFilterPath(String filterPath)
void	setHandlers(List<org.eclipse.jetty.server.Handler> handlers)
void	setHost(String host)
void	setPort(int port)
void	setSendToAll(Boolean sendToAll)
void	setSessionSupport(boolean support)
void	setSslContextParameters(SSLContextParameters sslContextParameters)
void	setStaticResources(String staticResources)

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

configureConsumer, configureProperties, createEndpointConfiguration, createEndpointUri, createExchange, createExchange, createExchange, createPollingConsumer, equals, getCamelContext, getConsumerProperties, getEndpointConfiguration, getEndpointKey, getEndpointUri, getExchangePattern, getId, hashCode, isLenientProperties, isSynchronous, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExchangePattern, setSynchronous, toString

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

doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspended, isSuspending, 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 remaining,
                 Map<String,Object> parameters)

Method Detail

getComponent

public WebsocketComponent getComponent()

Description copied from class: DefaultEndpoint

Returns the component that created this endpoint.

Overrides:

getComponent in class DefaultEndpoint

Returns:

the component that created this endpoint, or null if none set

createConsumer

public Consumer createConsumer(Processor processor)
                        throws Exception

Description copied from interface: Endpoint

Creates a new Event Driven Consumer which consumes messages from the endpoint using the given processor

Parameters:

processor - the given processor

Returns:

a newly created consumer

Throws:

Exception - can be thrown

createProducer

public Producer createProducer()
                        throws Exception

Description copied from interface: Endpoint

Creates a new producer which is used send messages into the endpoint

Returns:

a newly created producer

Throws:

Exception - can be thrown

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()

Description copied from interface: IsSingleton

Whether this class supports being singleton or not.

Returns:

true to be a single shared instance, false to create new instances.

getUri

public URI getUri()

getPort

public Integer getPort()

getHost

public String getHost()

setHost

public void setHost(String host)

setPort

public void setPort(int port)

getStaticResources

public String getStaticResources()

setStaticResources

public void setStaticResources(String staticResources)

getSendToAll

public Boolean getSendToAll()

setSendToAll

public void setSendToAll(Boolean sendToAll)

getProtocol

public String getProtocol()

getPath

public String getPath()

setSessionSupport

public void setSessionSupport(boolean support)

isSessionSupport

public boolean isSessionSupport()

getHandlers

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

setHandlers

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

getSslContextParameters

public SSLContextParameters getSslContextParameters()

setSslContextParameters

public void setSslContextParameters(SSLContextParameters sslContextParameters)

isEnableJmx

public boolean isEnableJmx()

setEnableJmx

public void setEnableJmx(boolean enableJmx)

getAllowedOrigins

public String getAllowedOrigins()

setAllowedOrigins

public void setAllowedOrigins(String allowedOrigins)

isCrossOriginFilterOn

public boolean isCrossOriginFilterOn()

setCrossOriginFilterOn

public void setCrossOriginFilterOn(boolean crossOriginFilterOn)

getFilterPath

public String getFilterPath()

setFilterPath

public void setFilterPath(String filterPath)

doStart

protected void doStart()
                throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: See ServiceSupport.doStop() for more details.

Overrides:

doStart in class DefaultEndpoint

Throws:

Exception

See Also:

ServiceSupport.doStop()

doStop

protected void doStop()
               throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: Camel will invoke this ServiceSupport.doStop() method when the service is being stopped. This method will also be invoked if the service is still in uninitialized state (eg has not been started). The method is always called to allow the service to do custom logic when the service is being stopped, such as when CamelContext is shutting down.

Overrides:

doStop in class DefaultEndpoint

Throws:

Exception

See Also:

ServiceSupport.doStart()