org.apache.synapse.mediators.bsf

Class ScriptMessageContext

java.lang.Object

org.apache.synapse.mediators.bsf.ScriptMessageContext

All Implemented Interfaces:

MessageContext

public class ScriptMessageContext
extends Object
implements MessageContext

ScriptMessageContext decorates the Synapse MessageContext adding methods to use the message payload XML in a way natural to the scripting languageS

Constructor Summary

Constructors

Constructor and Description
ScriptMessageContext(MessageContext mc, org.apache.bsf.xml.XMLHelper xmlHelper)

Method Summary

Modifier and Type	Method and Description
void	addHeader(boolean mustUnderstand, Object content) Add a new SOAP header to the message.
SynapseConfiguration	getConfiguration() Get a reference to the current SynapseConfiguration
Map<String,Object>	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
org.apache.axiom.soap.SOAPEnvelope	getEnvelope() Get the SOAP envelope of this message
Object	getEnvelopeXML() Get the XML representation of the complete SOAP envelope
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<FaultHandler>	getFaultStack()
org.apache.axis2.addressing.EndpointReference	getFaultTo() Get the faultTo EPR if available
org.apache.axis2.addressing.EndpointReference	getFrom() Get the from EPR if available
Object	getLocalEntry(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.
String	getMessageID() Get the message id if available
Object	getPayloadXML() Get the XML representation of SOAP Body payload.
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
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(String key) Return the sequence with the given key from the configuration, or the local message context.
Mediator	getSequenceTemplate(String key) Get the sequence template from the key
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
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
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	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	pushFaultHandler(FaultHandler fault)
void	removeProperty(String key) Remove property from message context Scope: Default
void	removeProperty(String key, String scope) Remove property from message context
void	setConfiguration(SynapseConfiguration cfg) 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(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	setFaultTo(String reference)
void	setFrom(org.apache.axis2.addressing.EndpointReference reference) Set the from EPR
void	setFrom(String reference)
void	setMessageID(String string) Set the message id
void	setPayloadXML(Object payload) Set the SOAP body payload from XML
void	setProperty(String key, Object value) Set a custom (local) property with the given name on the message instance
void	setProperty(String key, Object value, String scope) Set Property to the message context
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	setReplyTo(String reference)
void	setResponse(boolean b) Mark this message as a response or not.
void	setSoapAction(String string) Set the SOAPAction
void	setTo(org.apache.axis2.addressing.EndpointReference reference) Set the To EPR
void	setTo(String reference)
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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScriptMessageContext

public ScriptMessageContext(MessageContext mc,
                            org.apache.bsf.xml.XMLHelper xmlHelper)

Method Detail

getPayloadXML

public Object getPayloadXML()
                     throws ScriptException

Get the XML representation of SOAP Body payload. The payload is the first element inside the SOAP tags

Returns:

the XML SOAP Body

Throws:

ScriptException - in-case of an error in getting the XML representation of SOAP Body payload

setPayloadXML

public void setPayloadXML(Object payload)
                   throws org.apache.axiom.om.OMException,
                          ScriptException

Set the SOAP body payload from XML

Parameters:

payload - Message payload

Throws:

ScriptException - For errors in converting xml To OM

org.apache.axiom.om.OMException - For errors in OM manipulation

addHeader

public void addHeader(boolean mustUnderstand,
                      Object content)
               throws ScriptException

Add a new SOAP header to the message.

Parameters:

mustUnderstand - the value for the soapenv:mustUnderstand attribute

content - the XML for the new header

Throws:

ScriptException - if an error occurs when converting the XML to OM

getEnvelopeXML

public Object getEnvelopeXML()
                      throws ScriptException

Get the XML representation of the complete SOAP envelope

Returns:

return an object that represents the payload in the current scripting language

Throws:

ScriptException - in-case of an error in getting the XML representation of SOAP envelope

setTo

public void setTo(String reference)

setFaultTo

public void setFaultTo(String reference)

setFrom

public void setFrom(String reference)

setReplyTo

public void setReplyTo(String reference)

getConfiguration

public SynapseConfiguration getConfiguration()

Description copied from interface: MessageContext

Get a reference to the current SynapseConfiguration

Specified by:

getConfiguration in interface MessageContext

Returns:

the current synapse configuration

setConfiguration

public void setConfiguration(SynapseConfiguration cfg)

Description copied from interface: MessageContext

Set or replace the Synapse Configuration instance to be used. May be used to programatically change the configuration at runtime etc.

Specified by:

setConfiguration in interface MessageContext

Parameters:

cfg - The new synapse configuration instance

getEnvironment

public SynapseEnvironment getEnvironment()

Description copied from interface: MessageContext

Returns a reference to the host Synapse Environment

Specified by:

getEnvironment in interface MessageContext

Returns:

the Synapse Environment

setEnvironment

public void setEnvironment(SynapseEnvironment se)

Description copied from interface: MessageContext

Sets the SynapseEnvironment reference to this context

Specified by:

setEnvironment in interface MessageContext

Parameters:

se - the reference to the Synapse Environment

getContextEntries

public Map<String,Object> getContextEntries()

Description copied from interface: MessageContext

Return all the entries which are in the MessageContext. This does not represent all the declared entries in the configuration, rather only the entries that the context has already used. This will not lookup for the entries in the Configuration.

Specified by:

getContextEntries in interface MessageContext

Returns:

the set of local entries in the context

setContextEntries

public void setContextEntries(Map<String,Object> entries)

Description copied from interface: MessageContext

Sets the entries to the current context and not to the configuration. This can be used to forcibly override an existing set of resources in the configuration, because the resource lookup will look for the context first. But this only sets the entries to the current context

Specified by:

setContextEntries in interface MessageContext

Parameters:

entries - the set of local entries to be set

getProperty

public Object getProperty(String key)

Description copied from interface: MessageContext

Get the value of a custom (local) property set on the message instance

Specified by:

getProperty in interface MessageContext

Parameters:

key - key to look up property

Returns:

value for the given key

getEntry

public Object getEntry(String key)

Description copied from interface: MessageContext

Get the value of a property set on the message instance, from the local registry or the remote registry - by cascading through

Specified by:

getEntry in interface MessageContext

Parameters:

key - key to look up property

Returns:

value for the given key

getLocalEntry

public Object getLocalEntry(String key)

Description copied from interface: MessageContext

Get the value of a property set on the message instance or from the local registry

Specified by:

getLocalEntry in interface MessageContext

Parameters:

key - key to look up property

Returns:

value for the given key

setProperty

public void setProperty(String key,
                        Object value)

Description copied from interface: MessageContext

Set a custom (local) property with the given name on the message instance

Specified by:

setProperty in interface MessageContext

Parameters:

key - key to be used

value - value to be saved

setProperty

public void setProperty(String key,
                        Object value,
                        String scope)

Set Property to the message context

Parameters:

key - property name

value - property value

scope - scope of the property

removeProperty

public void removeProperty(String key)

Remove property from message context Scope: Default

Parameters:

key - Property name

removeProperty

public void removeProperty(String key,
                           String scope)

Remove property from message context

Parameters:

key - Property name

scope - Property scope

getPropertyKeySet

public Set getPropertyKeySet()

Description copied from interface: MessageContext

Returns the Set of keys over the properties on this message context

Specified by:

getPropertyKeySet in interface MessageContext

Returns:

a Set of keys over message properties

getMainSequence

public Mediator getMainSequence()

Description copied from interface: MessageContext

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. a request and response message pair will not see a difference in the main sequence if the main sequence was dynamic and changed in between at the registry

Specified by:

getMainSequence in interface MessageContext

Returns:

the main sequence to be used for mediation

getFaultSequence

public Mediator getFaultSequence()

Description copied from interface: MessageContext

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. a request and response message pair will not see a difference in the fault sequence if the fault sequence was dynamic and changed in between at the registry

Specified by:

getFaultSequence in interface MessageContext

Returns:

the fault sequence to be used for mediation

getSequence

public Mediator getSequence(String key)

Description copied from interface: MessageContext

Return the sequence with the given key from the configuration, or the local message context. This method looks up for the sequence with the given key from the local message context to make this look up transactional - i.e. a request and response message pair will not see a difference in the said sequence if it was dynamic and changed in between at the registry

Specified by:

getSequence in interface MessageContext

Parameters:

key - the sequence key to be looked up

Returns:

the sequence mediator mapped to the key

getEndpoint

public Endpoint getEndpoint(String key)

Description copied from interface: MessageContext

Return the endpoint with the given key from the configuration, or the local message context. This method looks up for the endpoint with the given key from the local message context to make this look up transactional - i.e. a request and response message pair will not see a difference in the said endpoint if it was dynamic and changed in between at the registry

Specified by:

getEndpoint in interface MessageContext

Parameters:

key - the endpoint key to be looked up

Returns:

the endpoint mapped to the key

getEnvelope

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

Description copied from interface: MessageContext

Get the SOAP envelope of this message

Specified by:

getEnvelope in interface MessageContext

Returns:

the SOAP envelope of the message

setEnvelope

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

Description copied from interface: MessageContext

Sets the given envelope as the current SOAPEnvelope for this message

Specified by:

setEnvelope in interface MessageContext

Parameters:

envelope - the envelope to be set

Throws:

org.apache.axis2.AxisFault - on exception

getFaultTo

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

Description copied from interface: MessageContext

Get the faultTo EPR if available

Specified by:

getFaultTo in interface MessageContext

Returns:

FaultTo epr if available

setFaultTo

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

Description copied from interface: MessageContext

Set the faultTo EPR

Specified by:

setFaultTo in interface MessageContext

Parameters:

reference - epr representing the FaultTo address

getFrom

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

Description copied from interface: MessageContext

Get the from EPR if available

Specified by:

getFrom in interface MessageContext

Returns:

From epr if available

setFrom

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

Description copied from interface: MessageContext

Set the from EPR

Specified by:

setFrom in interface MessageContext

Parameters:

reference - epr representing the From address

getMessageID

public String getMessageID()

Description copied from interface: MessageContext

Get the message id if available

Specified by:

getMessageID in interface MessageContext

Returns:

message id if available

setMessageID

public void setMessageID(String string)

Description copied from interface: MessageContext

Set the message id

Specified by:

setMessageID in interface MessageContext

Parameters:

string - message id to be set

getRelatesTo

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

Description copied from interface: MessageContext

Get the relatesTo of this message

Specified by:

getRelatesTo in interface MessageContext

Returns:

RelatesTo of the message if available

setRelatesTo

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

Description copied from interface: MessageContext

Sets the relatesTo references for this message

Specified by:

setRelatesTo in interface MessageContext

Parameters:

reference - the relatesTo references array

getReplyTo

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

Description copied from interface: MessageContext

Get the replyTo EPR if available

Specified by:

getReplyTo in interface MessageContext

Returns:

ReplyTo epr of the message if available

setReplyTo

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

Description copied from interface: MessageContext

Set the replyTo EPR

Specified by:

setReplyTo in interface MessageContext

Parameters:

reference - epr representing the ReplyTo address

getTo

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

Description copied from interface: MessageContext

Get the To EPR

Specified by:

getTo in interface MessageContext

Returns:

To epr of the message if available

setTo

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

Description copied from interface: MessageContext

Set the To EPR

Specified by:

setTo in interface MessageContext

Parameters:

reference - the To EPR

setWSAAction

public void setWSAAction(String actionURI)

Description copied from interface: MessageContext

Sets the WSAAction

Specified by:

setWSAAction in interface MessageContext

Parameters:

actionURI - the WSAAction

getWSAAction

public String getWSAAction()

Description copied from interface: MessageContext

Returns the WSAAction

Specified by:

getWSAAction in interface MessageContext

Returns:

the WSAAction

getSoapAction

public String getSoapAction()

Description copied from interface: MessageContext

Returns the SOAPAction of the message

Specified by:

getSoapAction in interface MessageContext

Returns:

the SOAPAction

setSoapAction

public void setSoapAction(String string)

Description copied from interface: MessageContext

Set the SOAPAction

Specified by:

setSoapAction in interface MessageContext

Parameters:

string - the SOAP Action

setWSAMessageID

public void setWSAMessageID(String messageID)

Description copied from interface: MessageContext

Set the message

Specified by:

setWSAMessageID in interface MessageContext

Parameters:

messageID - message id to be set

getWSAMessageID

public String getWSAMessageID()

Description copied from interface: MessageContext

Gets the message name

Specified by:

getWSAMessageID in interface MessageContext

Returns:

the WSA MessageID

isDoingMTOM

public boolean isDoingMTOM()

Description copied from interface: MessageContext

If this message using MTOM?

Specified by:

isDoingMTOM in interface MessageContext

Returns:

true if using MTOM

isDoingSWA

public boolean isDoingSWA()

Description copied from interface: MessageContext

If this message using SWA?

Specified by:

isDoingSWA in interface MessageContext

Returns:

true if using SWA

setDoingMTOM

public void setDoingMTOM(boolean b)

Description copied from interface: MessageContext

Marks as using MTOM

Specified by:

setDoingMTOM in interface MessageContext

Parameters:

b - true to mark as using MTOM

setDoingSWA

public void setDoingSWA(boolean b)

Description copied from interface: MessageContext

Marks as using SWA

Specified by:

setDoingSWA in interface MessageContext

Parameters:

b - true to mark as using SWA

isDoingPOX

public boolean isDoingPOX()

Description copied from interface: MessageContext

Is this message over POX?

Specified by:

isDoingPOX in interface MessageContext

Returns:

true if over POX

setDoingPOX

public void setDoingPOX(boolean b)

Description copied from interface: MessageContext

Marks this message as over POX

Specified by:

setDoingPOX in interface MessageContext

Parameters:

b - true to mark as POX

isDoingGET

public boolean isDoingGET()

Description copied from interface: MessageContext

Is this message over GET?

Specified by:

isDoingGET in interface MessageContext

Returns:

true if over GET

setDoingGET

public void setDoingGET(boolean b)

Description copied from interface: MessageContext

Marks this message as over REST/GET

Specified by:

setDoingGET in interface MessageContext

Parameters:

b - true to mark as REST/GET

isSOAP11

public boolean isSOAP11()

Description copied from interface: MessageContext

Is this message a SOAP 1.1 message?

Specified by:

isSOAP11 in interface MessageContext

Returns:

true if this is a SOAP 1.1 message

setResponse

public void setResponse(boolean b)

Description copied from interface: MessageContext

Mark this message as a response or not.

Specified by:

setResponse in interface MessageContext

Parameters:

b - true to set this as a response

See Also:

MessageContext.isResponse()

isResponse

public boolean isResponse()

Description copied from interface: MessageContext

Is this message a response to a synchronous message sent out through Synapse?

Specified by:

isResponse in interface MessageContext

Returns:

true if this message is a response message

setFaultResponse

public void setFaultResponse(boolean b)

Description copied from interface: MessageContext

Marks this message as a fault response

Specified by:

setFaultResponse in interface MessageContext

Parameters:

b - true to mark this as a fault response

See Also:

MessageContext.isFaultResponse()

isFaultResponse

public boolean isFaultResponse()

Description copied from interface: MessageContext

Is this message a response to a fault message?

Specified by:

isFaultResponse in interface MessageContext

Returns:

true if this is a response to a fault message

getTracingState

public int getTracingState()

Description copied from interface: MessageContext

This is used to check whether the tracing should be enabled on the current mediator or not

Specified by:

getTracingState in interface MessageContext

Returns:

indicate whether tracing is on, off or unset

setTracingState

public void setTracingState(int tracingState)

Description copied from interface: MessageContext

This is used to set the value of tracing enable variable

Specified by:

setTracingState in interface MessageContext

Parameters:

tracingState - Set whether the tracing is enabled or not

getFaultStack

public Stack<FaultHandler> getFaultStack()

Specified by:

getFaultStack in interface MessageContext

pushFaultHandler

public void pushFaultHandler(FaultHandler fault)

Specified by:

pushFaultHandler in interface MessageContext

getServiceLog

public org.apache.commons.logging.Log getServiceLog()

Description copied from interface: MessageContext

Return the service level Log for this message context or null

Specified by:

getServiceLog in interface MessageContext

Returns:

the service level Log for the message

getSequenceTemplate

public Mediator getSequenceTemplate(String key)

Get the sequence template from the key

Specified by:

getSequenceTemplate in interface MessageContext

Parameters:

key - the sequence key to be looked up

Returns:

the sequence template