org.apache.synapse.mediators.transform
Class PayloadFactoryMediator

java.lang.Object
  org.apache.synapse.mediators.AbstractMediator
      org.apache.synapse.mediators.transform.PayloadFactoryMediator

All Implemented Interfaces:

AspectConfigurable, Mediator, SynapseArtifact

public class PayloadFactoryMediator
extends AbstractMediator

Payload-factory mediator creates a new SOAP payload for the message, replacing the existing one.

printf()

style formatting is used to configure the transformation performed by the mediator.

Each argument in the mediator configuration could be a static value or an XPath expression. When an expression is used, argument value is fetched at runtime by evaluating the provided XPath expression against the existing SOAP message/message context.

Nested Class Summary

static class

PayloadFactoryMediator.Argument Represents an argument provided in the payload factory mediator configuration.

Field Summary

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

log, trace, traceState

Constructor Summary

PayloadFactoryMediator()

Method Summary

void	addArgument(PayloadFactoryMediator.Argument arg)
List<PayloadFactoryMediator.Argument>	getArgumentList()
String	getFormat()
boolean	mediate(MessageContext synCtx) Invokes the mediator passing the current message for mediation.
void	setFormat(String format)

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

auditLog, auditWarn, configure, disableStatistics, enableStatistics, getAspectConfiguration, getDescription, getLog, getTraceState, getType, handleException, handleException, isStatisticsEnable, isTraceOn, isTraceOrDebugOn, setDescription, setEffectiveTraceState, setTraceState, shouldTrace, traceOrDebug, traceOrDebugWarn

Methods inherited from class java.lang.Object

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

Constructor Detail

PayloadFactoryMediator

public PayloadFactoryMediator()

Method Detail

mediate

public boolean mediate(MessageContext synCtx)

Description copied from interface: Mediator

Invokes the mediator passing the current message for mediation. Each mediator performs its mediation action, and returns true if mediation should continue, or false if further mediation should be aborted.

Parameters:

synCtx - the current message for mediation

Returns:

true if further mediation should continue

getFormat

public String getFormat()

setFormat

public void setFormat(String format)

addArgument

public void addArgument(PayloadFactoryMediator.Argument arg)

getArgumentList

public List<PayloadFactoryMediator.Argument> getArgumentList()