public interface ScriptMessageContext
extends org.apache.synapse.MessageContext
Modifier and Type | Method and Description |
---|---|
void |
addHeader(boolean mustUnderstand,
java.lang.Object content)
Add a new SOAP header to the message.
|
java.lang.Object |
getEnvelopeXML()
Get the XML representation of the complete SOAP envelope.
|
java.lang.Object |
getJsonText()
Get the Message Payload as a text.
|
java.lang.Object |
getPayloadJSON()
Get the JSON object representation of the JSON message body of the request.
|
java.lang.String |
getPayloadText()
Get the Message Payload as a text.
|
java.lang.Object |
getPayloadXML()
Get the XML representation of SOAP Body payload.
|
java.lang.Object |
jsonObject(org.apache.synapse.MessageContext messageContext)
Get the JSON object representation of the JSON message body of the request.
|
void |
removeProperty(java.lang.String key,
java.lang.String scope)
Remove property from the message.
|
void |
setFaultTo(java.lang.String reference)
This is used to set the value which specifies the receiver of the faults relating to the message.
|
void |
setFrom(java.lang.String reference)
This is used to set the value which specifies the sender of the message.
|
boolean |
setJsonObject(org.apache.synapse.MessageContext messageContext,
java.lang.Object jsonObject)
Saves the JavaScript Object to the message context.
|
boolean |
setJsonText(org.apache.synapse.MessageContext messageContext,
java.lang.Object jsonObject)
Saves the JSON String to the message context.
|
void |
setPayloadJSON(java.lang.Object jsonPayload)
Saves the payload of this message context as a JSON payload.
|
void |
setPayloadXML(java.lang.Object payload)
Set the SOAP body payload from XML.
|
void |
setProperty(java.lang.String key,
java.lang.Object value,
java.lang.String scope)
Add a new property to the message.
|
void |
setReplyTo(java.lang.String reference)
This is used to set the value which specifies the receiver of the replies to the message.
|
void |
setScriptEngine(javax.script.ScriptEngine scriptEngine)
Set a script engine.
|
void |
setTo(java.lang.String reference)
This is used to set the value which specifies the receiver of the message.
|
getConfiguration, getContextEntries, getContinuationStateStack, getDefaultConfiguration, getEndpoint, getEntry, getEnvelope, getEnvironment, getFaultSequence, getFaultStack, getFaultTo, getFormat, getFrom, getLocalEntry, getMainSequence, getMessageFlowTracingState, getMessageID, getMessageString, getProperty, getPropertyKeySet, getRelatesTo, getReplyTo, getSequence, getSequenceTemplate, getServiceLog, getSoapAction, getTo, getTracingState, getWSAAction, getWSAMessageID, isContinuationEnabled, isDoingGET, isDoingMTOM, isDoingPOX, isDoingSWA, isFaultResponse, isResponse, isSOAP11, pushContinuationState, pushFaultHandler, setConfiguration, setContextEntries, setContinuationEnabled, setDoingGET, setDoingMTOM, setDoingPOX, setDoingSWA, setEnvelope, setEnvironment, setFaultResponse, setFaultTo, setFrom, setMessageFlowTracingState, setMessageID, setProperty, setRelatesTo, setReplyTo, setResponse, setSoapAction, setTo, setTracingState, setWSAAction, setWSAMessageID
java.lang.Object getPayloadXML() throws javax.script.ScriptException
javax.script.ScriptException
- in-case of an error in getting
the XML representation of SOAP Body payloadvoid setPayloadXML(java.lang.Object payload) throws org.apache.axiom.om.OMException, javax.script.ScriptException
payload
- Message payloadjavax.script.ScriptException
- For errors in converting xml To OMorg.apache.axiom.om.OMException
- For errors in OM manipulationjava.lang.Object getPayloadJSON()
java.lang.Object getJsonText()
java.lang.String getPayloadText()
boolean setJsonObject(org.apache.synapse.MessageContext messageContext, java.lang.Object jsonObject)
messageContext
- The message context of the sequencejsonObject
- JavaScript Object which is passed to be saved in message contextboolean setJsonText(org.apache.synapse.MessageContext messageContext, java.lang.Object jsonObject)
messageContext
- The message context of the sequencejsonObject
- JavaScript string which is passed to be saved in message contextjava.lang.Object jsonObject(org.apache.synapse.MessageContext messageContext)
void setScriptEngine(javax.script.ScriptEngine scriptEngine)
scriptEngine
- a ScriptEngine instancevoid addHeader(boolean mustUnderstand, java.lang.Object content) throws javax.script.ScriptException
mustUnderstand
- the value for the soapenv:mustUnderstand
attributecontent
- the XML for the new headerjavax.script.ScriptException
- if an error occurs when converting the XML to OMjava.lang.Object getEnvelopeXML() throws javax.script.ScriptException
javax.script.ScriptException
- in-case of an error in getting
the XML representation of SOAP envelopevoid setTo(java.lang.String reference)
reference
- specifies the receiver of the messagevoid setFaultTo(java.lang.String reference)
reference
- specifies the specifies the receiver of the faults relating to the messagevoid setFrom(java.lang.String reference)
reference
- specifies the sender of the messagevoid setReplyTo(java.lang.String reference)
reference
- specifies the receiver of the replies to the messagevoid setProperty(java.lang.String key, java.lang.Object value, java.lang.String scope)
key
- unique identifier of propertyvalue
- value of propertyscope
- scope of the propertyvoid removeProperty(java.lang.String key, java.lang.String scope)
key
- unique identifier of propertyscope
- scope of the propertyvoid setPayloadJSON(java.lang.Object jsonPayload) throws javax.script.ScriptException
jsonPayload
- Javascript native object to be set as the message bodyjavax.script.ScriptException
- in case of creating a JSON object out of
the javascript native object.Copyright © 2005-2020 Apache Software Foundation. All Rights Reserved.