Package org.apache.camel.model

Class UnmarshalDefinition

java.lang.Object

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

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

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

org.apache.camel.model.UnmarshalDefinition

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.LineNumberAware, Block, DataFormatDefinitionAware, org.apache.camel.NamedNode, org.apache.camel.spi.HasId, org.apache.camel.spi.IdAware

@Metadata(label="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

inheritErrorHandler

Constructor Summary

Constructors

Constructor	Description
UnmarshalDefinition()
UnmarshalDefinition(DataFormatDefinition dataFormatType)

Method Summary

Modifier and Type	Method	Description
UnmarshalDefinition	allowNullBody(boolean allowNullBody)	Indicates whether null is allowed as value of a body to unmarshall.
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()
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
String	toString()

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, delay, delay, delay, 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, getIndex, getInterceptStrategies, getParent, getRouteConfiguration, id, idempotentConsumer, idempotentConsumer, idempotentConsumer, inheritErrorHandler, inOnly, inOnly, inOnly, inOnly, inOnly, inOut, inOut, inOut, inOut, inOut, isAbstract, isInheritErrorHandler, isTopLevelOnly, isWrappingEntireOutput, kamelet, 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, pausable, pausable, pausable, pausable, pipeline, 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, resequence, resequence, resumable, resumable, resumable, rollback, rollback, routeDescription, routeGroup, routeId, routingSlip, routingSlip, routingSlip, saga, sample, sample, sample, sample, sample, script, script, serviceCall, serviceCall, serviceCall, setBody, setBody, setBody, setExchangePattern, setExchangePattern, setHeader, setHeader, setHeader, setInheritErrorHandler, setParent, setProperty, setProperty, setProperty, setRouteConfiguration, 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, to, to, toD, toD, toD, toD, toD, toD, toD, toF, transacted, transacted, transform, transform, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, validate, validate, validate, wireTap, wireTap, wireTap

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

description, description, getCamelContext, getCustomId, getDescription, getDescriptionText, getId, getLineNumber, getLocation, 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

Constructor Detail

UnmarshalDefinition

public UnmarshalDefinition()

UnmarshalDefinition

public UnmarshalDefinition(DataFormatDefinition dataFormatType)

Method Detail

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

getAllowNullBody

public String getAllowNullBody()

setAllowNullBody

public void setAllowNullBody(String allowNullBody)

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

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