org.apache.synapse.mediators.transform

Class HeaderMediator

java.lang.Object

org.apache.synapse.mediators.AbstractMediator

org.apache.synapse.mediators.transform.HeaderMediator

All Implemented Interfaces:

AspectConfigurable, Mediator, SynapseArtifact

public class HeaderMediator
extends AbstractMediator

The header mediator is able to set a given value as a SOAP header, or remove a given header from the current message instance. This supports the headers currently supported by the HeaderType class. If an expression is supplied, its runtime value is evaluated using the current message. Unless the action is set to remove, the default behavior of this mediator is to set a header value.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACTION_REMOVE
static int	ACTION_SET

Fields inherited from class org.apache.synapse.mediators.AbstractMediator

log, trace, traceState

Constructor Summary

Constructors

Constructor and Description
HeaderMediator()

Method Summary

Modifier and Type	Method and Description
void	addEmbeddedXml(org.apache.axiom.om.OMElement element)
int	getAction()
List<org.apache.axiom.om.OMElement>	getEmbeddedXml()
SynapsePath	getExpression()
String	getMediatorName() Returns the name of the class of respective mediator.
QName	getQName()
String	getScope()
String	getValue()
boolean	hasEmbeddedXml()
boolean	isContentAware()
boolean	isImplicit()
boolean	mediate(MessageContext synCtx) Sets/Removes a SOAP header on the current message
void	setAction(int action)
void	setExpression(SynapsePath expression)
void	setQName(QName qName)
void	setScope(String scope)
void	setValue(String value)

Methods inherited from class org.apache.synapse.mediators.AbstractMediator

auditLog, auditWarn, configure, disableStatistics, disableTracing, divertMediationRoute, enableStatistics, enableTracing, getAspectConfiguration, getCommentsList, getDescription, getInputType, getLastSequenceFaultHandler, getLog, getMediatorPosition, getOutputType, getRegisteredMediationFlowPoint, getShortDescription, getTraceState, getType, handleException, handleException, isBreakPoint, isContentAltering, isSkipEnabled, isStatisticsEnable, isTraceOn, isTraceOrDebugOn, isTracingEnabled, registerMediationFlowPoint, reportCloseStatistics, reportOpenStatistics, setBreakPoint, setCommentsList, setComponentStatisticsId, setDescription, setEffectiveTraceState, setMediatorPosition, setShortDescription, setSkipEnabled, setTraceState, shouldCaptureTracing, shouldTrace, shouldTrace, traceOrDebug, traceOrDebugWarn, unregisterMediationFlowPoint

Methods inherited from class java.lang.Object

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

Field Detail

ACTION_SET

public static final int ACTION_SET

See Also:

Constant Field Values

ACTION_REMOVE

public static final int ACTION_REMOVE

See Also:

Constant Field Values

Constructor Detail

HeaderMediator

public HeaderMediator()

Method Detail

mediate

public boolean mediate(MessageContext synCtx)

Sets/Removes a SOAP header on the current message

Parameters:

synCtx - the current message which is altered as necessary

Returns:

true always

getScope

public String getScope()

setScope

public void setScope(String scope)

getAction

public int getAction()

setAction

public void setAction(int action)

getQName

public QName getQName()

setQName

public void setQName(QName qName)

getValue

public String getValue()

setValue

public void setValue(String value)

getExpression

public SynapsePath getExpression()

getEmbeddedXml

public List<org.apache.axiom.om.OMElement> getEmbeddedXml()

addEmbeddedXml

public void addEmbeddedXml(org.apache.axiom.om.OMElement element)

hasEmbeddedXml

public boolean hasEmbeddedXml()

isImplicit

public boolean isImplicit()

setExpression

public void setExpression(SynapsePath expression)

isContentAware

public boolean isContentAware()

Specified by:

isContentAware in interface Mediator

Overrides:

isContentAware in class AbstractMediator

getMediatorName

public String getMediatorName()

Description copied from class: AbstractMediator

Returns the name of the class of respective mediator. This was introduced to provide a unique way to get the mediator name because getType is implemented in different ways in different mediators (e.g. PayloadFactoryMediator)

Specified by:

getMediatorName in interface Mediator

Overrides:

getMediatorName in class AbstractMediator

Returns:

a String of the mediator class name