Package org.apache.camel.model

Class UnmarshalDefinition

java.lang.Object

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

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

org.apache.camel.model.NoOutputDefinition<UnmarshalDefinition>

org.apache.camel.model.UnmarshalDefinition

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.LineNumberAware, Block, CopyableDefinition<ProcessorDefinition>, DataFormatDefinitionAware, DisabledAwareDefinition, org.apache.camel.NamedNode, org.apache.camel.spi.HasCamelContext, org.apache.camel.spi.HasId, org.apache.camel.spi.IdAware

@Metadata(label="eip,dataformat,transformation")
public class UnmarshalDefinition
extends NoOutputDefinition<UnmarshalDefinition>
implements DataFormatDefinitionAware

Converts the message data received from the wire into a format that Apache Camel processors can consume

Field Summary

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

disabled

Constructor Summary

Constructors

Modifier	Constructor	Description
	UnmarshalDefinition()
	UnmarshalDefinition(DataFormatDefinition dataFormatType)
protected	UnmarshalDefinition(UnmarshalDefinition source)

Method Summary

Modifier and Type	Method	Description
UnmarshalDefinition	allowNullBody(boolean allowNullBody)	Indicates whether null is allowed as value of a body to unmarshall.
UnmarshalDefinition	copyDefinition()	Makes a copy of this definition.
protected String	description()
String	getAllowNullBody()
DataFormatDefinition	getDataFormatType()	The data format.
String	getLabel()	Returns a label to describe this node such as the expression if some kind of expression node
String	getShortName()
String	getVariableReceive()
String	getVariableSend()
void	setAllowNullBody(String allowNullBody)	Indicates whether null is allowed as value of a body to unmarshall.
void	setDataFormatType(DataFormatDefinition dataFormatType)	The data format to be used
void	setVariableReceive(String variableReceive)
void	setVariableSend(String variableSend)
String	toString()
UnmarshalDefinition	variableReceive(String variableReceive)	To use a variable to store the received message body (only body, not headers).
UnmarshalDefinition	variableSend(String variableSend)	To use a variable as the source for the message body to send.

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

getOutputs

Methods 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, description, 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, getInheritErrorHandler, getInterceptStrategies, getParent, getRouteConfiguration, id, idempotentConsumer, idempotentConsumer, idempotentConsumer, isAbstract, isTopLevelOnly, isWrappingEntireOutput, kamelet, loadBalance, loadBalance, log, log, 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, poll, poll, poll, poll, poll, poll, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrichWith, pollEnrichWith, pollEnrichWith, pollEnrichWith, pollEnrichWith, pollEnrichWith, pollV, 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, setVariables, 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, tokenize, 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

getCamelContext, getCustomId, getDescription, getDescriptionText, getId, getLineNumber, getLocation, getNodePrefixId, hasCustomIdAssigned, idOrCreate, setCamelContext, setCustomId, setDescription, setGeneratedId, setId, setLineNumber, setLocation

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.camel.NamedNode

acceptDebugger

Constructor Details

UnmarshalDefinition

public UnmarshalDefinition()

UnmarshalDefinition

protected UnmarshalDefinition(UnmarshalDefinition source)

UnmarshalDefinition

public UnmarshalDefinition(DataFormatDefinition dataFormatType)

Method Details

copyDefinition

public UnmarshalDefinition copyDefinition()

Description copied from interface: CopyableDefinition

Makes a copy of this definition.

Specified by:

copyDefinition in interface CopyableDefinition<ProcessorDefinition>

toString

public String toString()

Overrides:

toString in class Object

description

protected String description()

getShortName

public String getShortName()

Specified by:

getShortName in interface org.apache.camel.NamedNode

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

getDataFormatType

public DataFormatDefinition getDataFormatType()

Description copied from interface: DataFormatDefinitionAware

The data format.

Specified by:

getDataFormatType in interface DataFormatDefinitionAware

setDataFormatType

public void setDataFormatType(DataFormatDefinition dataFormatType)

The data format to be used

Specified by:

setDataFormatType in interface DataFormatDefinitionAware

getVariableSend

public String getVariableSend()

setVariableSend

public void setVariableSend(String variableSend)

getVariableReceive

public String getVariableReceive()

setVariableReceive

public void setVariableReceive(String variableReceive)

getAllowNullBody

public String getAllowNullBody()

setAllowNullBody

public void setAllowNullBody(String allowNullBody)

Indicates whether null is allowed as value of a body to unmarshall.

variableReceive

public UnmarshalDefinition variableReceive(String variableReceive)

To use a variable to store the received message body (only body, not headers). This makes it handy to use variables for user data and to easily control what data to use for sending and receiving. Important: When using receive variable then the received body is stored only in this variable and not on the current message.

variableSend

public UnmarshalDefinition variableSend(String variableSend)

To use a variable as the source for the message body to send. This makes it handy to use variables for user data and to easily control what data to use for sending and receiving. Important: When using send variable then the message body is taken from this variable instead of the current message, however the headers from the message will still be used as well. In other words, the variable is used instead of the message body, but everything else is as usual.

allowNullBody

public UnmarshalDefinition allowNullBody(boolean allowNullBody)

Indicates whether null is allowed as value of a body to unmarshall.

Parameters:

allowNullBody - true if null is allowed as value of a body to unmarshall, false otherwise

Returns:

the builder