org.apache.camel.model
Class WireTapDefinition

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

All Implemented Interfaces:

ExecutorServiceAware, Block, ExecutorServiceAwareDefinition<ProcessorDefinition>

public class WireTapDefinition
extends SendDefinition<WireTapDefinition>
implements ExecutorServiceAwareDefinition<ProcessorDefinition>

Represents an XML <wireTap/> element

Version:

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

WireTapDefinition()

WireTapDefinition(Endpoint endpoint)

WireTapDefinition(String uri)

Method Summary

Processor	createProcessor(RouteContext routeContext) Override this in definition class and implement logic to create the processor based on the definition model.
ProcessorDefinition	executorService(ExecutorService executorService) Setting the executor service for executing
ProcessorDefinition	executorServiceRef(String executorServiceRef) Setting the executor service for executing
Boolean	getCopy()
ExecutorService	getExecutorService() Gets the executor service
String	getExecutorServiceRef() Gets the reference to lookup in the Registry for the executor service to be used.
ExpressionSubElementDefinition	getNewExchangeExpression()
Processor	getNewExchangeProcessor()
String	getNewExchangeProcessorRef()
ExchangePattern	getPattern()
String	getShortName() Returns a short name for this node which can be useful for ID generation or referring to related resources like images
boolean	isCopy()
void	setCopy(Boolean copy)
void	setExecutorService(ExecutorService executorService) Sets the executor service to be used.
void	setExecutorServiceRef(String executorServiceRef) Sets a reference to lookup in the Registry for the executor service to be used.
void	setNewExchangeExpression(Expression expression)
void	setNewExchangeExpression(ExpressionSubElementDefinition expression)
void	setNewExchangeProcessor(Processor processor)
void	setNewExchangeProcessorRef(String ref)
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.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, beanRef, beanRef, choice, clearOutput, configureChild, convertBodyTo, convertBodyTo, createChannel, createChildProcessor, createCompositeProcessor, createErrorHandlerBuilder, createOutputsProcessor, createOutputsProcessor, delay, delay, delay, doTry, dynamicRouter, dynamicRouter, end, endChoice, enrich, enrich, enrichRef, filter, filter, filter, filter, getErrorHandlerBuilder, getInterceptStrategies, getNodeFactory, getOtherAttributes, 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, onException, pipeline, pipeline, pipeline, pipeline, placeholder, policy, policy, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrichRef, process, processRef, recipientList, recipientList, recipientList, removeFaultHeader, removeHeader, removeHeaders, removeHeaders, removeProperty, resequence, resequence, resolveKnownConstantFields, resolvePropertyPlaceholders, rollback, rollback, routeId, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, sample, sample, sample, setBody, setBody, setErrorHandlerBuilder, setExchangePattern, setFaultBody, setFaultHeader, setHeader, setHeader, setInheritErrorHandler, setNodeFactory, setOtherAttributes, setOutHeader, setOutHeader, setParent, setProperty, setProperty, sort, sort, sort, split, split, split, stop, threads, threads, threads, throttle, throwException, to, to, to, to, to, to, to, to, to, to, 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, getDescriptionText, getId, hasCustomIdAssigned, idOrCreate, setDescription, setId

Methods inherited from class java.lang.Object

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

Constructor Detail

WireTapDefinition

public WireTapDefinition()

WireTapDefinition

public WireTapDefinition(String uri)

WireTapDefinition

public WireTapDefinition(Endpoint endpoint)

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

Throws:

Exception

getPattern

public ExchangePattern getPattern()

Overrides:

getPattern in class SendDefinition<WireTapDefinition>

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

executorService

public ProcessorDefinition executorService(ExecutorService executorService)

Description copied from interface: ExecutorServiceAwareDefinition

Setting the executor service for executing

Specified by:

executorService in interface ExecutorServiceAwareDefinition<ProcessorDefinition>

Parameters:

executorService - the executor service

Returns:

the builder

executorServiceRef

public ProcessorDefinition executorServiceRef(String executorServiceRef)

Description copied from interface: ExecutorServiceAwareDefinition

Setting the executor service for executing

Specified by:

executorServiceRef in interface ExecutorServiceAwareDefinition<ProcessorDefinition>

Parameters:

executorServiceRef - reference for a ExecutorService to lookup in the Registry

Returns:

the builder

getNewExchangeProcessor

public Processor getNewExchangeProcessor()

setNewExchangeProcessor

public void setNewExchangeProcessor(Processor processor)

getNewExchangeProcessorRef

public String getNewExchangeProcessorRef()

setNewExchangeProcessorRef

public void setNewExchangeProcessorRef(String ref)

getNewExchangeExpression

public ExpressionSubElementDefinition getNewExchangeExpression()

setNewExchangeExpression

public void setNewExchangeExpression(ExpressionSubElementDefinition expression)

setNewExchangeExpression

public void setNewExchangeExpression(Expression expression)

getExecutorService

public ExecutorService getExecutorService()

Description copied from interface: ExecutorServiceAware

Gets the executor service

Specified by:

getExecutorService in interface ExecutorServiceAware

Returns:

the executor

setExecutorService

public void setExecutorService(ExecutorService executorService)

Description copied from interface: ExecutorServiceAware

Sets the executor service to be used.

Specified by:

setExecutorService in interface ExecutorServiceAware

Parameters:

executorService - the executor

getExecutorServiceRef

public String getExecutorServiceRef()

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

public void setExecutorServiceRef(String executorServiceRef)

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

getCopy

public Boolean getCopy()

setCopy

public void setCopy(Boolean copy)

isCopy

public boolean isCopy()