Axis2MessageContext (Apache Synapse 1.2 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.synapse.core.axis2
Class Axis2MessageContext

java.lang.Object
  org.apache.synapse.core.axis2.Axis2MessageContext

All Implemented Interfaces:: MessageContext

public class Axis2MessageContext
extends Object
implements MessageContext
extends Object
implements MessageContext

This is the MessageContext implementation that synapse uses almost all the time because Synapse is implemented on top of the Axis2

Constructor Summary
`Axis2MessageContext(MessageContext axisMsgCtx, SynapseConfiguration synCfg, SynapseEnvironment synEnv)` Constructor for the Axis2MessageContext inside Synapse

Method Summary
`MessageContext`	`getAxis2MessageContext()`
`SynapseConfiguration`	`getConfiguration()` Get a reference to the current SynapseConfiguration
`Map`	`getContextEntries()` Return all the entries which are in the MessageContext.
`Endpoint`	`getEndpoint(String key)` Return the endpoint with the given key from the configuration, or the local message context.
`Object`	`getEntry(String key)` Get the value of a property set on the message instance, from the local registry or the remote registry - by cascading through
`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.
`Stack`	`getFaultStack()`
`EndpointReference`	`getFaultTo()` Get the faultTo EPR if available
`EndpointReference`	`getFrom()` Get the from EPR if available
`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.
`String`	`getMessageID()` Get the message id if available
`Object`	`getProperty(String key)` Get the value of a custom (local) property set on the message instance
`Set`	`getPropertyKeySet()` Returns the Set of keys over the properties on this message context
`RelatesTo`	`getRelatesTo()` Get the relatesTo of this message
`EndpointReference`	`getReplyTo()` Get the replyTo EPR if available
`Mediator`	`getSequence(String key)` Return the sequence 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
`String`	`getSoapAction()` Returns the SOAPAction of the message
`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
`String`	`getWSAAction()` Returns the WSAAction
`String`	`getWSAMessageID()` Gets the message name
`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`	`isPaused()`
`boolean`	`isResponse()` Is this message a response to a synchronous message sent out through Synapse?
`boolean`	`isServerSide()`
`boolean`	`isSOAP11()` Is this message a SOAP 1.1 message?
`void`	`pushFaultHandler(FaultHandler fault)`
`void`	`setAxis2MessageContext(MessageContext axisMsgCtx)`
`void`	`setConfiguration(SynapseConfiguration synCfg)` Set or replace the Synapse Configuration instance to be used.
`void`	`setContextEntries(Map<String,Object> entries)` Sets the entries to the current context and not to the configuration.
`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(SOAPEnvelope envelope)` Sets the given envelope as the current SOAPEnvelope for this message
`void`	`setEnvironment(SynapseEnvironment synEnv)` Sets the SynapseEnvironment reference to this context
`void`	`setFaultResponse(boolean b)` Marks this message as a fault response
`void`	`setFaultTo(EndpointReference reference)` Set the faultTo EPR
`void`	`setFrom(EndpointReference reference)` Set the from EPR
`void`	`setMessageID(String string)` Set the message id
`void`	`setPaused(boolean value)`
`void`	`setProperty(String key, Object value)` Set a custom (local) property with the given name on the message instance
`void`	`setRelatesTo(RelatesTo[] reference)` Sets the relatesTo references for this message
`void`	`setReplyTo(EndpointReference reference)` Set the replyTo EPR
`void`	`setResponse(boolean b)` Mark this message as a response or not.
`void`	`setServerSide(boolean value)`
`void`	`setServiceLog(org.apache.commons.logging.Log serviceLog)` Set the service log
`void`	`setSoapAction(String string)` Set the SOAPAction
`void`	`setTo(EndpointReference reference)` Set the To EPR
`void`	`setTracingState(int tracingState)` This is used to set the value of tracing enable variable
`void`	`setWSAAction(String actionURI)` Sets the WSAAction
`void`	`setWSAMessageID(String messageID)` Set the message
`String`	`toString()`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

Axis2MessageContext

public Axis2MessageContext(MessageContext axisMsgCtx,
                           SynapseConfiguration synCfg,
                           SynapseEnvironment synEnv)

Constructor for the Axis2MessageContext inside Synapse

Parameters:: axisMsgCtx - MessageContext representing the relevant Axis MC; synCfg - SynapseConfiguraion describing Synapse; synEnv - SynapseEnvironment describing the environment of Synapse

Method Detail