org.apache.camel.model
Class ToDefinition

java.lang.Object
  org.apache.camel.model.OptionalIdentifiedDefinition
      org.apache.camel.model.ProcessorDefinition<Type>
          org.apache.camel.model.SendDefinition<ToDefinition>
              org.apache.camel.model.ToDefinition

All Implemented Interfaces:

ExecutorServiceAware, Block, ExecutorServiceAwareDefinition<ToDefinition>

public class ToDefinition
extends SendDefinition<ToDefinition>
implements ExecutorServiceAwareDefinition<ToDefinition>

Represents an XML <to/> element

Version:

$Revision: 945532 $

Field Summary

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

endpoint, ref, uri

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

errorHandlerBuilder, errorHandlerRef, inheritErrorHandler, log

Constructor Summary

ToDefinition()

ToDefinition(Endpoint endpoint)

ToDefinition(Endpoint endpoint, ExchangePattern pattern)

ToDefinition(String uri)

ToDefinition(String uri, ExchangePattern pattern)

Method Summary

Processor	createProcessor(RouteContext routeContext) Override this in definition class and implement logic to create the processor based on the definition model.
ToDefinition	executorService(ExecutorService executorService) Deprecated.
ToDefinition	executorServiceRef(String executorServiceRef) Deprecated.
ExecutorService	getExecutorService() Deprecated.
String	getExecutorServiceRef() Deprecated.
List<ProcessorDefinition>	getOutputs()
ExchangePattern	getPattern()
Integer	getPoolSize() Deprecated.
String	getShortName() Returns a short name for this node which can be useful for ID generation or referring to related resources like images
Boolean	isAsync() Deprecated.
ToDefinition	pattern(ExchangePattern pattern) Sets the optional ExchangePattern used to invoke this endpoint
ToDefinition	poolSize(int poolSize) Deprecated.
void	setAsync(Boolean async) Deprecated.
void	setExecutorService(ExecutorService executorService) Deprecated.
void	setExecutorServiceRef(String executorServiceRef) Deprecated.
void	setPattern(ExchangePattern pattern) Sets the optional ExchangePattern used to invoke this endpoint
void	setPoolSize(Integer poolSize) Deprecated.
String	toString()

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

getEndpoint, getLabel, getRef, getUri, getUriOrRef, resolveEndpoint, setEndpoint, setRef, setUri

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

addInterceptStrategies, addInterceptStrategy, addOutput, addRoutes, aggregate, aggregate, aggregate, aggregate, aop, bean, bean, bean, bean, beanRef, beanRef, choice, clearOutput, configureChild, convertBodyTo, convertBodyTo, createChannel, createChildProcessor, createCompositeProcessor, createErrorHandlerBuilder, createOutputsProcessor, createOutputsProcessor, delay, delay, delay, doTry, end, enrich, enrich, enrichRef, filter, filter, filter, filter, getErrorHandlerBuilder, getInterceptStrategies, getNodeFactory, getParent, id, idempotentConsumer, idempotentConsumer, idempotentConsumer, inheritErrorHandler, inOnly, inOnly, inOnly, inOnly, inOnly, inOnly, inOut, inOut, inOut, inOut, inOut, inOut, isAbstract, isInheritErrorHandler, loadBalance, loadBalance, log, log, log, loop, loop, loop, makeProcessor, markRollbackOnly, markRollbackOnlyLast, marshal, marshal, marshal, marshal, multicast, multicast, multicast, onCompletion, onException, pipeline, pipeline, pipeline, pipeline, policy, policy, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrichRef, process, processRef, recipientList, recipientList, recipientList, removeFaultHeader, removeHeader, removeHeaders, removeProperty, resequence, resequence, resequence, resequence, rollback, rollback, routeId, routingSlip, routingSlip, routingSlip, routingSlip, sample, sample, setBody, setBody, setErrorHandlerBuilder, setExchangePattern, setFaultBody, setFaultHeader, setHeader, setHeader, setInheritErrorHandler, setNodeFactory, setOutHeader, setOutHeader, setParent, setProperty, setProperty, sort, sort, sortBody, sortBody, split, split, split, stop, threads, threads, threads, throttle, throwException, to, to, to, to, to, to, to, to, to, to, toAsync, toAsync, toAsync, toAsync, toF, transacted, transacted, transform, transform, unmarshal, unmarshal, unmarshal, unmarshal, validate, validate, validate, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wrapChannel, wrapInErrorHandler, wrapProcessor

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

