org.apache.camel.component.context

Class ContextEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.component.context.ContextEndpoint

All Implemented Interfaces:

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

@UriEndpoint(scheme="context",
             title="Camel Context",
             syntax="context:contextId:localEndpointUrl",
             label="endpoint")
public class ContextEndpoint
extends DefaultEndpoint
implements DelegateEndpoint

The context component allows to send/receive messages between Camel routes in a black box way. The context component allows you to create new Camel Components from a CamelContext with a number of routes which is then treated as a black box, allowing you to refer to the local endpoints within the component from other CamelContexts. It is similar to the Routebox component in idea, though the Context component tries to be really simple for end users; just a simple convention over configuration approach to refer to local endpoints inside the CamelContext Component.

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
ContextEndpoint(String endpointUri, Component component, Endpoint delegate)

Method Summary

Modifier and Type	Method and Description
void	configureProperties(Map<String,Object> options) Configure properties on this endpoint.
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
String	getContextId()
Endpoint	getEndpoint() Gets the delegated Endpoint.
String	getLocalEndpointUrl()
boolean	isSingleton() Whether this class supports being singleton or not.
void	setCamelContext(CamelContext context) Sets the camel context.
void	setContextId(String contextId) Is the ID you used to register the CamelContext into the Registry.
void	setLocalEndpointUrl(String localEndpointUrl) Can be a valid Camel URI evaluated within the black box CamelContext.
void	start() Starts the service
void	stop() Stops the service

Methods inherited from class org.apache.camel.impl.DefaultEndpoint

configureConsumer, configurePollingConsumer, createEndpointConfiguration, createEndpointUri, createExchange, createExchange, createExchange, createPollingConsumer, doStart, doStop, equals, getCamelContext, getComponent, getConsumerProperties, getEndpointConfiguration, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isBridgeErrorHandler, isLenientProperties, isPollingConsumerBlockWhenFull, isSynchronous, setBridgeErrorHandler, 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, suspend

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.camel.Endpoint

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

Constructor Detail

ContextEndpoint

public ContextEndpoint(String endpointUri,
                       Component component,
                       Endpoint delegate)

Method Detail

getEndpoint

public Endpoint getEndpoint()

Description copied from interface: DelegateEndpoint

Gets the delegated Endpoint.

Specified by:

getEndpoint in interface DelegateEndpoint

Returns:

the Endpoint we delegate to

getContextId

public String getContextId()

setContextId

public void setContextId(String contextId)

Is the ID you used to register the CamelContext into the Registry.

getLocalEndpointUrl

public String getLocalEndpointUrl()

setLocalEndpointUrl

public void setLocalEndpointUrl(String localEndpointUrl)

Can be a valid Camel URI evaluated within the black box CamelContext. Or it can be a logical name which is mapped to any local endpoints. For example if you locally have endpoints like direct:invoices and seda:purchaseOrders inside a CamelContext of id supplyChain, then you can just use the URIs supplyChain:invoices or supplyChain:purchaseOrders to omit the physical endpoint kind and use pure logical URIs.

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.

start

public void start()
           throws Exception

Description copied from interface: Service

Starts the service

Specified by:

start in interface Service

Overrides:

start in class ServiceSupport

Throws:

Exception - is thrown if starting failed

stop

public void stop()
          throws Exception

Description copied from interface: Service

Stops the service

Specified by:

stop in interface Service

Overrides:

stop in class ServiceSupport

Throws:

Exception - is thrown if stopping failed

configureProperties

public void configureProperties(Map<String,Object> options)

Description copied from interface: Endpoint

Configure properties on this endpoint.

Specified by:

configureProperties in interface Endpoint

Overrides:

configureProperties in class DefaultEndpoint

Parameters:

options - the options (properties)

setCamelContext

public void setCamelContext(CamelContext context)

Description copied from interface: Endpoint

Sets the camel context.

Specified by:

setCamelContext in interface CamelContextAware

Specified by:

setCamelContext in interface Endpoint

Overrides:

setCamelContext in class DefaultEndpoint

Parameters:

context - the camel context