Package org.apache.camel.model
Class InterceptSendToEndpointDefinition
java.lang.Object
org.apache.camel.model.OptionalIdentifiedDefinition<InterceptSendToEndpointDefinition>
org.apache.camel.model.ProcessorDefinition<InterceptSendToEndpointDefinition>
org.apache.camel.model.OutputDefinition<InterceptSendToEndpointDefinition>
org.apache.camel.model.InterceptSendToEndpointDefinition
- All Implemented Interfaces:
org.apache.camel.CamelContextAware
,org.apache.camel.LineNumberAware
,Block
,OutputNode
,org.apache.camel.NamedNode
,org.apache.camel.spi.HasCamelContext
,org.apache.camel.spi.HasId
,org.apache.camel.spi.IdAware
@Metadata(label="configuration")
public class InterceptSendToEndpointDefinition
extends OutputDefinition<InterceptSendToEndpointDefinition>
Intercepts messages being sent to an endpoint
-
Field Summary
Fields inherited from class org.apache.camel.model.OutputDefinition
outputs
Fields inherited from class org.apache.camel.model.ProcessorDefinition
disabled, inheritErrorHandler
-
Constructor Summary
ConstructorDescription -
Method Summary
Modifier and TypeMethodDescriptionvoid
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.After sending to the endpoint then send the message to this url which allows to process its result.getLabel()
Returns a label to describe this node such as the expression if some kind of expression nodegetUri()
boolean
Whether this model is abstract or not.boolean
Whether this definition can only be added as top-level directly on the route itself (such as onException,onCompletion,intercept, etc.)void
setAfterUri
(String afterProcessor) After sending to the endpoint then send the message to this uri which allows to process its result.void
setOutputs
(List<ProcessorDefinition<?>> outputs) void
setSkipSendToOriginalEndpoint
(String skipSendToOriginalEndpoint) If set to true then the message is not sent to the original endpoint.void
Intercept sending to the uri or uri pattern.Skip sending theExchange
to the original intended endpointtoString()
when
(org.apache.camel.Predicate predicate) Applies this interceptor only if the given predicate is trueMethods inherited from class org.apache.camel.model.ProcessorDefinition
addInterceptStrategy, addOutput, aggregate, aggregate, aggregate, aggregate, bean, bean, bean, bean, bean, bean, bean, bean, bean, bean, bean, choice, circuitBreaker, claimCheck, claimCheck, claimCheck, claimCheck, clearOutput, configureChild, convertBodyTo, convertBodyTo, convertBodyTo, convertHeaderTo, convertHeaderTo, convertHeaderTo, convertHeaderTo, convertVariableTo, convertVariableTo, convertVariableTo, convertVariableTo, delay, delay, delay, disabled, disabled, disabled, doTry, dynamicRouter, dynamicRouter, end, endChoice, endCircuitBreaker, endDoCatch, endDoTry, endParent, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrichWith, enrichWith, enrichWith, enrichWith, enrichWith, enrichWith, filter, filter, filter, filter, getDisabled, getIndex, getInterceptStrategies, getParent, getRouteConfiguration, id, idempotentConsumer, idempotentConsumer, idempotentConsumer, inheritErrorHandler, isInheritErrorHandler, isWrappingEntireOutput, kamelet, loadBalance, loadBalance, log, log, log, log, log, log, loop, loop, loop, loopDoWhile, loopDoWhile, markRollbackOnly, markRollbackOnlyLast, marshal, marshal, marshal, marshal, multicast, multicast, multicast, nodePrefixId, onCompletion, onException, onException, onException, onException, pausable, pausable, pausable, pausable, pipeline, pipeline, pipeline, policy, policy, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrichWith, pollEnrichWith, pollEnrichWith, pollEnrichWith, pollEnrichWith, pollEnrichWith, preCreateProcessor, process, process, process, recipientList, recipientList, recipientList, recipientList, removeHeader, removeHeaders, removeHeaders, removeProperties, removeProperties, removeProperty, removeVariable, resequence, resequence, resumable, resumable, resumable, rollback, rollback, routeDescription, routeGroup, routeId, routingSlip, routingSlip, routingSlip, saga, sample, sample, sample, sample, script, script, serviceCall, serviceCall, serviceCall, setBody, setBody, setBody, setDisabled, setExchangePattern, setExchangePattern, setHeader, setHeader, setHeader, setHeaders, setInheritErrorHandler, setParent, setProperty, setProperty, setProperty, setRouteConfiguration, setVariable, setVariable, setVariable, sort, sort, sort, split, split, split, split, startupOrder, step, step, stop, threads, threads, threads, threads, throttle, throttle, throttle, throttle, throttle, throwException, throwException, to, to, to, to, to, to, to, to, to, to, to, to, toD, toD, toD, toD, toD, toD, toD, toD, toD, toF, toV, transacted, transacted, transform, transform, transform, transform, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, validate, validate, validate, wireTap, wireTap, wireTap, wireTap, wireTap
Methods inherited from class org.apache.camel.model.OptionalIdentifiedDefinition
description, getCamelContext, getCustomId, getDescription, getDescriptionText, getId, getLineNumber, getLocation, getNodePrefixId, hasCustomIdAssigned, idOrCreate, setCamelContext, setCustomId, setDescription, setGeneratedId, setId, setLineNumber, setLocation
-
Constructor Details
-
InterceptSendToEndpointDefinition
public InterceptSendToEndpointDefinition() -
InterceptSendToEndpointDefinition
-
-
Method Details
-
getOutputs
- Overrides:
getOutputs
in classOutputDefinition<InterceptSendToEndpointDefinition>
-
setOutputs
- Overrides:
setOutputs
in classOutputDefinition<InterceptSendToEndpointDefinition>
-
toString
- Overrides:
toString
in classOutputDefinition<InterceptSendToEndpointDefinition>
-
getShortName
- Specified by:
getShortName
in interfaceorg.apache.camel.NamedNode
- Overrides:
getShortName
in classOutputDefinition<InterceptSendToEndpointDefinition>
-
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 interfaceorg.apache.camel.NamedNode
- Overrides:
getLabel
in classProcessorDefinition<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 classProcessorDefinition<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 theProcessorDefinition.addOutput(ProcessorDefinition)
method.- Overrides:
isTopLevelOnly
in classProcessorDefinition<InterceptSendToEndpointDefinition>
-
when
Applies this interceptor only if the given predicate is true- Parameters:
predicate
- the predicate- Returns:
- the builder
-
skipSendToOriginalEndpoint
Skip sending theExchange
to the original intended endpoint- Returns:
- the builder
-
afterUri
After sending to the endpoint then send the message to this url which allows to process its result.- 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
-
setSkipSendToOriginalEndpoint
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
-
setUri
Intercept sending to the uri or uri pattern. -
getAfterUri
-
setAfterUri
After sending to the endpoint then send the message to this uri which allows to process its result.
-