org.apache.camel.component.directvm

Class DirectVmEndpoint

java.lang.Object

org.apache.camel.support.service.BaseService

org.apache.camel.support.service.ServiceSupport

org.apache.camel.support.DefaultEndpoint

org.apache.camel.component.directvm.DirectVmEndpoint

All Implemented Interfaces:

AutoCloseable, org.apache.camel.AsyncEndpoint, org.apache.camel.CamelContextAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasId, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

@UriEndpoint(firstVersion="2.10.0",
             scheme="direct-vm",
             title="Direct VM",
             syntax="direct-vm:name",
             category={CORE,ENDPOINT})
public class DirectVmEndpoint
extends org.apache.camel.support.DefaultEndpoint
implements org.apache.camel.AsyncEndpoint

Call another endpoint from any Camel Context in the same JVM synchronously. 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.service.BaseService

BUILT, FAILED, INITIALIZED, INITIALIZING, lock, NEW, SHUTDOWN, SHUTTING_DOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

Constructor Summary

Constructors

Constructor and Description
DirectVmEndpoint(String endpointUri, DirectVmComponent component)

Method Summary

Modifier and Type	Method and Description
org.apache.camel.Consumer	createConsumer(org.apache.camel.Processor processor)
org.apache.camel.Producer	createProducer()
DirectVmComponent	getComponent()
DirectVmConsumer	getConsumer()
org.apache.camel.spi.HeaderFilterStrategy	getHeaderFilterStrategy()
long	getTimeout()
boolean	isBlock()
boolean	isFailIfNoConsumers()
boolean	isPropagateProperties()
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(org.apache.camel.spi.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.support.DefaultEndpoint

configureConsumer, configurePollingConsumer, configureProperties, createAsyncProducer, createEndpointUri, createExchange, createExchange, createPollingConsumer, doInit, doStart, doStop, equals, getCamelContext, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isAutowiredEnabled, isBridgeErrorHandler, isLazyStartProducer, isLenientProperties, isPollingConsumerBlockWhenFull, isSingleton, isSynchronous, setAutowiredEnabled, setBridgeErrorHandler, setCamelContext, setComponent, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setLazyStartProducer, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerQueueSize, setProperties, setSynchronous, toString

Methods inherited from class org.apache.camel.support.service.BaseService

build, doBuild, doFail, doLifecycleChange, doResume, doShutdown, doSuspend, fail, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, 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, createAsyncProducer, createExchange, createExchange, createPollingConsumer, getCamelContext, getEndpointBaseUri, getEndpointKey, getEndpointUri, isLenientProperties, isSingletonProducer, setCamelContext

Methods inherited from interface org.apache.camel.IsSingleton

isSingleton, test

Methods inherited from interface org.apache.camel.Service

build, close, init, start, stop

Methods inherited from interface org.apache.camel.CamelContextAware

trySetCamelContext

Methods inherited from interface org.apache.camel.StatefulService

getStatus, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspending

Methods inherited from interface org.apache.camel.SuspendableService

isSuspended, resume, suspend

Methods inherited from interface org.apache.camel.ShutdownableService

shutdown

Constructor Detail

DirectVmEndpoint

public DirectVmEndpoint(String endpointUri,
                        DirectVmComponent component)

Method Detail

getComponent

public DirectVmComponent getComponent()

Overrides:

getComponent in class org.apache.camel.support.DefaultEndpoint

createProducer

public org.apache.camel.Producer createProducer()
                                         throws Exception

Specified by:

createProducer in interface org.apache.camel.Endpoint

Throws:

Exception

createConsumer

public org.apache.camel.Consumer createConsumer(org.apache.camel.Processor processor)
                                         throws Exception

Specified by:

createConsumer in interface org.apache.camel.Endpoint

Throws:

Exception

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 org.apache.camel.spi.HeaderFilterStrategy getHeaderFilterStrategy()

setHeaderFilterStrategy

public void setHeaderFilterStrategy(org.apache.camel.spi.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.