org.apache.camel.model

Class SendDefinition<Type extends ProcessorDefinition<Type>>

java.lang.Object

org.apache.camel.model.OptionalIdentifiedDefinition<Type>

org.apache.camel.model.ProcessorDefinition<Type>

org.apache.camel.model.NoOutputDefinition<Type>

org.apache.camel.model.SendDefinition<Type>

All Implemented Interfaces:

Block, EndpointRequiredDefinition, OtherAttributesAware, NamedNode

Direct Known Subclasses:

InOnlyDefinition, InOutDefinition, ToDefinition

public abstract class SendDefinition<Type extends ProcessorDefinition<Type>>
extends NoOutputDefinition<Type>
implements EndpointRequiredDefinition

Sends the message to an endpoint

Version:

Field Summary

Fields

Modifier and Type	Field and Description
protected Endpoint	endpoint
protected String	ref Deprecated.
protected String	uri

Fields inherited from class org.apache.camel.model.ProcessorDefinition

inheritErrorHandler, log

Constructor Summary

Constructors

Constructor and Description
SendDefinition()
SendDefinition(String uri)

Method Summary

Methods

Modifier and Type	Method and Description
Processor	createProcessor(RouteContext routeContext) Override this in definition class and implement logic to create the processor based on the definition model.
Endpoint	getEndpoint() Gets tne endpoint if an Endpoint instance was set.
String	getEndpointUri() Gets the uri of the endpoint used by this definition.
String	getLabel() Returns a label to describe this node such as the expression if some kind of expression node
ExchangePattern	getPattern()
String	getRef()
String	getUri()
String	getUriOrRef() Returns the endpoint URI or the name of the reference to it
Endpoint	resolveEndpoint(RouteContext context)
void	setEndpoint(Endpoint endpoint)
void	setRef(String ref) Deprecated. use uri with ref:uri instead
void	setUri(String uri) Sets the uri of the endpoint to send to.

Methods inherited from class org.apache.camel.model.NoOutputDefinition

getOutputs, isOutputSupported

Methods inherited from class org.apache.camel.model.ProcessorDefinition

addInterceptStrategies, addInterceptStrategy, addOutput, addRoutes, aggregate, aggregate, aggregate, aggregate, aop, attribute, bean, bean, bean, bean, bean, bean, bean, bean, beanRef, beanRef, beanRef, beanRef, beanRef, choice, clearOutput, configureChild, convertBodyTo, convertBodyTo, createChannel, createChildProcessor, createCompositeProcessor, createOutputsProcessor, createOutputsProcessor, createOutputsProcessorImpl, createProcessor, delay, delay, delay, doTry, dynamicRouter, dynamicRouter, end, endChoice, endDoTry, endParent, endRest, enrich, enrich, enrich, enrich, enrich, enrichRef, enrichRef, enrichRef, filter, filter, filter, filter, getIndex, getInterceptStrategies, getOtherAttributes, getParent, id, idempotentConsumer, idempotentConsumer, idempotentConsumer, inheritErrorHandler, inOnly, inOnly, inOnly, inOnly, inOnly, inOnly, inOut, inOut, inOut, inOut, inOut, inOut, isAbstract, isInheritErrorHandler, isTopLevelOnly, loadBalance, loadBalance, log, log, log, log, log, log, loop, loop, loop, makeProcessor, markRollbackOnly, markRollbackOnlyLast, marshal, marshal, marshal, marshal, multicast, multicast, multicast, onCompletion, onException, onException, pipeline, pipeline, pipeline, pipeline, placeholder, policy, policy, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrichRef, pollEnrichRef, preCreateProcessor, process, process, processRef, recipientList, recipientList, recipientList, recipientList, removeFaultHeader, removeHeader, removeHeaders, removeHeaders, removeProperties, removeProperties, removeProperty, resequence, resequence, rollback, rollback, routeDescription, routeId, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, sample, sample, sample, script, script, setBody, setBody, setExchangePattern, setFaultBody, setFaultHeader, setHeader, setHeader, setInheritErrorHandler, setOtherAttributes, setOutHeader, setOutHeader, setParent, setProperty, setProperty, sort, sort, sort, split, split, split, startupOrder, stop, threads, threads, threads, threads, throttle, throttle, throwException, throwException, to, to, to, to, to, to, to, to, to, to, toD, toD, toF, transacted, transacted, transform, transform, unmarshal, unmarshal, unmarshal, unmarshal, validate, validate, validate, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wrapChannel, wrapInErrorHandler, wrapProcessor

Methods inherited from class org.apache.camel.model.OptionalIdentifiedDefinition

description, description, getCustomId, getDescription, getDescriptionText, getId, getShortName, hasCustomIdAssigned, idOrCreate, setCustomId, setDescription, setId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

uri

@Metadata(required="true")
protected String uri

ref

@Deprecated
protected String ref

Deprecated.

endpoint

protected Endpoint endpoint

Constructor Detail

SendDefinition

public SendDefinition()

SendDefinition

public SendDefinition(String uri)

Method Detail

createProcessor

public Processor createProcessor(RouteContext routeContext)
                          throws Exception

Description copied from class: ProcessorDefinition

Override this in definition class and implement logic to create the processor based on the definition model.

Overrides:

createProcessor in class ProcessorDefinition<Type extends ProcessorDefinition<Type>>

Throws:

Exception

resolveEndpoint

public Endpoint resolveEndpoint(RouteContext context)

getEndpointUri

public String getEndpointUri()

Description copied from interface: EndpointRequiredDefinition

Gets the uri of the endpoint used by this definition.

Specified by:

getEndpointUri in interface EndpointRequiredDefinition

getRef

public String getRef()

setRef

@Deprecated
public void setRef(String ref)

Deprecated. use uri with ref:uri instead

Sets the reference of the endpoint to send to.

Parameters:

ref - the reference of the endpoint

getUri

public String getUri()

setUri

public void setUri(String uri)

Sets the uri of the endpoint to send to.

Parameters:

uri - the uri of the endpoint

getEndpoint

public Endpoint getEndpoint()

Gets tne endpoint if an Endpoint instance was set.

This implementation may return null which means you need to use getRef() or getUri() to get information about the endpoint.

Returns:

the endpoint instance, or null

setEndpoint

public void setEndpoint(Endpoint endpoint)

getPattern

public ExchangePattern getPattern()

getUriOrRef

public String getUriOrRef()

Returns the endpoint URI or the name of the reference to it

getLabel

public String getLabel()

Description copied from class: ProcessorDefinition

Returns a label to describe this node such as the expression if some kind of expression node

Specified by:

getLabel in interface NamedNode

Overrides:

getLabel in class ProcessorDefinition<Type extends ProcessorDefinition<Type>>