org.apache.camel.component.binding

Class BindingEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.component.binding.BindingEndpoint

All Implemented Interfaces:

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

Deprecated.

use Contract instead

@Deprecated
 @Metadata(deprecationNode="Use org.apache.camel.spi.Contract instead")
 @UriEndpoint(firstVersion="2.11.0",
             scheme="binding",
             title="Binding",
             syntax="binding:bindingName:delegateUri",
             consumerClass=BindingConsumerProcessor.class,
             label="core,transformation")
public class BindingEndpoint
extends DefaultEndpoint
implements HasBinding

The binding component is used for as a of wrapping an Endpoint in a contract with a data format. In Camel terms a binding is a way of wrapping an Endpoint in a contract; such as a Data Format, a Content Enricher or validation step. Bindings are completely optional and you can choose to use them on any camel endpoint. Bindings are inspired by the work of SwitchYard project adding service contracts to various technologies like Camel and many others. But rather than the SwitchYard approach of wrapping Camel in SCA, Camel Bindings provide a way of wrapping Camel endpoints with contracts inside the Camel framework itself; so you can use them easily inside any Camel route. Applies a Binding to an underlying Endpoint so that the binding processes messages before its sent to the endpoint and processes messages received by the endpoint consumer before its passed to the real consumer.

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
BindingEndpoint(String uri, Component component, Binding binding, Endpoint delegate) Deprecated.
BindingEndpoint(String uri, Component component, String bindingName, String delegateUri) Deprecated.

Method Summary

Modifier and Type	Method and Description
Consumer	createConsumer(Processor processor) Deprecated. Creates a new Event Driven Consumer which consumes messages from the endpoint using the given processor
Producer	createProducer() Deprecated. Creates a new producer which is used send messages into the endpoint
protected void	doStart() Deprecated. Implementations override this method to support customized start/stop.
protected void	doStop() Deprecated. Implementations override this method to support customized start/stop.
Binding	getBinding() Deprecated. Returns the binding for this endpoint if one can be deduced or is associated
String	getBindingName() Deprecated. Name of the binding to lookup in the Camel registry.
Endpoint	getDelegate() Deprecated.
String	getDelegateUri() Deprecated. Uri of the delegate endpoint.
boolean	isSingleton() Deprecated. Whether this class supports being singleton or not.
void	pipelineBindingProcessor(Processor bindingProcessor, Exchange exchange, Processor delegateProcessor) Deprecated. Applies the Binding processor to the given exchange before passing it on to the delegateProcessor (either a producer or consumer)

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

configureConsumer, configurePollingConsumer, configureProperties, createEndpointConfiguration, createEndpointUri, createExchange, createExchange, createExchange, createPollingConsumer, equals, getCamelContext, getComponent, 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.Service

start, stop

Constructor Detail

BindingEndpoint

@Deprecated
public BindingEndpoint(String uri,
                                   Component component,
                                   Binding binding,
                                   Endpoint delegate)

Deprecated.

BindingEndpoint

public BindingEndpoint(String uri,
                       Component component,
                       String bindingName,
                       String delegateUri)

Deprecated.

Method Detail

createProducer

public Producer createProducer()
                        throws Exception

Deprecated.

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

Deprecated.

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

Deprecated.

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.

getBinding

public Binding getBinding()

Deprecated.

Description copied from interface: HasBinding

Returns the binding for this endpoint if one can be deduced or is associated

Specified by:

getBinding in interface HasBinding

getDelegate

public Endpoint getDelegate()

Deprecated.

getBindingName

public String getBindingName()

Deprecated.

Name of the binding to lookup in the Camel registry.

getDelegateUri

public String getDelegateUri()

Deprecated.

Uri of the delegate endpoint.

pipelineBindingProcessor

public void pipelineBindingProcessor(Processor bindingProcessor,
                                     Exchange exchange,
                                     Processor delegateProcessor)
                              throws Exception

Deprecated.

Applies the Binding processor to the given exchange before passing it on to the delegateProcessor (either a producer or consumer)

Throws:

Exception

doStart

protected void doStart()
                throws Exception

Deprecated.

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 DefaultEndpoint

Throws:

Exception

See Also:

ServiceSupport.doStop()

doStop

protected void doStop()
               throws Exception

Deprecated.

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 DefaultEndpoint

Throws:

Exception

See Also:

ServiceSupport.doStart()