org.apache.camel.component.directvm

Class DirectVmComponent

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultComponent

org.apache.camel.impl.UriEndpointComponent

org.apache.camel.component.directvm.DirectVmComponent

All Implemented Interfaces:

CamelContextAware, Component, Service, ShutdownableService, StatefulService, SuspendableService

public class DirectVmComponent
extends UriEndpointComponent

Represents the component that manages DirectVmEndpoint. It holds the list of named direct-vm endpoints.

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
DirectVmComponent()

Method Summary

Methods

Modifier and Type	Method and Description
void	addConsumer(DirectVmEndpoint endpoint, DirectVmConsumer consumer)
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	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
DirectVmConsumer	getConsumer(DirectVmEndpoint endpoint)
static Collection<Endpoint>	getConsumerEndpoints() Gets all the consumer endpoints.
long	getTimeout()
boolean	isBlock()
void	removeConsumer(DirectVmEndpoint endpoint, DirectVmConsumer consumer)
void	setBlock(boolean block)
void	setTimeout(long timeout)

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, getAndRemoveOrResolveReferenceParameter, getAndRemoveOrResolveReferenceParameter, getAndRemoveParameter, getAndRemoveParameter, getCamelContext, ifStartsWithReturnRemainder, preProcessUri, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceParameter, resolveAndRemoveReferenceParameter, setCamelContext, setProperties, 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, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectVmComponent

public DirectVmComponent()

Method Detail

getConsumerEndpoints

public static Collection<Endpoint> getConsumerEndpoints()

Gets all the consumer endpoints.

Returns:

consumer endpoints

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

getConsumer

public DirectVmConsumer getConsumer(DirectVmEndpoint endpoint)

addConsumer

public void addConsumer(DirectVmEndpoint endpoint,
               DirectVmConsumer consumer)

removeConsumer

public void removeConsumer(DirectVmEndpoint endpoint,
                  DirectVmConsumer consumer)

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.

Overrides:

doStart in class DefaultComponent

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.

Overrides:

doStop in class DefaultComponent

Throws:

Exception

See Also:

ServiceSupport.doStart()

isBlock

public boolean isBlock()

setBlock

public void setBlock(boolean block)

getTimeout

public long getTimeout()

setTimeout

public void setTimeout(long timeout)