Package org.apache.synapse.mediators.builtin

Class CommentMediator

java.lang.Object

org.apache.synapse.mediators.AbstractMediator

org.apache.synapse.mediators.builtin.CommentMediator

All Implemented Interfaces:

AspectConfigurable, Mediator, SynapseArtifact

public class CommentMediator
extends AbstractMediator

Mediator to handle XML comment nodes in Synapse Configurations

Field Summary

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

log, trace, traceState

Constructor Summary

Constructors

Constructor	Description
CommentMediator()

Method Summary

Modifier and Type	Method	Description
String	getCommentText()	Returns Comment text
boolean	isContentAware()
boolean	mediate(MessageContext synCtx)	Mediation method.
void	reportCloseStatistics(MessageContext messageContext, Integer currentIndex)	Report Close Statistic Event for the Mediator
Integer	reportOpenStatistics(MessageContext synCtx, boolean isContentAltering)	Report Open Statistic Event for the Mediator
void	setCommentText(String commentText)	Set Comment Text
void	setComponentStatisticsId(ArtifactHolder holder)

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

Constructor Detail

CommentMediator

public CommentMediator()

Method Detail

mediate

public boolean mediate(MessageContext synCtx)

Mediation method. This will not do any tasks in CommentMediator

Parameters:

synCtx - the current message for mediation *

Returns:

true since remaining mediators should be executed

setCommentText

public void setCommentText(String commentText)

Set Comment Text

Parameters:

commentText - Text value of the comment to be set for the mediator

getCommentText

public String getCommentText()

Returns Comment text

Returns:

Comment text value associated with the mediator

isContentAware

public boolean isContentAware()

Specified by:

isContentAware in interface Mediator

Overrides:

isContentAware in class AbstractMediator

setComponentStatisticsId

public void setComponentStatisticsId(ArtifactHolder holder)

Specified by:

setComponentStatisticsId in interface Mediator

Overrides:

setComponentStatisticsId in class AbstractMediator

reportOpenStatistics

public Integer reportOpenStatistics(MessageContext synCtx,
                                    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

reportCloseStatistics

public void reportCloseStatistics(MessageContext messageContext,
                                  Integer currentIndex)

Description copied from interface: Mediator

Report Close Statistic Event for the Mediator

Specified by:

reportCloseStatistics in interface Mediator

Overrides:

reportCloseStatistics in class AbstractMediator