org.apache.camel.model

Class InterceptSendToEndpointDefinition

java.lang.Object

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

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

org.apache.camel.model.OutputDefinition<InterceptSendToEndpointDefinition>

org.apache.camel.model.InterceptSendToEndpointDefinition

All Implemented Interfaces:

Block, OtherAttributesAware, NamedNode

@Metadata(label="configuration")
public class InterceptSendToEndpointDefinition
extends OutputDefinition<InterceptSendToEndpointDefinition>

Intercepts messages being sent to an endpoint

Version:

Field Summary

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

outputs

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

inheritErrorHandler, log

Constructor Summary

Constructors

Constructor and Description
InterceptSendToEndpointDefinition()
InterceptSendToEndpointDefinition(String uri)

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet() This method is only for handling some post configuration that is needed since this is an interceptor, and we have to do a bit of magic logic to fixup to handle predicates with or without proceed/stop set as well.
Processor	createProcessor(RouteContext routeContext) Override this in definition class and implement logic to create the processor based on the definition model.
String	getLabel() Returns a label to describe this node such as the expression if some kind of expression node
Boolean	getSkipSendToOriginalEndpoint()
String	getUri()
boolean	isAbstract() Whether this model is abstract or not.
boolean	isTopLevelOnly() Whether this definition can only be added as top-level directly on the route itself (such as onException,onCompletion,intercept, etc.) If trying to add a top-level only definition to a nested output would fail in the ProcessorDefinition.addOutput(ProcessorDefinition) method.
protected boolean	matchPattern(CamelContext camelContext, String uri, String pattern) Does the uri match the pattern.
void	setSkipSendToOriginalEndpoint(Boolean skipSendToOriginalEndpoint) If set to true then the message is not sent to the original endpoint.
void	setUri(String uri) Intercept sending to the uri or uri pattern.
InterceptSendToEndpointDefinition	skipSendToOriginalEndpoint() Skip sending the Exchange to the original intended endpoint
String	toString()
InterceptSendToEndpointDefinition	when(Predicate predicate) Applies this interceptor only if the given predicate is true

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

getOutputs, isOutputSupported, setOutputs

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, endHystrix, endParent, endRest, enrich, enrich, enrich, enrich, enrich, enrichRef, enrichRef, enrichRef, enrichWith, enrichWith, enrichWith, filter, filter, filter, filter, getIndex, getInterceptStrategies, getOtherAttributes, getParent, hystrix, id, idempotentConsumer, idempotentConsumer, idempotentConsumer, inheritErrorHandler, inOnly, inOnly, inOnly, inOnly, inOnly, inOnly, inOut, inOut, inOut, inOut, inOut, inOut, isInheritErrorHandler, loadBalance, loadBalance, log, log, log, log, log, log, loop, loop, loop, loopDoWhile, 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, pollEnrich, pollEnrich, pollEnrichRef, pollEnrichRef, pollEnrichWith, pollEnrichWith, pollEnrichWith, preCreateProcessor, process, 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, serviceCall, serviceCall, serviceCall, 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, wireTap, wrapChannel, 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, wait, wait, wait

Constructor Detail

InterceptSendToEndpointDefinition

public InterceptSendToEndpointDefinition()

InterceptSendToEndpointDefinition

public InterceptSendToEndpointDefinition(String uri)

Method Detail

toString

public String toString()

Overrides:

toString in class OutputDefinition<InterceptSendToEndpointDefinition>

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<InterceptSendToEndpointDefinition>

isAbstract

public boolean isAbstract()

Description copied from class: ProcessorDefinition

Whether this model is abstract or not.

An abstract model is something that is used for configuring cross cutting concerns such as error handling, transaction policies, interceptors etc.

Regular definitions is what is part of the route, such as ToDefinition, WireTapDefinition and the likes.

Will by default return false to indicate regular definition, so all the abstract definitions must override this method and return true instead.

This information is used in camel-spring to let Camel work a bit on the model provided by JAXB from the Spring XML file. This is needed to handle those cross cutting concerns properly. The Java DSL does not have this issue as it can work this out directly using the fluent builder methods.

Overrides:

isAbstract in class ProcessorDefinition<InterceptSendToEndpointDefinition>

Returns:

true for abstract, otherwise false for regular.

isTopLevelOnly

public boolean isTopLevelOnly()

Description copied from class: ProcessorDefinition

Whether this definition can only be added as top-level directly on the route itself (such as onException,onCompletion,intercept, etc.)

If trying to add a top-level only definition to a nested output would fail in the ProcessorDefinition.addOutput(ProcessorDefinition) method.

Overrides:

isTopLevelOnly in class ProcessorDefinition<InterceptSendToEndpointDefinition>

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<InterceptSendToEndpointDefinition>

Throws:

Exception

matchPattern

protected boolean matchPattern(CamelContext camelContext,
                               String uri,
                               String pattern)

Does the uri match the pattern.

Parameters:

camelContext - the CamelContext

uri - the uri

pattern - the pattern, which can be an endpoint uri as well

Returns:

true if matched and we should intercept, false if not matched, and not intercept.

when

public InterceptSendToEndpointDefinition when(Predicate predicate)

Applies this interceptor only if the given predicate is true

Parameters:

predicate - the predicate

Returns:

the builder

skipSendToOriginalEndpoint

public InterceptSendToEndpointDefinition skipSendToOriginalEndpoint()

Skip sending the Exchange to the original intended endpoint

Returns:

the builder

afterPropertiesSet

public void afterPropertiesSet()

This method is only for handling some post configuration that is needed since this is an interceptor, and we have to do a bit of magic logic to fixup to handle predicates with or without proceed/stop set as well.

getSkipSendToOriginalEndpoint

public Boolean getSkipSendToOriginalEndpoint()

setSkipSendToOriginalEndpoint

public void setSkipSendToOriginalEndpoint(Boolean skipSendToOriginalEndpoint)

If set to true then the message is not sent to the original endpoint. By default (false) the message is both intercepted and then sent to the original endpoint.

getUri

public String getUri()

setUri

public void setUri(String uri)

Intercept sending to the uri or uri pattern.