org.apache.camel.model

Class TransactedDefinition

java.lang.Object

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

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

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

org.apache.camel.model.TransactedDefinition

All Implemented Interfaces:

Block, DefinitionPropertyPlaceholderConfigurer, OtherAttributesAware, OutputNode, org.apache.camel.NamedNode, org.apache.camel.spi.PropertyConfigurer, org.apache.camel.spi.PropertyPlaceholderConfigurer

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

Enables transaction on the route

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPAGATION_REQUIRED
protected String	ref
protected Class<? extends org.apache.camel.spi.Policy>	type

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
TransactedDefinition()
TransactedDefinition(org.apache.camel.spi.Policy policy)

Method Summary

Modifier and Type	Method and Description
protected String	description()
String	getLabel() Returns a label to describe this node such as the expression if some kind of expression node
org.apache.camel.spi.Policy	getPolicy()
String	getRef()
String	getShortName()
Class<? extends org.apache.camel.spi.Policy>	getType()
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.
boolean	isWrappingEntireOutput() Whether this definition is wrapping the entire output.
TransactedDefinition	ref(String ref) Sets a reference to use for lookup the policy in the registry.
void	setRef(String ref)
void	setType(Class<? extends org.apache.camel.spi.Policy> type) Sets a policy type that this definition should scope within.
String	toString()

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

getOutputs, setOutputs

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

addInterceptStrategy, addOutput, aggregate, aggregate, aggregate, aggregate, attribute, bean, bean, bean, bean, bean, bean, bean, bean, bean, choice, claimCheck, claimCheck, claimCheck, claimCheck, clearOutput, configureChild, convertBodyTo, convertBodyTo, delay, delay, delay, doTry, dynamicRouter, dynamicRouter, end, endChoice, endDoTry, endHystrix, endParent, endRest, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrichWith, enrichWith, enrichWith, enrichWith, enrichWith, enrichWith, filter, filter, filter, filter, getIndex, getInterceptStrategies, getOtherAttributes, getParent, hystrix, id, idempotentConsumer, idempotentConsumer, idempotentConsumer, inheritErrorHandler, inOnly, inOnly, inOnly, inOnly, inOnly, inOut, inOut, inOut, inOut, inOut, isInheritErrorHandler, loadBalance, loadBalance, log, log, log, log, log, log, loop, loop, loop, loopDoWhile, loopDoWhile, 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, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrichWith, pollEnrichWith, pollEnrichWith, pollEnrichWith, pollEnrichWith, pollEnrichWith, preCreateProcessor, process, process, process, process, recipientList, recipientList, recipientList, recipientList, removeHeader, removeHeaders, removeHeaders, removeProperties, removeProperties, removeProperty, resequence, resequence, rollback, rollback, routeDescription, routeGroup, routeId, routingSlip, routingSlip, routingSlip, saga, sample, sample, sample, script, script, serviceCall, serviceCall, serviceCall, setBody, setBody, setBody, setBody, setExchangePattern, setHeader, setHeader, setHeader, setInheritErrorHandler, setOtherAttributes, setParent, setProperty, setProperty, sort, sort, sort, 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, to, to, toD, toD, toD, toD, toD, toD, toF, transacted, transacted, transform, transform, unmarshal, unmarshal, unmarshal, unmarshal, validate, validate, validate, wireTap, wireTap, wireTap

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.camel.model.DefinitionPropertyPlaceholderConfigurer

getReadPropertyPlaceholderOptions, getWritePropertyPlaceholderOptions

Field Detail

PROPAGATION_REQUIRED

public static final String PROPAGATION_REQUIRED

See Also:

Constant Field Values

type

protected Class<? extends org.apache.camel.spi.Policy> type

ref

protected String ref

Constructor Detail

TransactedDefinition

public TransactedDefinition()

TransactedDefinition

public TransactedDefinition(org.apache.camel.spi.Policy policy)

Method Detail

toString

public String toString()

Overrides:

toString in class OutputDefinition<TransactedDefinition>

description

protected String description()

getShortName

public String getShortName()

Specified by:

getShortName in interface org.apache.camel.NamedNode

Overrides:

getShortName in class OutputDefinition<TransactedDefinition>

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 org.apache.camel.NamedNode

Overrides:

getLabel in class ProcessorDefinition<TransactedDefinition>

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

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

isWrappingEntireOutput

public boolean isWrappingEntireOutput()

Description copied from class: ProcessorDefinition

Whether this definition is wrapping the entire output.

When a definition is wrapping the entire output, the check to ensure that a route definition is empty should be done on the wrapped output.

Overrides:

isWrappingEntireOutput in class ProcessorDefinition<TransactedDefinition>

Returns:

true when wrapping the entire output.

getPolicy

public org.apache.camel.spi.Policy getPolicy()

getRef

public String getRef()

setRef

public void setRef(String ref)

getType

public Class<? extends org.apache.camel.spi.Policy> getType()

setType

public void setType(Class<? extends org.apache.camel.spi.Policy> type)

Sets a policy type that this definition should scope within.

Is used for convention over configuration situations where the policy should be automatic looked up in the registry and it should be based on this type. For instance a TransactedPolicy can be set as type for easy transaction configuration.

Will by default scope to the wide Policy

Parameters:

type - the policy type

ref

public TransactedDefinition ref(String ref)

Sets a reference to use for lookup the policy in the registry.

Parameters:

ref - the reference

Returns:

the builder