public interface MessageContext
Modifier and Type | Method and Description |
---|---|
SynapseConfiguration |
getConfiguration()
Get a reference to the current SynapseConfiguration
|
java.util.Map<java.lang.String,java.lang.Object> |
getContextEntries()
Return all the entries which are in the MessageContext.
|
java.util.Stack<ContinuationState> |
getContinuationStateStack()
Get the ContinuationStateStack.
|
Mediator |
getDefaultConfiguration(java.lang.String key)
Returns the InvokeMediator (which is wrapped with connector default
configuration)
|
Endpoint |
getEndpoint(java.lang.String key)
Return the endpoint with the given key from the configuration, or the local message
context.
|
java.lang.Object |
getEntry(java.lang.String key)
Get the value of a property set on the message instance, from the local registry
or the remote registry - by cascading through
|
org.apache.axiom.soap.SOAPEnvelope |
getEnvelope()
Get the SOAP envelope of this message
|
SynapseEnvironment |
getEnvironment()
Returns a reference to the host Synapse Environment
|
Mediator |
getFaultSequence()
Return the fault sequence from the configuration, or the local message context
This method looks up for the sequence named Constants.FAULT_SEQUENCE_KEY from
the local message context to make this look up transactional - i.e.
|
java.util.Stack<FaultHandler> |
getFaultStack() |
org.apache.axis2.addressing.EndpointReference |
getFaultTo()
Get the faultTo EPR if available
|
org.apache.axiom.om.OMElement |
getFormat(java.lang.String key)
Return the format with the given key from the configuration.
|
org.apache.axis2.addressing.EndpointReference |
getFrom()
Get the from EPR if available
|
java.lang.Object |
getLocalEntry(java.lang.String key)
Get the value of a property set on the message instance or from the local registry
|
Mediator |
getMainSequence()
Return the main sequence from the configuration, or the local message context
This method looks up for the sequence named Constants.MAIN_SEQUENCE_KEY from
the local message context to make this look up transactional - i.e.
|
int |
getMessageFlowTracingState()
This is used to check whether the message flow tracing enabled for current message context
|
java.lang.String |
getMessageID()
Get the message id if available
|
java.lang.String |
getMessageString()
Get Message properties as a String
|
java.lang.Object |
getProperty(java.lang.String key)
Get the value of a custom (local) property set on the message instance
|
java.util.Set |
getPropertyKeySet()
Returns the Set of keys over the properties on this message context
|
org.apache.axis2.addressing.RelatesTo |
getRelatesTo()
Get the relatesTo of this message
|
org.apache.axis2.addressing.EndpointReference |
getReplyTo()
Get the replyTo EPR if available
|
Mediator |
getSequence(java.lang.String key)
Return the sequence with the given key from the configuration, or the local message
context.
|
Mediator |
getSequenceTemplate(java.lang.String key)
Return the Sequence Template with the given key from the configuration, or the local message
context.
|
org.apache.commons.logging.Log |
getServiceLog()
Return the service level Log for this message context or null
|
java.lang.String |
getSoapAction()
Returns the SOAPAction of the message
|
org.apache.axis2.addressing.EndpointReference |
getTo()
Get the To EPR
|
int |
getTracingState()
This is used to check whether the tracing should be enabled on the current mediator or not
|
java.lang.String |
getWSAAction()
Returns the WSAAction
|
java.lang.String |
getWSAMessageID()
Gets the message name
|
boolean |
isContinuationEnabled()
is ContinuationStateStack stack Operations enabled
|
boolean |
isDoingGET()
Is this message over GET?
|
boolean |
isDoingMTOM()
If this message using MTOM?
|
boolean |
isDoingPOX()
Is this message over POX?
|
boolean |
isDoingSWA()
If this message using SWA?
|
boolean |
isFaultResponse()
Is this message a response to a fault message?
|
boolean |
isResponse()
Is this message a response to a synchronous message sent out through Synapse?
|
boolean |
isSOAP11()
Is this message a SOAP 1.1 message?
|
void |
pushContinuationState(ContinuationState continuationState) |
void |
pushFaultHandler(FaultHandler fault) |
void |
setConfiguration(SynapseConfiguration cfg)
Set or replace the Synapse Configuration instance to be used.
|
void |
setContextEntries(java.util.Map<java.lang.String,java.lang.Object> entries)
Sets the entries to the current context and not to the configuration.
|
void |
setContinuationEnabled(boolean continuationEnabled)
Enable/disable ContinuationStateStack operations
|
void |
setDoingGET(boolean b)
Marks this message as over REST/GET
|
void |
setDoingMTOM(boolean b)
Marks as using MTOM
|
void |
setDoingPOX(boolean b)
Marks this message as over POX
|
void |
setDoingSWA(boolean b)
Marks as using SWA
|
void |
setEnvelope(org.apache.axiom.soap.SOAPEnvelope envelope)
Sets the given envelope as the current SOAPEnvelope for this message
|
void |
setEnvironment(SynapseEnvironment se)
Sets the SynapseEnvironment reference to this context
|
void |
setFaultResponse(boolean b)
Marks this message as a fault response
|
void |
setFaultTo(org.apache.axis2.addressing.EndpointReference reference)
Set the faultTo EPR
|
void |
setFrom(org.apache.axis2.addressing.EndpointReference reference)
Set the from EPR
|
void |
setMessageFlowTracingState(int tracingState)
This is used to set the value of message flow tracing enable for a particular message
|
void |
setMessageID(java.lang.String string)
Set the message id
|
void |
setProperty(java.lang.String key,
java.lang.Object value)
Set a custom (local) property with the given name on the message instance
|
void |
setRelatesTo(org.apache.axis2.addressing.RelatesTo[] reference)
Sets the relatesTo references for this message
|
void |
setReplyTo(org.apache.axis2.addressing.EndpointReference reference)
Set the replyTo EPR
|
void |
setResponse(boolean b)
Mark this message as a response or not.
|
void |
setSoapAction(java.lang.String string)
Set the SOAPAction
|
void |
setTo(org.apache.axis2.addressing.EndpointReference reference)
Set the To EPR
|
void |
setTracingState(int tracingState)
This is used to set the value of tracing enable variable
|
void |
setWSAAction(java.lang.String actionURI)
Sets the WSAAction
|
void |
setWSAMessageID(java.lang.String messageID)
Set the message
|
SynapseConfiguration getConfiguration()
void setConfiguration(SynapseConfiguration cfg)
cfg
- The new synapse configuration instanceSynapseEnvironment getEnvironment()
void setEnvironment(SynapseEnvironment se)
se
- the reference to the Synapse Environmentjava.util.Map<java.lang.String,java.lang.Object> getContextEntries()
void setContextEntries(java.util.Map<java.lang.String,java.lang.Object> entries)
entries
- the set of local entries to be setMediator getMainSequence()
Mediator getFaultSequence()
Mediator getSequence(java.lang.String key)
key
- the sequence key to be looked uporg.apache.axiom.om.OMElement getFormat(java.lang.String key)
key
- Mediator getSequenceTemplate(java.lang.String key)
key
- the sequence key to be looked upEndpoint getEndpoint(java.lang.String key)
key
- the endpoint key to be looked upjava.lang.Object getProperty(java.lang.String key)
key
- key to look up propertyjava.lang.Object getEntry(java.lang.String key)
key
- key to look up propertyjava.lang.Object getLocalEntry(java.lang.String key)
key
- key to look up propertyvoid setProperty(java.lang.String key, java.lang.Object value)
key
- key to be usedvalue
- value to be savedjava.util.Set getPropertyKeySet()
org.apache.axiom.soap.SOAPEnvelope getEnvelope()
void setEnvelope(org.apache.axiom.soap.SOAPEnvelope envelope) throws org.apache.axis2.AxisFault
envelope
- the envelope to be setorg.apache.axis2.AxisFault
- on exceptionorg.apache.axis2.addressing.EndpointReference getFaultTo()
void setFaultTo(org.apache.axis2.addressing.EndpointReference reference)
reference
- epr representing the FaultTo addressorg.apache.axis2.addressing.EndpointReference getFrom()
void setFrom(org.apache.axis2.addressing.EndpointReference reference)
reference
- epr representing the From addressjava.lang.String getMessageID()
void setMessageID(java.lang.String string)
string
- message id to be setorg.apache.axis2.addressing.RelatesTo getRelatesTo()
void setRelatesTo(org.apache.axis2.addressing.RelatesTo[] reference)
reference
- the relatesTo references arrayorg.apache.axis2.addressing.EndpointReference getReplyTo()
void setReplyTo(org.apache.axis2.addressing.EndpointReference reference)
reference
- epr representing the ReplyTo addressorg.apache.axis2.addressing.EndpointReference getTo()
void setTo(org.apache.axis2.addressing.EndpointReference reference)
reference
- the To EPRvoid setWSAAction(java.lang.String actionURI)
actionURI
- the WSAActionjava.lang.String getWSAAction()
java.lang.String getSoapAction()
void setSoapAction(java.lang.String string)
string
- the SOAP Actionvoid setWSAMessageID(java.lang.String messageID)
messageID
- message id to be setjava.lang.String getWSAMessageID()
boolean isDoingMTOM()
boolean isDoingSWA()
void setDoingMTOM(boolean b)
b
- true to mark as using MTOMvoid setDoingSWA(boolean b)
b
- true to mark as using SWAboolean isDoingPOX()
void setDoingPOX(boolean b)
b
- true to mark as POXboolean isDoingGET()
void setDoingGET(boolean b)
b
- true to mark as REST/GETboolean isSOAP11()
void setResponse(boolean b)
b
- true to set this as a responseisResponse()
boolean isResponse()
void setFaultResponse(boolean b)
b
- true to mark this as a fault responseisFaultResponse()
boolean isFaultResponse()
int getTracingState()
void setTracingState(int tracingState)
tracingState
- Set whether the tracing is enabled or notjava.util.Stack<FaultHandler> getFaultStack()
void pushFaultHandler(FaultHandler fault)
java.util.Stack<ContinuationState> getContinuationStateStack()
void pushContinuationState(ContinuationState continuationState)
boolean isContinuationEnabled()
void setContinuationEnabled(boolean continuationEnabled)
continuationEnabled
- org.apache.commons.logging.Log getServiceLog()
Mediator getDefaultConfiguration(java.lang.String key)
key
- the default configuration ref to be looked upjava.lang.String getMessageString()
int getMessageFlowTracingState()
void setMessageFlowTracingState(int tracingState)
tracingState
- Set whether the message flowtracing is enabled or notCopyright © 2005-2022 Apache Software Foundation. All Rights Reserved.