Package org.apache.camel.model

Class ConvertHeaderDefinition

java.lang.Object

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

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

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

org.apache.camel.model.ConvertHeaderDefinition

All Implemented Interfaces:

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

@Metadata(label="eip,transformation")
public class ConvertHeaderDefinition
extends NoOutputDefinition<ConvertHeaderDefinition>

Converts the message header to another type

Field Summary

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

disabled, inheritErrorHandler

Constructor Summary

Constructors

Constructor	Description
ConvertHeaderDefinition()
ConvertHeaderDefinition(String name, Class<?> typeClass)
ConvertHeaderDefinition(String name, Class<?> typeClass, boolean mandatory)
ConvertHeaderDefinition(String name, Class<?> typeClass, String charset)
ConvertHeaderDefinition(String name, String type)
ConvertHeaderDefinition(String name, String toName, Class<?> typeClass)

Method Summary

Modifier and Type	Method	Description
String	getCharset()
String	getLabel()	Returns a label to describe this node such as the expression if some kind of expression node
String	getMandatory()
String	getName()
String	getShortName()
String	getToName()
String	getType()
Class<?>	getTypeClass()
void	setCharset(String charset)	To use a specific charset when converting
void	setMandatory(String mandatory)	When mandatory then the conversion must return a value (cannot be null), if this is not possible then NoTypeConversionAvailableException is thrown.
void	setName(String name)	Name of message header to convert its value
void	setToName(String toName)	To use another header to store the result.
void	setType(String type)	The java type to convert to
void	setTypeClass(Class<?> typeClass)
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, 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

ConvertHeaderDefinition

public ConvertHeaderDefinition()

ConvertHeaderDefinition

public ConvertHeaderDefinition(String name,
 String type)

ConvertHeaderDefinition

public ConvertHeaderDefinition(String name,
 Class<?> typeClass)

ConvertHeaderDefinition

public ConvertHeaderDefinition(String name,
 String toName,
 Class<?> typeClass)

ConvertHeaderDefinition

public ConvertHeaderDefinition(String name,
 Class<?> typeClass,
 boolean mandatory)

ConvertHeaderDefinition

public ConvertHeaderDefinition(String name,
 Class<?> typeClass,
 String charset)

Method Details

toString

public String toString()

Overrides:

toString in class Object

getShortName

public String getShortName()

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

setName

public void setName(String name)

Name of message header to convert its value

The simple language can be used to define a dynamic evaluated header name to be used. Otherwise a constant name will be used.

getName

public String getName()

getToName

public String getToName()

setToName

public void setToName(String toName)

To use another header to store the result. By default, the result is stored in the same header. This option allows to use another header.

The simple language can be used to define a dynamic evaluated header name to be used. Otherwise a constant name will be used.

getType

public String getType()

setType

public void setType(String type)

The java type to convert to

getTypeClass

public Class<?> getTypeClass()

setTypeClass

public void setTypeClass(Class<?> typeClass)

getCharset

public String getCharset()

setCharset

public void setCharset(String charset)

To use a specific charset when converting

getMandatory

public String getMandatory()

setMandatory

public void setMandatory(String mandatory)

When mandatory then the conversion must return a value (cannot be null), if this is not possible then NoTypeConversionAvailableException is thrown. Setting this to false could mean conversion is not possible and the value is null.