Package org.apache.camel.model

Class MarshalDefinition

java.lang.Object

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

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

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

org.apache.camel.model.MarshalDefinition

All Implemented Interfaces:

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

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

Marshals data into a specified format for transmission over a transport or component

Field Summary

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

disabled, inheritErrorHandler

Constructor Summary

Constructors

Constructor	Description
MarshalDefinition()
MarshalDefinition(DataFormatDefinition dataFormatType)

Method Summary

Modifier and Type	Method	Description
protected String	description()
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	setDataFormatType(DataFormatDefinition dataFormatType)	The data format to be used
void	setVariableReceive(String variableReceive)
void	setVariableSend(String variableSend)
String	toString()
MarshalDefinition	variableReceive(String variableReceive)	To use a variable to store the received message body (only body, not headers).
MarshalDefinition	variableSend(String variableSend)	To use a variable to store the received message body (only body, not headers).

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

Methods inherited from class java.lang.Object

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

Constructor Details

MarshalDefinition

public MarshalDefinition()

MarshalDefinition

public MarshalDefinition(DataFormatDefinition dataFormatType)

Method Details

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

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)

variableReceive

public MarshalDefinition variableReceive(String variableReceive)

To use a variable to store the received message body (only body, not headers). This is handy for easy access to the received message body via variables. Important: When using receive variable then the received body is stored only in this variable and not on the current Message.

variableSend

public MarshalDefinition variableSend(String variableSend)

To use a variable to store the received message body (only body, not headers). This is handy for easy access to the received message body via variables. Important: When using receive variable then the received body is stored only in this variable and not on the current Message.