org.apache.camel.component.controlbus

Class ControlBusEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.component.controlbus.ControlBusEndpoint

All Implemented Interfaces:

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

@UriEndpoint(firstVersion="2.11.0",
             scheme="controlbus",
             title="Control Bus",
             syntax="controlbus:command:language",
             producerOnly=true,
             label="core,monitoring")
public class ControlBusEndpoint
extends DefaultEndpoint

The controlbus component provides easy management of Camel applications based on the Control Bus EIP pattern. For example, by sending a message to an Endpoint you can control the lifecycle of routes, or gather performance statistics.

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
ControlBusEndpoint(String endpointUri, Component component)

Method Summary

Modifier and Type	Method and Description
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
String	getAction()
ControlBusComponent	getComponent() Returns the component that created this endpoint.
Language	getLanguage()
LoggingLevel	getLoggingLevel()
int	getRestartDelay()
String	getRouteId()
boolean	isAsync()
boolean	isSingleton() Whether this class supports being singleton or not.
void	setAction(String action) To denote an action that can be either: start, stop, or status.
void	setAsync(boolean async) Whether to execute the control bus task asynchronously.
void	setLanguage(Language language) Allows you to specify the name of a Language to use for evaluating the message body.
void	setLoggingLevel(LoggingLevel loggingLevel) Logging level used for logging when task is done, or if any exceptions occurred during processing the task.
void	setRestartDelay(int restartDelay) The delay in millis to use when restarting a route.
void	setRouteId(String routeId) To specify a route by its id.

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

ControlBusEndpoint

public ControlBusEndpoint(String endpointUri,
                          Component component)

Method Detail

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

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

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.

getComponent

public ControlBusComponent 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

getLanguage

public Language getLanguage()

setLanguage

public void setLanguage(Language language)

Allows you to specify the name of a Language to use for evaluating the message body. If there is any result from the evaluation, then the result is put in the message body.

getRouteId

public String getRouteId()

setRouteId

public void setRouteId(String routeId)

To specify a route by its id. The special keyword "current" indicates the current route.

getAction

public String getAction()

setAction

public void setAction(String action)

To denote an action that can be either: start, stop, or status.

To either start or stop a route, or to get the status of the route as output in the message body. You can use suspend and resume from Camel 2.11.1 onwards to either suspend or resume a route. And from Camel 2.11.1 onwards you can use stats to get performance statics returned in XML format; the routeId option can be used to define which route to get the performance stats for, if routeId is not defined, then you get statistics for the entire CamelContext. The restart action will restart the route.

getRestartDelay

public int getRestartDelay()

setRestartDelay

public void setRestartDelay(int restartDelay)

The delay in millis to use when restarting a route.

isAsync

public boolean isAsync()

setAsync

public void setAsync(boolean async)

Whether to execute the control bus task asynchronously.

Important: If this option is enabled, then any result from the task is not set on the Exchange. This is only possible if executing tasks synchronously.

getLoggingLevel

public LoggingLevel getLoggingLevel()

setLoggingLevel

public void setLoggingLevel(LoggingLevel loggingLevel)

Logging level used for logging when task is done, or if any exceptions occurred during processing the task.