Package org.apache.synapse.mediators.filters

Class OutMediator

java.lang.Object

org.apache.synapse.mediators.AbstractMediator

org.apache.synapse.mediators.AbstractListMediator

org.apache.synapse.mediators.filters.OutMediator

All Implemented Interfaces:

AspectConfigurable, ManagedLifecycle, Mediator, FilterMediator, FlowContinuableMediator, ListMediator, SynapseArtifact

public class OutMediator
extends AbstractListMediator
implements FilterMediator, FlowContinuableMediator

The Out Mediator acts only on "outgoing" messages from synapse. This is performed by looking at the result of MessageContext#isResponse()

See Also:

MessageContext.isResponse()

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
OutMediator()

Method Summary

Modifier and Type	Method	Description
void	init(SynapseEnvironment se)	Initialize child mediators recursively
boolean	isContentAware()
boolean	mediate(MessageContext synCtx)	Executes the list of sub/child mediators, if the filter condition is satisfied
boolean	mediate(MessageContext synCtx, ContinuationState continuationState)	Mediate the message using a ContinuationState.
Integer	reportOpenStatistics(MessageContext messageContext, boolean isContentAltering)	Report Open Statistic Event for the Mediator
void	setComponentStatisticsId(ArtifactHolder holder)
boolean	test(MessageContext synCtx)	Apply mediation only on response messages

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

addAll, addChild, addChild, destroy, getChild, getList, 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, setBreakPoint, setCommentsList, 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.mediators.ListMediator

addAll, addChild, getChild, getList, removeChild, removeChild

Methods inherited from interface org.apache.synapse.ManagedLifecycle

destroy

Methods inherited from interface org.apache.synapse.Mediator

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

Methods inherited from interface org.apache.synapse.SynapseArtifact

getDescription, setDescription

Constructor Detail

OutMediator

public OutMediator()

Method Detail

mediate

public boolean mediate(MessageContext synCtx)

Executes the list of sub/child mediators, if the filter condition is satisfied

Specified by:

mediate in interface Mediator

Overrides:

mediate in class AbstractListMediator

Parameters:

synCtx - the current message

Returns:

true if filter condition fails. else returns as per List mediator semantics

mediate

public boolean mediate(MessageContext synCtx,
                       ContinuationState continuationState)

Description copied from interface: FlowContinuableMediator

Mediate the message using a ContinuationState. This is used when mediating the response message when service is invoked using a Call Mediator.

Specified by:

mediate in interface FlowContinuableMediator

Parameters:

synCtx - MessageContext

continuationState - ContinuationState

Returns:

whether mediation flow is completed

test

public boolean test(MessageContext synCtx)

Apply mediation only on response messages

Specified by:

test in interface FilterMediator

Parameters:

synCtx - the message context

Returns:

MessageContext#isResponse()

isContentAware

public boolean isContentAware()

Specified by:

isContentAware in interface Mediator

Overrides:

isContentAware in class AbstractListMediator

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

reportOpenStatistics

public Integer reportOpenStatistics(MessageContext messageContext,
                                    boolean isContentAltering)

Description copied from interface: Mediator

Report Open Statistic Event for the Mediator

Specified by:

reportOpenStatistics in interface Mediator

Overrides:

reportOpenStatistics in class AbstractMediator

setComponentStatisticsId

public void setComponentStatisticsId(ArtifactHolder holder)

Specified by:

setComponentStatisticsId in interface Mediator

Overrides:

setComponentStatisticsId in class AbstractMediator