org.apache.synapse
Interface SynapseMessage

All Known Implementing Classes:
Axis2SynapseMessage

public interface SynapseMessage

The core definition of a message flowing thru Synapse.

The aim of this is to capture the Message Addressing Properties (aka Message Information Headers) and the SOAP Envelope. The core To/From/FaultTo/ReplyTo/MessageID/RelatesTo stuff is here.

In addition this has get/setEnvelope.

There is also a bag of properties

There are markers for whether we support REST, MTOM and also if this is a response or not


Method Summary
 org.apache.axis2.soap.SOAPEnvelope getEnvelope()
           
 org.apache.axis2.addressing.EndpointReference getFaultTo()
           
 org.apache.axis2.addressing.EndpointReference getFrom()
           
 java.lang.String getMessageId()
           
 java.lang.String getMessageID()
           
 java.lang.Object getProperty(java.lang.String key)
           
 org.apache.axis2.addressing.RelatesTo getRelatesTo()
           
 org.apache.axis2.addressing.EndpointReference getReplyTo()
           
 java.lang.String getSoapAction()
           
 org.apache.axis2.addressing.EndpointReference getTo()
           
 java.lang.String getWSAAction()
           
 boolean isDoingMTOM()
           
 boolean isDoingREST()
           
 boolean isFaultResponse()
           
 boolean isResponse()
           
 boolean isSOAP11()
           
 void setDoingMTOM(boolean b)
           
 void setDoingREST(boolean b)
           
 void setEnvelope(org.apache.axis2.soap.SOAPEnvelope envelope)
           
 void setFaultResponse(boolean b)
           
 void setFaultTo(org.apache.axis2.addressing.EndpointReference reference)
           
 void setFrom(org.apache.axis2.addressing.EndpointReference reference)
           
 void setMessageId(java.lang.String messageID)
           
 void setMessageID(java.lang.String string)
           
 void setProperty(java.lang.String key, java.lang.Object value)
           
 void setRelatesTo(org.apache.axis2.addressing.RelatesTo reference)
           
 void setReplyTo(org.apache.axis2.addressing.EndpointReference reference)
           
 void setResponse(boolean b)
           
 void setSoapAction(java.lang.String string)
           
 void setTo(org.apache.axis2.addressing.EndpointReference reference)
           
 void setWSAAction(java.lang.String actionURI)
           
 

Method Detail

getFaultTo

public org.apache.axis2.addressing.EndpointReference getFaultTo()

setFaultTo

public void setFaultTo(org.apache.axis2.addressing.EndpointReference reference)

getFrom

public org.apache.axis2.addressing.EndpointReference getFrom()

setFrom

public void setFrom(org.apache.axis2.addressing.EndpointReference reference)

getEnvelope

public org.apache.axis2.soap.SOAPEnvelope getEnvelope()

setEnvelope

public void setEnvelope(org.apache.axis2.soap.SOAPEnvelope envelope)
                 throws org.apache.axis2.AxisFault
Throws:
org.apache.axis2.AxisFault

getMessageID

public java.lang.String getMessageID()

setMessageID

public void setMessageID(java.lang.String string)

getRelatesTo

public org.apache.axis2.addressing.RelatesTo getRelatesTo()

setRelatesTo

public void setRelatesTo(org.apache.axis2.addressing.RelatesTo reference)

getReplyTo

public org.apache.axis2.addressing.EndpointReference getReplyTo()

setReplyTo

public void setReplyTo(org.apache.axis2.addressing.EndpointReference reference)

getTo

public org.apache.axis2.addressing.EndpointReference getTo()

setTo

public void setTo(org.apache.axis2.addressing.EndpointReference reference)

setWSAAction

public void setWSAAction(java.lang.String actionURI)

getWSAAction

public java.lang.String getWSAAction()

setMessageId

public void setMessageId(java.lang.String messageID)

getMessageId

public java.lang.String getMessageId()

getProperty

public java.lang.Object getProperty(java.lang.String key)

setProperty

public void setProperty(java.lang.String key,
                        java.lang.Object value)

getSoapAction

public java.lang.String getSoapAction()

setSoapAction

public void setSoapAction(java.lang.String string)

isDoingMTOM

public boolean isDoingMTOM()

setDoingMTOM

public void setDoingMTOM(boolean b)

isDoingREST

public boolean isDoingREST()

setDoingREST

public void setDoingREST(boolean b)

isSOAP11

public boolean isSOAP11()

setResponse

public void setResponse(boolean b)

isResponse

public boolean isResponse()

setFaultResponse

public void setFaultResponse(boolean b)

isFaultResponse

public boolean isFaultResponse()