description, getDescription, getId, hasCustomIdAssigned, idOrCreate, setDescription, setId

Methods inherited from class java.lang.Object

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

Constructor Detail

ToDefinition

public ToDefinition()

ToDefinition

public ToDefinition(String uri)

ToDefinition

public ToDefinition(Endpoint endpoint)

ToDefinition

public ToDefinition(String uri,
                    ExchangePattern pattern)

ToDefinition

public ToDefinition(Endpoint endpoint,
                    ExchangePattern pattern)

Method Detail

getOutputs

public List<ProcessorDefinition> getOutputs()

Overrides:

getOutputs in class SendDefinition<ToDefinition>

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 SendDefinition<ToDefinition>

Throws:

Exception

toString

public String toString()

Overrides:

toString in class Object

getShortName

public String getShortName()

Description copied from class: OptionalIdentifiedDefinition

Returns a short name for this node which can be useful for ID generation or referring to related resources like images

Overrides:

getShortName in class OptionalIdentifiedDefinition

Returns:

defaults to "node" but derived nodes should overload this to provide a unique name

getPattern

public ExchangePattern getPattern()

Overrides:

getPattern in class SendDefinition<ToDefinition>

isAsync

@Deprecated
public Boolean isAsync()

Deprecated.

setAsync

@Deprecated
public void setAsync(Boolean async)

Deprecated.

getPoolSize

@Deprecated
public Integer getPoolSize()

Deprecated.

setPoolSize

@Deprecated
public void setPoolSize(Integer poolSize)

Deprecated.

getExecutorService

@Deprecated
public ExecutorService getExecutorService()

Deprecated.

Description copied from interface: ExecutorServiceAware

Gets the executor service

Specified by:

getExecutorService in interface ExecutorServiceAware

Returns:

the executor

setExecutorService

@Deprecated
public void setExecutorService(ExecutorService executorService)

Deprecated.

Description copied from interface: ExecutorServiceAware

Sets the executor service to be used.

Specified by:

setExecutorService in interface ExecutorServiceAware

Parameters:

executorService - the executor

getExecutorServiceRef

@Deprecated
public String getExecutorServiceRef()

Deprecated.

Description copied from interface: ExecutorServiceAware

Gets the reference to lookup in the Registry for the executor service to be used.

Specified by:

getExecutorServiceRef in interface ExecutorServiceAware

Returns:

the reference, or null if the executor was set directly

setExecutorServiceRef

@Deprecated
public void setExecutorServiceRef(String executorServiceRef)

Deprecated.

Description copied from interface: ExecutorServiceAware

Sets a reference to lookup in the Registry for the executor service to be used.

Specified by:

setExecutorServiceRef in interface ExecutorServiceAware

Parameters:

executorServiceRef - reference for the executor

setPattern

public void setPattern(ExchangePattern pattern)

Sets the optional ExchangePattern used to invoke this endpoint

pattern

public ToDefinition pattern(ExchangePattern pattern)

Sets the optional ExchangePattern used to invoke this endpoint

executorService

@Deprecated
public ToDefinition executorService(ExecutorService executorService)

Deprecated.

Description copied from interface: ExecutorServiceAwareDefinition

Setting the executor service for executing

Specified by:

executorService in interface ExecutorServiceAwareDefinition<ToDefinition>

Parameters:

executorService - the executor service

Returns:

the builder

executorServiceRef

@Deprecated
public ToDefinition executorServiceRef(String executorServiceRef)

Deprecated.

Description copied from interface: ExecutorServiceAwareDefinition

Setting the executor service for executing

Specified by:

executorServiceRef in interface ExecutorServiceAwareDefinition<ToDefinition>

Parameters:

executorServiceRef - reference for a ExecutorService to lookup in the Registry

Returns:

the builder

poolSize

@Deprecated
public ToDefinition poolSize(int poolSize)

Deprecated.

Setting the core pool size for the underlying ExecutorService.

Returns:

the builder