Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add command to inject payload in debugger #2314

Merged
merged 1 commit into from
Jan 29, 2025
Merged

Add command to inject payload in debugger #2314

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 67 additions & 0 deletions modules/core/src/main/java/org/apache/synapse/debug/SynapseDebugManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,25 @@

package org.apache.synapse.debug;

import org.apache.axiom.om.OMAbstractFactory;
import org.apache.axiom.om.OMElement;
import org.apache.axiom.om.OMException;
import org.apache.axiom.om.OMFactory;
import org.apache.axiom.om.impl.builder.StAXBuilder;
import org.apache.axiom.om.impl.builder.StAXOMBuilder;
import org.apache.axiom.soap.SOAP11Constants;
import org.apache.axiom.soap.SOAP12Constants;
import org.apache.axiom.soap.SOAPEnvelope;
import org.apache.axiom.soap.SOAPHeader;
import org.apache.axiom.soap.SOAPHeaderBlock;
import org.apache.axis2.AxisFault;
import org.apache.axis2.addressing.EndpointReference;
import org.apache.commons.io.IOUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.http.protocol.HTTP;
import org.apache.synapse.MessageContext;
import org.apache.synapse.SynapseConstants;
import org.apache.synapse.commons.json.JsonUtil;
import org.apache.synapse.config.SynapseConfiguration;
import org.apache.synapse.core.SynapseEnvironment;
Expand All @@ -46,12 +56,14 @@
import org.apache.synapse.transport.http.conn.SynapseBackEndWireLogs;
import org.apache.synapse.transport.http.conn.SynapseDebugInfoHolder;
import org.apache.synapse.transport.http.conn.SynapseWireLogHolder;
import org.apache.synapse.util.AXIOMUtils;
import org.codehaus.jettison.json.JSONArray;
import org.codehaus.jettison.json.JSONException;
import org.codehaus.jettison.json.JSONObject;

import java.io.IOException;
import java.io.InputStream;
import java.io.StringReader;
import java.io.StringWriter;
import java.util.HashMap;
import java.util.HashSet;
Expand All @@ -63,6 +75,10 @@
import java.util.concurrent.Semaphore;
import java.util.concurrent.locks.ReentrantLock;

import javax.xml.namespace.QName;
import javax.xml.stream.XMLInputFactory;
import javax.xml.stream.XMLStreamException;

/**
* Main class that integrates mediation debugging capabilities to Synapse Engine, Debug Manager
* single instance is created to handle debugging centrally, by either persisting or retrieving
Expand All @@ -71,6 +87,7 @@
*/
public class SynapseDebugManager implements Observer {
private static final java.lang.String METHOD_ARRAY_SEPERATOR = ",";
private static final QName TEXT_ELEMENT = new QName("http://ws.apache.org/commons/ns/payload", "text");
private static final String EMPTY_STRING = "";
/* to ensure a single mediation flow at a given time */
private static volatile ReentrantLock mediationFlowLock;
Expand All @@ -86,6 +103,9 @@ public class SynapseDebugManager implements Observer {
private boolean initialised = false;
private static final Log log = LogFactory.getLog(SynapseDebugManager.class);
private Map addedPropertyValuesMap;
private final XMLInputFactory inputFactory = XMLInputFactory.newInstance();
private static final String JSON_CONTENT_TYPE = "application/json";
private static final String TEXT_CONTENT_TYPE = "text/plain";

protected SynapseDebugManager() {
mediationFlowLock = new ReentrantLock();
Expand Down Expand Up @@ -1233,6 +1253,9 @@ public void addMediationFlowPointProperty(String propertyContext, JSONObject pro
&& synCtx instanceof Axis2MessageContext) {
Axis2MessageContext axis2smc = (Axis2MessageContext) synCtx;
axis2smc.getAxis2MessageContext().getOperationContext().setProperty(propertyKey, propertyValue);
} else if (propertyContext.equals(SynapseDebugCommandConstants.AXIS2_PROPERTY_ENVELOPE) &&
synCtx instanceof Axis2MessageContext) {
setEnvelope(propertyValue, synCtx);
}
} else {
if (propertyContext == null || SynapseDebugCommandConstants.DEBUG_COMMAND_PROPERTY_CONTEXT_DEFAULT
Expand Down Expand Up @@ -1283,6 +1306,50 @@ public void addMediationFlowPointProperty(String propertyContext, JSONObject pro
this.advertiseCommandResponse(createDebugCommandResponse(true, null).toString());
}

private void setEnvelope(String propertyValue, MessageContext synCtx) {

String mediaType = (String) ((Axis2MessageContext) synCtx).getAxis2MessageContext()
.getProperty(SynapseConstants.AXIS2_PROPERTY_CONTENT_TYPE);
org.apache.axis2.context.MessageContext axis2MessageContext =
((Axis2MessageContext) synCtx).getAxis2MessageContext();
if (SynapseConstants.XML_CONTENT_TYPE.equals(mediaType)) {
try {
JsonUtil.removeJsonPayload(axis2MessageContext);
OMElement omXML = convertStringToOM(propertyValue);
axis2MessageContext.getEnvelope().getBody().addChild(omXML);
} catch (XMLStreamException e) {
log.error("Error creating SOAP Envelope from source " + propertyValue, e);
}
} else if (JSON_CONTENT_TYPE.equals(mediaType)) {
try {
JsonUtil.getNewJsonPayload(axis2MessageContext, propertyValue, true, true);
} catch (AxisFault axisFault) {
log.error("Error creating JSON Payload from source " + propertyValue, axisFault);
}
} else if (TEXT_CONTENT_TYPE.equals(mediaType)) {
JsonUtil.removeJsonPayload(axis2MessageContext);
axis2MessageContext.getEnvelope().getBody().addChild(getTextElement(propertyValue));
}
}

private OMElement getTextElement(String content) {

OMFactory factory = OMAbstractFactory.getOMFactory();
OMElement textElement = factory.createOMElement(TEXT_ELEMENT);
if (content == null) {
content = "";
}
textElement.setText(content);
return textElement;
}

private OMElement convertStringToOM(String value) throws XMLStreamException, OMException {

javax.xml.stream.XMLStreamReader xmlReader = inputFactory.createXMLStreamReader(new StringReader(value));
StAXBuilder builder = new StAXOMBuilder(xmlReader);
return builder.getDocumentElement();
}

private void setAxis2Property(String propertyKey, String propertyValue,
org.apache.axis2.context.MessageContext axis2MessageCtx) {
//Do not change the Envelope, SoapHeaders and Transport Headers
Expand Down
Loading