org.apache.camel.impl.cluster

Class AbstractCamelClusterService<T extends CamelClusterView>

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.cluster.AbstractCamelClusterService<T>

All Implemented Interfaces:

CamelContextAware, CamelClusterService, Ordered, Service, ShutdownableService, HasId, IdAware, StatefulService, SuspendableService

Direct Known Subclasses:

FileLockClusterService

public abstract class AbstractCamelClusterService<T extends CamelClusterView>
extends ServiceSupport
implements CamelClusterService

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.camel.cluster.CamelClusterService

CamelClusterService.Selector

Field Summary

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

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

Fields inherited from interface org.apache.camel.Ordered

HIGHEST, LOWEST

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCamelClusterService()
protected	AbstractCamelClusterService(String id)
protected	AbstractCamelClusterService(String id, CamelContext camelContext)

Method Summary

Modifier and Type	Method and Description
protected abstract T	createView(String namespace)
protected void	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
Map<String,Object>	getAttributes() Attributes associated to the service.
CamelContext	getCamelContext() Get the CamelContext
String	getId() Returns the id
Collection<String>	getNamespaces() Return the namespaces handled by this service.
int	getOrder() Gets the order.
CamelClusterView	getView(String namespace) Get a view of the cluster bound to a namespace creating it if needed.
boolean	isLeader(String namespace) Check if the service is the leader on the given namespace.
void	releaseView(CamelClusterView view) Release a view if it has no references.
void	setAttribute(String key, Object value)
void	setAttributes(Map<String,Object> attributes)
void	setCamelContext(CamelContext camelContext) Injects the CamelContext
void	setId(String id) Sets the id
void	setOrder(int order)
void	startView(String namespace) Force start of the view associated to the give namespace.
void	stopView(String namespace) Force stop of the view associated to the give namespace.

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

Methods inherited from interface org.apache.camel.cluster.CamelClusterService

unwrap

Methods inherited from interface org.apache.camel.Service

start, stop

Constructor Detail

AbstractCamelClusterService

protected AbstractCamelClusterService()

AbstractCamelClusterService

protected AbstractCamelClusterService(String id)

AbstractCamelClusterService

protected AbstractCamelClusterService(String id,
                                      CamelContext camelContext)

Method Detail

getOrder

public int getOrder()

Description copied from interface: Ordered

Gets the order.

Use low numbers for higher priority. Normally the sorting will start from 0 and move upwards. So if you want to be last then use Integer.MAX_VALUE or eg Ordered.LOWEST.

Specified by:

getOrder in interface CamelClusterService

Specified by:

getOrder in interface Ordered

Returns:

the order

setOrder

public void setOrder(int order)

setId

public void setId(String id)

Description copied from interface: IdAware

Sets the id

Specified by:

setId in interface IdAware

Parameters:

id - the id

getId

public String getId()

Description copied from interface: HasId

Returns the id

Specified by:

getId in interface HasId

Returns:

the id

setCamelContext

public void setCamelContext(CamelContext camelContext)

Description copied from interface: CamelContextAware

Injects the CamelContext

Specified by:

setCamelContext in interface CamelContextAware

Parameters:

camelContext - the Camel context

getCamelContext

public CamelContext getCamelContext()

Description copied from interface: CamelContextAware

Get the CamelContext

Specified by:

getCamelContext in interface CamelContextAware

Returns:

camelContext the Camel context

setAttributes

public void setAttributes(Map<String,Object> attributes)

setAttribute

public void setAttribute(String key,
                         Object value)

getAttributes

public Map<String,Object> getAttributes()

Description copied from interface: CamelClusterService

Attributes associated to the service.

Specified by:

getAttributes in interface CamelClusterService

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.

Specified by:

doStart in class ServiceSupport

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.

Specified by:

doStop in class ServiceSupport

Throws:

Exception

See Also:

ServiceSupport.doStart()

getView

public CamelClusterView getView(String namespace)
                         throws Exception

Description copied from interface: CamelClusterService

Get a view of the cluster bound to a namespace creating it if needed. Multiple calls to this method with the same namespace should return the same instance. The instance is automatically started the first time it is instantiated and if the cluster service is ready.

Specified by:

getView in interface CamelClusterService

Parameters:

namespace - the namespace the view refer to.

Returns:

the view.

Throws:

Exception - if the view can't be created.

releaseView

public void releaseView(CamelClusterView view)
                 throws Exception

Description copied from interface: CamelClusterService

Release a view if it has no references.

Specified by:

releaseView in interface CamelClusterService

Parameters:

view - the view.

Throws:

Exception

getNamespaces

public Collection<String> getNamespaces()

Description copied from interface: CamelClusterService

Return the namespaces handled by this service.

Specified by:

getNamespaces in interface CamelClusterService

startView

public void startView(String namespace)
               throws Exception

Description copied from interface: CamelClusterService

Force start of the view associated to the give namespace.

Specified by:

startView in interface CamelClusterService

Throws:

Exception

stopView

public void stopView(String namespace)
              throws Exception

Description copied from interface: CamelClusterService

Force stop of the view associated to the give namespace.

Specified by:

stopView in interface CamelClusterService

Throws:

Exception

isLeader

public boolean isLeader(String namespace)

Description copied from interface: CamelClusterService

Check if the service is the leader on the given namespace.

Specified by:

isLeader in interface CamelClusterService

Parameters:

namespace - the namespace.

Returns:

createView

protected abstract T createView(String namespace)
                         throws Exception

Throws:

Exception