Class FaultMediator
- java.lang.Object
-
- org.apache.synapse.mediators.AbstractMediator
-
- org.apache.synapse.mediators.transform.FaultMediator
-
- All Implemented Interfaces:
AspectConfigurable
,Mediator
,SynapseArtifact
public class FaultMediator extends AbstractMediator
This transforms the current message instance into a SOAP Fault message. The SOAP version for the fault message could be explicitly specified. Else if the original message was SOAP 1.1 the fault will also be SOAP 1.1 else, SOAP 1.2 This class exposes methods to set SOAP 1.1 and 1.2 fault elements and uses these as required. Directs the fault messages' "To" EPR to the "FaultTo" or the "ReplyTo" or to null of the original SOAP message
-
-
Field Summary
Fields Modifier and Type Field Description static int
POX
Make a POX faultstatic int
SOAP11
Make a SOAP 1.1 faultstatic int
SOAP12
Make a SOAP 1.2 faultstatic String
WSA_ACTION
-
Fields inherited from class org.apache.synapse.mediators.AbstractMediator
log, trace, traceState
-
-
Constructor Summary
Constructors Constructor Description FaultMediator()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addFaultDetailElement(org.apache.axiom.om.OMElement element)
SynapseXPath
getFaultCodeExpr()
QName
getFaultCodeValue()
String
getFaultDetail()
List<org.apache.axiom.om.OMElement>
getFaultDetailElements()
SynapseXPath
getFaultDetailExpr()
URI
getFaultNode()
SynapseXPath
getFaultReasonExpr()
String
getFaultReasonValue()
URI
getFaultRole()
int
getSoapVersion()
boolean
isContentAltering()
This is used to indicate whether message payload get modified during mediationboolean
isMarkAsResponse()
boolean
isSerializeResponse()
boolean
mediate(MessageContext synCtx)
Invokes the mediator passing the current message for mediation.void
setFaultCodeExpr(SynapseXPath faultCodeExpr)
void
setFaultCodeValue(QName faultCodeValue)
void
setFaultDetail(String faultDetail)
void
setFaultDetailExpr(SynapseXPath faultDetailExpr)
void
setFaultNode(URI faultNode)
void
setFaultReasonExpr(SynapseXPath faultReasonExpr)
void
setFaultReasonValue(String faultReasonValue)
void
setFaultRole(URI faultRole)
void
setMarkAsResponse(boolean markAsResponse)
void
setSerializeResponse(boolean serializeResponse)
void
setSoapVersion(int soapVersion)
-
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, isContentAware, isSkipEnabled, isStatisticsEnable, isTraceOn, isTraceOrDebugOn, isTracingEnabled, registerMediationFlowPoint, reportCloseStatistics, reportOpenStatistics, setBreakPoint, setCommentsList, setComponentStatisticsId, setDescription, setEffectiveTraceState, setMediatorPosition, setShortDescription, setSkipEnabled, setTraceState, shouldCaptureTracing, shouldTrace, shouldTrace, traceOrDebug, traceOrDebugWarn, unregisterMediationFlowPoint
-
-
-
-
Field Detail
-
WSA_ACTION
public static final String WSA_ACTION
- See Also:
- Constant Field Values
-
SOAP11
public static final int SOAP11
Make a SOAP 1.1 fault- See Also:
- Constant Field Values
-
SOAP12
public static final int SOAP12
Make a SOAP 1.2 fault- See Also:
- Constant Field Values
-
POX
public static final int POX
Make a POX fault- See Also:
- Constant Field Values
-
-
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
-
getSoapVersion
public int getSoapVersion()
-
setSoapVersion
public void setSoapVersion(int soapVersion)
-
isMarkAsResponse
public boolean isMarkAsResponse()
-
setMarkAsResponse
public void setMarkAsResponse(boolean markAsResponse)
-
isSerializeResponse
public boolean isSerializeResponse()
-
setSerializeResponse
public void setSerializeResponse(boolean serializeResponse)
-
getFaultCodeValue
public QName getFaultCodeValue()
-
setFaultCodeValue
public void setFaultCodeValue(QName faultCodeValue)
-
getFaultCodeExpr
public SynapseXPath getFaultCodeExpr()
-
setFaultCodeExpr
public void setFaultCodeExpr(SynapseXPath faultCodeExpr)
-
getFaultReasonValue
public String getFaultReasonValue()
-
setFaultReasonValue
public void setFaultReasonValue(String faultReasonValue)
-
getFaultReasonExpr
public SynapseXPath getFaultReasonExpr()
-
setFaultReasonExpr
public void setFaultReasonExpr(SynapseXPath faultReasonExpr)
-
getFaultNode
public URI getFaultNode()
-
setFaultNode
public void setFaultNode(URI faultNode)
-
getFaultRole
public URI getFaultRole()
-
setFaultRole
public void setFaultRole(URI faultRole)
-
getFaultDetail
public String getFaultDetail()
-
setFaultDetail
public void setFaultDetail(String faultDetail)
-
getFaultDetailExpr
public SynapseXPath getFaultDetailExpr()
-
setFaultDetailExpr
public void setFaultDetailExpr(SynapseXPath faultDetailExpr)
-
getFaultDetailElements
public List<org.apache.axiom.om.OMElement> getFaultDetailElements()
-
addFaultDetailElement
public void addFaultDetailElement(org.apache.axiom.om.OMElement element)
-
isContentAltering
public boolean isContentAltering()
Description copied from interface:Mediator
This is used to indicate whether message payload get modified during mediation- Specified by:
isContentAltering
in interfaceMediator
- Overrides:
isContentAltering
in classAbstractMediator
- Returns:
- whether mediator modify the payload
-
-