Package org.apache.camel.component.dynamicrouter.control

Class DynamicRouterControlEndpoint

java.lang.Object

org.apache.camel.support.service.BaseService

org.apache.camel.support.service.ServiceSupport

org.apache.camel.support.DefaultEndpoint

org.apache.camel.component.dynamicrouter.control.DynamicRouterControlEndpoint

All Implemented Interfaces:

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

@UriEndpoint(firstVersion="4.4.0",
             scheme="dynamic-router-control",
             title="Dynamic Router Control",
             syntax="dynamic-router-control:controlAction",
             producerOnly=true,
             remote=false,
             headersClass=DynamicRouterControlConstants.class,
             category=MESSAGING)
public class DynamicRouterControlEndpoint
extends org.apache.camel.support.DefaultEndpoint

The Dynamic Router control endpoint for operations that allow routing participants to subscribe or unsubscribe to participate in dynamic message routing.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DynamicRouterControlEndpoint.DynamicRouterControlEndpointFactory	Factory to create the DynamicRouterControlEndpoint.

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	Description
DynamicRouterControlEndpoint(String uri, DynamicRouterControlComponent component, String controlAction, DynamicRouterControlConfiguration configuration)	Creates the instance.
DynamicRouterControlEndpoint(String uri, DynamicRouterControlComponent component, String controlAction, DynamicRouterControlConfiguration configuration, Supplier<DynamicRouterControlProducer.DynamicRouterControlProducerFactory> controlProducerFactorySupplier, Supplier<DynamicRouterControlService.DynamicRouterControlServiceFactory> controlServiceFactorySupplier)	Creates the instance.

Method Summary

Modifier and Type	Method	Description
org.apache.camel.Consumer	createConsumer(org.apache.camel.Processor processor)	This is a producer-only component.
org.apache.camel.Producer	createProducer()	Creates the DynamicRouterControlProducer.
protected void	doStart()	Starts the component, and creates the DynamicRouterControlService and adds it to the CamelContext.
protected void	doStop()	Stops the component, and removes the DynamicRouterControlService from the CamelContext.
DynamicRouterControlComponent	getComponent()
DynamicRouterControlConfiguration	getConfiguration()	Gets the DynamicRouterControlConfiguration.
String	getControlAction()	Gets the control action for this endpoint.
boolean	isRemote()

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

configureConsumer, configureExchange, configurePollingConsumer, configureProperties, createAsyncProducer, createEndpointUri, createExchange, createExchange, createPollingConsumer, doInit, equals, getCamelContext, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isAutowiredEnabled, isBridgeErrorHandler, isLazyStartProducer, isLenientProperties, isPollingConsumerBlockWhenFull, isPollingConsumerCopy, isSingleton, setAutowiredEnabled, setBridgeErrorHandler, setCamelContext, setComponent, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setLazyStartProducer, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerCopy, setPollingConsumerQueueSize, setProperties, toString

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

build, doBuild, doFail, doLifecycleChange, doResume, doShutdown, doSuspend, fail, getInternalLock, 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, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.camel.ComponentAware

getComponent

Methods inherited from interface org.apache.camel.Endpoint

getEndpointBaseUri, isSingletonProducer

Methods inherited from interface org.apache.camel.Service

build, close, init, start, stop

Methods inherited from interface org.apache.camel.ShutdownableService

shutdown

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

Constructor Details

DynamicRouterControlEndpoint

public DynamicRouterControlEndpoint(String uri,
 DynamicRouterControlComponent component,
 String controlAction,
 DynamicRouterControlConfiguration configuration,
 Supplier<DynamicRouterControlProducer.DynamicRouterControlProducerFactory> controlProducerFactorySupplier,
 Supplier<DynamicRouterControlService.DynamicRouterControlServiceFactory> controlServiceFactorySupplier)

Creates the instance.

Parameters:

uri - the URI that was used to cause the endpoint creation

component - the routing component to handle management of subscriber information from routing participants

controlAction - the control action of the endpoint

configuration - the component/endpoint configuration

controlProducerFactorySupplier - the DynamicRouterControlProducer.DynamicRouterControlProducerFactory supplier

controlServiceFactorySupplier - the DynamicRouterControlService.DynamicRouterControlServiceFactory supplier

DynamicRouterControlEndpoint

public DynamicRouterControlEndpoint(String uri,
 DynamicRouterControlComponent component,
 String controlAction,
 DynamicRouterControlConfiguration configuration)

Creates the instance.

Parameters:

uri - the URI that was used to cause the endpoint creation

component - the routing component to handle management of subscriber information from routing participants

controlAction - the control action of the endpoint

configuration - the component/endpoint configuration

Method Details

isRemote

public boolean isRemote()

doStart

protected void doStart()
                throws Exception

Starts the component, and creates the DynamicRouterControlService and adds it to the CamelContext.

Overrides:

doStart in class org.apache.camel.support.service.BaseService

Throws:

Exception

doStop

protected void doStop()
               throws Exception

Stops the component, and removes the DynamicRouterControlService from the CamelContext.

Overrides:

doStop in class org.apache.camel.support.service.BaseService

Throws:

Exception

getComponent

public DynamicRouterControlComponent getComponent()

Specified by:

getComponent in interface org.apache.camel.ComponentAware

Overrides:

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

createProducer

public org.apache.camel.Producer createProducer()

Creates the DynamicRouterControlProducer.

Returns:

the DynamicRouterControlProducer

See Also:

• for more information about the producer creation process

createConsumer

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

This is a producer-only component.

Parameters:

processor - not applicable to producer-only component

Returns:

not applicable to producer-only component

getControlAction

public String getControlAction()

Gets the control action for this endpoint. It will be either "subscribe" or "unsubscribe"

Returns:

the control action -- either "subscribe" or "unsubscribe"

getConfiguration

public DynamicRouterControlConfiguration getConfiguration()

Gets the DynamicRouterControlConfiguration.

Returns:

the DynamicRouterControlConfiguration