org.apache.camel.component.seda

Class SedaComponent

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultComponent

org.apache.camel.impl.UriEndpointComponent

org.apache.camel.component.seda.SedaComponent

All Implemented Interfaces:

CamelContextAware, Component, Service, ShutdownableService, StatefulService, SuspendableService

Direct Known Subclasses:

VmComponent

public class SedaComponent
extends UriEndpointComponent

The SEDA Component is for asynchronous SEDA exchanges on a BlockingQueue within a CamelContext

Version:

Field Summary

Fields

Modifier and Type	Field and Description
protected int	concurrentConsumers
protected BlockingQueueFactory<Exchange>	defaultQueueFactory
protected org.slf4j.Logger	log
protected int	maxConcurrentConsumers
protected int	queueSize

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

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

Constructor Summary

Constructors

Constructor and Description
SedaComponent()
SedaComponent(Class<? extends Endpoint> endpointClass)

Method Summary

Modifier and Type	Method and Description
protected SedaEndpoint	createEndpoint(String endpointUri, Component component, BlockingQueue<Exchange> queue, int concurrentConsumers)
protected SedaEndpoint	createEndpoint(String endpointUri, Component component, BlockingQueueFactory<Exchange> queueFactory, int concurrentConsumers)
protected Endpoint	createEndpoint(String uri, String remaining, Map<String,Object> parameters) A factory method allowing derived components to create a new endpoint from the given URI, remaining path and optional parameters
protected void	doStop() Implementations override this method to support customized start/stop.
int	getConcurrentConsumers()
BlockingQueueFactory<Exchange>	getDefaultQueueFactory()
QueueReference	getOrCreateQueue(SedaEndpoint endpoint, Integer size) Deprecated. use
QueueReference	getOrCreateQueue(SedaEndpoint endpoint, Integer size, Boolean multipleConsumers) Deprecated. use getOrCreateQueue(SedaEndpoint, Integer, Boolean, BlockingQueueFactory)
QueueReference	getOrCreateQueue(SedaEndpoint endpoint, Integer size, Boolean multipleConsumers, BlockingQueueFactory<Exchange> customQueueFactory)
String	getQueueKey(String uri)
QueueReference	getQueueReference(String key)
Map<String,QueueReference>	getQueues()
int	getQueueSize()
QueueReference	registerQueue(SedaEndpoint endpoint, BlockingQueue<Exchange> queue)
void	setConcurrentConsumers(int size) Sets the default number of concurrent threads processing exchanges.
void	setDefaultQueueFactory(BlockingQueueFactory<Exchange> defaultQueueFactory) Sets the default queue factory.
void	setQueueSize(int size) Sets the default maximum capacity of the SEDA queue (i.e., the number of messages it can hold).

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

createComponentConfiguration, createParameterConfigurationMap, getEndpointClass, getParameterConfigurationMap, populateParameterConfigurationMap, setEndpointClass

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

afterConfiguration, createConfiguration, createEndpoint, doStart, getAndRemoveOrResolveReferenceParameter, getAndRemoveOrResolveReferenceParameter, getAndRemoveParameter, getAndRemoveParameter, getCamelContext, getExtension, getSupportedExtensions, ifStartsWithReturnRemainder, isResolvePropertyPlaceholders, preProcessUri, registerExtension, registerExtension, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceParameter, resolveAndRemoveReferenceParameter, setCamelContext, setProperties, setProperties, setResolvePropertyPlaceholders, useIntrospectionOnEndpoint, useRawUri, validateParameters, validateURI

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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

protected final org.slf4j.Logger log

maxConcurrentConsumers

protected final int maxConcurrentConsumers

See Also:

Constant Field Values

concurrentConsumers

@Metadata(label="consumer",
          defaultValue="1")
protected int concurrentConsumers

queueSize

@Metadata(label="advanced")
protected int queueSize

defaultQueueFactory

@Metadata(label="advanced")
protected BlockingQueueFactory<Exchange> defaultQueueFactory

Constructor Detail

SedaComponent

public SedaComponent()

SedaComponent

public SedaComponent(Class<? extends Endpoint> endpointClass)

Method Detail

setQueueSize

public void setQueueSize(int size)

Sets the default maximum capacity of the SEDA queue (i.e., the number of messages it can hold).

getQueueSize

public int getQueueSize()

setConcurrentConsumers

public void setConcurrentConsumers(int size)

Sets the default number of concurrent threads processing exchanges.

getConcurrentConsumers

public int getConcurrentConsumers()

getDefaultQueueFactory

public BlockingQueueFactory<Exchange> getDefaultQueueFactory()

setDefaultQueueFactory

public void setDefaultQueueFactory(BlockingQueueFactory<Exchange> defaultQueueFactory)

Sets the default queue factory.

getOrCreateQueue

@Deprecated
public QueueReference getOrCreateQueue(SedaEndpoint endpoint,
                                                   Integer size)

Deprecated. use

getOrCreateQueue

@Deprecated
public QueueReference getOrCreateQueue(SedaEndpoint endpoint,
                                                   Integer size,
                                                   Boolean multipleConsumers)

Deprecated. use getOrCreateQueue(SedaEndpoint, Integer, Boolean, BlockingQueueFactory)

getOrCreateQueue

public QueueReference getOrCreateQueue(SedaEndpoint endpoint,
                                       Integer size,
                                       Boolean multipleConsumers,
                                       BlockingQueueFactory<Exchange> customQueueFactory)

registerQueue

public QueueReference registerQueue(SedaEndpoint endpoint,
                                    BlockingQueue<Exchange> queue)

getQueues

public Map<String,QueueReference> getQueues()

getQueueReference

public QueueReference getQueueReference(String key)

createEndpoint

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

Description copied from class: DefaultComponent

A factory method allowing derived components to create a new endpoint from the given URI, remaining path and optional parameters

Specified by:

createEndpoint in class DefaultComponent

Parameters:

uri - the full URI of the endpoint

remaining - the remaining part of the URI without the query parameters or component prefix

parameters - the optional parameters passed in

Returns:

a newly created endpoint or null if the endpoint cannot be created based on the inputs

Throws:

Exception - is thrown if error creating the endpoint

createEndpoint

protected SedaEndpoint createEndpoint(String endpointUri,
                                      Component component,
                                      BlockingQueueFactory<Exchange> queueFactory,
                                      int concurrentConsumers)

createEndpoint

protected SedaEndpoint createEndpoint(String endpointUri,
                                      Component component,
                                      BlockingQueue<Exchange> queue,
                                      int concurrentConsumers)

getQueueKey

public String getQueueKey(String uri)

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 DefaultComponent

Throws:

Exception

See Also:

ServiceSupport.doStart()