Package org.apache.synapse.mediators.template

Class TemplateMediator

java.lang.Object

org.apache.synapse.mediators.AbstractMediator

org.apache.synapse.mediators.AbstractListMediator

org.apache.synapse.mediators.template.TemplateMediator

All Implemented Interfaces:

AspectConfigurable, ManagedLifecycle, Mediator, ListMediator, SynapseArtifact

public class TemplateMediator
extends AbstractListMediator

This mediator is responsible for handling function templates for synapse. This will parse parameters passed from an mediator and will be made available to sequences defined within this template. parameters will be accessible through synapse 'function stack'. Users should access these through an xpath extension var or function , defined under function scope ie:- $func:p1 or get-property('func','p2')

Field Summary

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

mediators, msgBuildFailureExpattern

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

log, trace, traceState

Constructor Summary

Constructors

Constructor	Description
TemplateMediator()

Method Summary

Modifier and Type	Method	Description
void	destroy()	Destroy child mediators recursively
String	getArtifactContainerName()
String	getErrorHandler()
String	getFileName()
String	getName()
Collection<TemplateParam>	getParameters()
void	init(SynapseEnvironment se)	Initialize child mediators recursively
boolean	isDynamic()	Is this a dynamic template?
boolean	isEdited()
boolean	isInitialized()
boolean	isInitializing()
boolean	mediate(MessageContext synCtx)	Invokes the mediator passing the current message for mediation.
void	popFuncContextFrom(MessageContext synCtx)
void	setArtifactContainerName(String artifactContainerName)
void	setDynamic(boolean dynamic)	Mark this as a dynamic template
void	setErrorHandler(String errorHandler)
void	setFileName(String name)
void	setIsEdited(boolean isEdited)
void	setName(String name)
void	setParameters(Collection<TemplateParam> paramNames)

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

addAll, addChild, addChild, getChild, getList, isContentAware, mediate, removeChild, removeChild, setStatisticIdForMediators

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

auditLog, auditWarn, configure, disableStatistics, disableTracing, divertMediationRoute, enableStatistics, enableTracing, getAspectConfiguration, getCommentsList, getDescription, getInputType, getLastSequenceFaultHandler, getLog, getMediatorName, 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

Methods inherited from interface org.apache.synapse.Mediator

getMediatorName, getMediatorPosition, getShortDescription, getTraceState, getType, isContentAltering, reportCloseStatistics, reportOpenStatistics, setComponentStatisticsId, setMediatorPosition, setShortDescription, setTraceState

Methods inherited from interface org.apache.synapse.SynapseArtifact

getDescription, setDescription

Constructor Detail

TemplateMediator

public TemplateMediator()

Method Detail

setParameters

public void setParameters(Collection<TemplateParam> paramNames)

getParameters

public Collection<TemplateParam> getParameters()

setName

public void setName(String name)

getName

public String getName()

getArtifactContainerName

public String getArtifactContainerName()

setArtifactContainerName

public void setArtifactContainerName(String artifactContainerName)

isEdited

public boolean isEdited()

setIsEdited

public void setIsEdited(boolean isEdited)

getErrorHandler

public String getErrorHandler()

setErrorHandler

public void setErrorHandler(String errorHandler)

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.

Specified by:

mediate in interface Mediator

Overrides:

mediate in class AbstractListMediator

Parameters:

synCtx - the current message for mediation

Returns:

true if further mediation should continue

popFuncContextFrom

public void popFuncContextFrom(MessageContext synCtx)

setFileName

public void setFileName(String name)

getFileName

public String getFileName()

init

public void init(SynapseEnvironment se)

Description copied from class: AbstractListMediator

Initialize child mediators recursively

Specified by:

init in interface ManagedLifecycle

Overrides:

init in class AbstractListMediator

Parameters:

se - synapse environment

destroy

public void destroy()

Description copied from class: AbstractListMediator

Destroy child mediators recursively

Specified by:

destroy in interface ManagedLifecycle

Overrides:

destroy in class AbstractListMediator

isInitialized

public boolean isInitialized()

isInitializing

public boolean isInitializing()

isDynamic

public boolean isDynamic()

Is this a dynamic template?

Returns:

true if dynamic

setDynamic

public void setDynamic(boolean dynamic)

Mark this as a dynamic template

Parameters:

dynamic - true if this is a dynamic template