org.apache.camel.component.directvm

Class DirectVmEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.component.directvm.DirectVmEndpoint

All Implemented Interfaces:

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

@UriEndpoint(firstVersion="2.10.0",
             scheme="direct-vm",
             title="Direct VM",
             syntax="direct-vm:name",
             consumerClass=DirectConsumer.class,
             label="core,endpoint")
public class DirectVmEndpoint
extends DefaultEndpoint
implements AsyncEndpoint

The direct-vm component provides direct, synchronous call to another endpoint from any CamelContext in the same JVM. This endpoint can be used to connect existing routes in the same JVM between different CamelContexts.

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
DirectVmEndpoint(String endpointUri, DirectVmComponent 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
DirectVmComponent	getComponent() Returns the component that created this endpoint.
DirectVmConsumer	getConsumer()
HeaderFilterStrategy	getHeaderFilterStrategy()
long	getTimeout()
boolean	isBlock()
boolean	isFailIfNoConsumers()
boolean	isPropagateProperties()
boolean	isSingleton() Whether this class supports being singleton or not.
void	setBlock(boolean block) If sending a message to a direct endpoint which has no active consumer, then we can tell the producer to block and wait for the consumer to become active.
void	setFailIfNoConsumers(boolean failIfNoConsumers) Whether the producer should fail by throwing an exception, when sending to a Direct-VM endpoint with no active consumers.
void	setHeaderFilterStrategy(HeaderFilterStrategy headerFilterStrategy) Sets a HeaderFilterStrategy that will only be applied on producer endpoints (on both directions: request and response).
void	setPropagateProperties(boolean propagateProperties) Whether to propagate or not properties from the producer side to the consumer side, and vice versa.
void	setTimeout(long timeout) The timeout value to use if block is enabled.

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.Endpoint

configureProperties, createExchange, createExchange, createExchange, createPollingConsumer, getCamelContext, getEndpointConfiguration, getEndpointKey, getEndpointUri, isLenientProperties, setCamelContext

Methods inherited from interface org.apache.camel.Service

start, stop

Constructor Detail

DirectVmEndpoint

public DirectVmEndpoint(String endpointUri,
                        DirectVmComponent component)

Method Detail

getComponent

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

createProducer

public Producer createProducer()
                        throws Exception

Description copied from interface: Endpoint

Creates a new producer which is used send messages into the endpoint

Specified by:

createProducer in interface 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

Specified by:

createConsumer in interface Endpoint

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.

Specified by:

isSingleton in interface IsSingleton

Returns:

true to be a single shared instance, false to create new instances.

getConsumer

public DirectVmConsumer getConsumer()

isBlock

public boolean isBlock()

setBlock

public void setBlock(boolean block)

If sending a message to a direct endpoint which has no active consumer, then we can tell the producer to block and wait for the consumer to become active.

getTimeout

public long getTimeout()

setTimeout

public void setTimeout(long timeout)

The timeout value to use if block is enabled.

isFailIfNoConsumers

public boolean isFailIfNoConsumers()

setFailIfNoConsumers

public void setFailIfNoConsumers(boolean failIfNoConsumers)

Whether the producer should fail by throwing an exception, when sending to a Direct-VM endpoint with no active consumers.

getHeaderFilterStrategy

public HeaderFilterStrategy getHeaderFilterStrategy()

setHeaderFilterStrategy

public void setHeaderFilterStrategy(HeaderFilterStrategy headerFilterStrategy)

Sets a HeaderFilterStrategy that will only be applied on producer endpoints (on both directions: request and response).

Default value: none.

isPropagateProperties

public boolean isPropagateProperties()

setPropagateProperties

public void setPropagateProperties(boolean propagateProperties)

Whether to propagate or not properties from the producer side to the consumer side, and vice versa.

Default value: true.