org.apache.camel.component.vertx.websocket

Class VertxWebsocketComponent

java.lang.Object

org.apache.camel.support.service.BaseService

org.apache.camel.support.service.ServiceSupport

org.apache.camel.support.DefaultComponent

org.apache.camel.component.vertx.websocket.VertxWebsocketComponent

All Implemented Interfaces:

AutoCloseable, org.apache.camel.CamelContextAware, org.apache.camel.Component, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.SSLContextParametersAware, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

@Component(value="vertx-websocket")
public class VertxWebsocketComponent
extends org.apache.camel.support.DefaultComponent
implements org.apache.camel.SSLContextParametersAware

Field Summary

Fields inherited from class org.apache.camel.support.service.BaseService

BUILT, FAILED, INITIALIZED, INITIALIZING, lock, NEW, SHUTDOWN, SHUTTING_DOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

Constructor Summary

Constructors

Constructor and Description
VertxWebsocketComponent()

Method Summary

Modifier and Type	Method and Description
void	connectConsumer(VertxWebsocketConsumer consumer)
protected org.apache.camel.Endpoint	createEndpoint(String uri, String remaining, Map<String,Object> parameters)
protected VertxWebsocketHost	createVertxWebsocketHost(VertxWebsocketHostConfiguration hostConfiguration, VertxWebsocketHostKey hostKey)
void	disconnectConsumer(VertxWebsocketConsumer consumer)
protected void	doInit()
protected void	doStart()
protected void	doStop()
io.vertx.ext.web.Router	getRouter()
io.vertx.core.Vertx	getVertx()
protected Map<VertxWebsocketHostKey,VertxWebsocketHost>	getVertxHostRegistry()
io.vertx.core.VertxOptions	getVertxOptions()
boolean	isUseGlobalSslContextParameters()
void	setRouter(io.vertx.ext.web.Router router) To provide a custom vertx router to use on the WebSocket server
void	setUseGlobalSslContextParameters(boolean useGlobalSslContextParameters) Enable usage of global SSL context parameters.
void	setVertx(io.vertx.core.Vertx vertx) To use an existing vertx instead of creating a new instance
void	setVertxOptions(io.vertx.core.VertxOptions vertxOptions) To provide a custom set of vertx options for configuring vertx

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

afterConfiguration, createEndpoint, createEndpoint, doBuild, getAndRemoveOrResolveReferenceParameter, getAndRemoveOrResolveReferenceParameter, getAndRemoveParameter, getAndRemoveParameter, getCamelContext, getComponentPropertyConfigurer, getDefaultName, getEndpointPropertyConfigurer, getExtension, getSupportedExtensions, ifStartsWithReturnRemainder, isAutowiredEnabled, isBridgeErrorHandler, isLazyStartProducer, registerExtension, registerExtension, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceParameter, resolveAndRemoveReferenceParameter, resolveRawParameterValues, setAutowiredEnabled, setBridgeErrorHandler, setCamelContext, setLazyStartProducer, setProperties, setProperties, setProperties, useIntrospectionOnEndpoint, useRawUri, validateParameters, validateURI

Methods inherited from class org.apache.camel.support.service.BaseService

build, doFail, doLifecycleChange, doResume, doShutdown, doSuspend, fail, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.camel.SSLContextParametersAware

retrieveGlobalSslContextParameters

Methods inherited from interface org.apache.camel.CamelContextAware

getCamelContext, setCamelContext, trySetCamelContext

Methods inherited from interface org.apache.camel.Component

trySetComponent

Methods inherited from interface org.apache.camel.Service

build, close, init, start, stop

Methods inherited from interface org.apache.camel.StatefulService

getStatus, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspending

Methods inherited from interface org.apache.camel.SuspendableService

isSuspended, resume, suspend

Methods inherited from interface org.apache.camel.ShutdownableService

shutdown

Constructor Detail

VertxWebsocketComponent

public VertxWebsocketComponent()

Method Detail

createEndpoint

protected org.apache.camel.Endpoint createEndpoint(String uri,
                                                   String remaining,
                                                   Map<String,Object> parameters)
                                            throws Exception

Specified by:

createEndpoint in class org.apache.camel.support.DefaultComponent

Throws:

Exception

doInit

protected void doInit()
               throws Exception

Overrides:

doInit in class org.apache.camel.support.DefaultComponent

Throws:

Exception

doStart

protected void doStart()
                throws Exception

Overrides:

doStart in class org.apache.camel.support.DefaultComponent

Throws:

Exception

doStop

protected void doStop()
               throws Exception

Overrides:

doStop in class org.apache.camel.support.DefaultComponent

Throws:

Exception

connectConsumer

public void connectConsumer(VertxWebsocketConsumer consumer)

disconnectConsumer

public void disconnectConsumer(VertxWebsocketConsumer consumer)

getVertx

public io.vertx.core.Vertx getVertx()

setVertx

public void setVertx(io.vertx.core.Vertx vertx)

To use an existing vertx instead of creating a new instance

getVertxOptions

public io.vertx.core.VertxOptions getVertxOptions()

setVertxOptions

public void setVertxOptions(io.vertx.core.VertxOptions vertxOptions)

To provide a custom set of vertx options for configuring vertx

getRouter

public io.vertx.ext.web.Router getRouter()

setRouter

public void setRouter(io.vertx.ext.web.Router router)

To provide a custom vertx router to use on the WebSocket server

isUseGlobalSslContextParameters

public boolean isUseGlobalSslContextParameters()

Specified by:

isUseGlobalSslContextParameters in interface org.apache.camel.SSLContextParametersAware

setUseGlobalSslContextParameters

public void setUseGlobalSslContextParameters(boolean useGlobalSslContextParameters)

Enable usage of global SSL context parameters.

Specified by:

setUseGlobalSslContextParameters in interface org.apache.camel.SSLContextParametersAware

getVertxHostRegistry

protected Map<VertxWebsocketHostKey,VertxWebsocketHost> getVertxHostRegistry()

createVertxWebsocketHost

protected VertxWebsocketHost createVertxWebsocketHost(VertxWebsocketHostConfiguration hostConfiguration,
                                                      VertxWebsocketHostKey hostKey)