org.apache.camel.component.direct

Class DirectEndpoint

java.lang.Object

org.apache.camel.support.service.BaseService

org.apache.camel.support.service.ServiceSupport

org.apache.camel.support.DefaultEndpoint

org.apache.camel.component.direct.DirectEndpoint

All Implemented Interfaces:

AutoCloseable, 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="1.0.0",
             scheme="direct",
             title="Direct",
             syntax="direct:name",
             category={CORE,ENDPOINT})
public class DirectEndpoint
extends org.apache.camel.support.DefaultEndpoint

Call another endpoint from the same Camel Context synchronously. This endpoint can be used to connect existing routes in the same CamelContext.

Field Summary

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

BUILDED, FAILED, INITIALIZED, INITIALIZING, lock, NEW, SHUTDOWN, SHUTTINGDOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

Constructor Summary

Constructors

Constructor and Description
DirectEndpoint()
DirectEndpoint(String endpointUri, org.apache.camel.Component component)
DirectEndpoint(String uri, org.apache.camel.Component component, Map<String,DirectConsumer> consumers)

Method Summary

Modifier and Type	Method and Description
void	addConsumer(DirectConsumer consumer)
org.apache.camel.Consumer	createConsumer(org.apache.camel.Processor processor)
org.apache.camel.Producer	createProducer()
protected DirectConsumer	getConsumer()
protected String	getKey()
long	getTimeout()
boolean	isBlock()
boolean	isFailIfNoConsumers()
void	removeConsumer(DirectConsumer consumer)
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 endpoint with no active consumers.
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, getComponent, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isBasicPropertyBinding, isBridgeErrorHandler, isLazyStartProducer, isLenientProperties, isPollingConsumerBlockWhenFull, isSingleton, isSynchronous, setBasicPropertyBinding, 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

getEndpointBaseUri, isSingletonProducer

Methods inherited from interface org.apache.camel.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

DirectEndpoint

public DirectEndpoint()

DirectEndpoint

public DirectEndpoint(String endpointUri,
                      org.apache.camel.Component component)

DirectEndpoint

public DirectEndpoint(String uri,
                      org.apache.camel.Component component,
                      Map<String,DirectConsumer> consumers)

Method Detail

createProducer

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

Throws:

Exception

createConsumer

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

Throws:

Exception

addConsumer

public void addConsumer(DirectConsumer consumer)

removeConsumer

public void removeConsumer(DirectConsumer consumer)

getConsumer

protected DirectConsumer getConsumer()
                              throws InterruptedException

Throws:

InterruptedException

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.

Parameters:

timeout - the timeout value

isFailIfNoConsumers

public boolean isFailIfNoConsumers()

setFailIfNoConsumers

public void setFailIfNoConsumers(boolean failIfNoConsumers)

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

getKey

protected String getKey()