/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.synapse.core.axis2;
import org.apache.axiom.om.OMAbstractFactory;
import org.apache.axiom.om.OMElement;
import org.apache.axiom.om.OMNamespace;
import org.apache.axiom.soap.SOAPBody;
import org.apache.axiom.soap.SOAPFactory;
import org.apache.axiom.util.UIDGenerator;
import org.apache.axis2.AxisFault;
import org.apache.axis2.Constants;
import org.apache.axis2.addressing.AddressingConstants;
import org.apache.axis2.addressing.AddressingHelper;
import org.apache.axis2.context.MessageContext;
import org.apache.axis2.engine.AxisEngine;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.synapse.SynapseConstants;
import org.apache.synapse.SynapseException;
import org.apache.synapse.SynapseHandler;
import org.apache.synapse.endpoints.EndpointDefinition;
import org.apache.synapse.inbound.InboundEndpointConstants;
import org.apache.synapse.inbound.InboundResponseSender;
import org.apache.synapse.transport.nhttp.NhttpConstants;
import org.apache.synapse.transport.passthru.util.RelayUtils;
import org.apache.synapse.util.MessageHelper;
import org.apache.synapse.util.POXUtils;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
/**
* This class helps the Axis2SynapseEnvironment implement the send method
*/
public class Axis2Sender {
private static final Log log = LogFactory.getLog(Axis2Sender.class);
/**
* Content type header name.
*/
private static final String CONTENT_TYPE_STRING = "Content-Type";
/**
* Send a message out from the Synapse engine to an external service
*
* @param endpoint the endpoint definition where the message should be sent
* @param synapseInMessageContext the Synapse message context
*/
public static void sendOn(EndpointDefinition endpoint,
org.apache.synapse.MessageContext synapseInMessageContext) {
try {
// Invoke Synapse Handlers
Iterator<SynapseHandler> iterator =
synapseInMessageContext.getEnvironment().getSynapseHandlers().iterator();
while (iterator.hasNext()) {
SynapseHandler handler = iterator.next();
if (!handler.handleRequestOutFlow(synapseInMessageContext)) {
return;
}
}
Axis2FlexibleMEPClient.send(
// The endpoint where we are sending to
endpoint,
// The Axis2 Message context of the Synapse MC
synapseInMessageContext);
} catch (Exception e) {
handleException("Unexpected error during sending message out", e);
}
}
/**
* Send a response back to a client of Synapse
*
* @param smc the Synapse message context sent as the response
*/
public static void sendBack(org.apache.synapse.MessageContext smc) {
Object responseStateObj = smc.getProperty(SynapseConstants.RESPONSE_STATE);
// Prevent two responses for a single request message
if (responseStateObj != null) {
if (responseStateObj instanceof ResponseState) {
ResponseState responseState = (ResponseState) responseStateObj;
synchronized (responseState) {
if (responseState.isRespondDone()) {
log.warn("Trying to send a response to an already responded client request - " +
getInputInfo(smc));
return;
} else {
responseState.setRespondDone();
}
}
} else {
// This can happen only if the user has used the SynapseConstants.RESPONSE_STATE as a user property
handleException("Response State must be of type : " + ResponseState.class +
". " + SynapseConstants.RESPONSE_STATE + " must not be used as an user property name", null);
}
}
MessageContext messageContext = ((Axis2MessageContext) smc).getAxis2MessageContext();
// if this is a dummy 202 Accepted message meant only for the http/s transports
// prevent it from going into any other transport sender
if (messageContext.isPropertyTrue(NhttpConstants.SC_ACCEPTED) &&
messageContext.getTransportOut() != null &&
!messageContext.getTransportOut().getName().startsWith(Constants.TRANSPORT_HTTP)) {
return;
}
// fault processing code
if (messageContext.isDoingREST() && messageContext.isFault() &&
isMessagePayloadHasASOAPFault(messageContext)) {
POXUtils.convertSOAPFaultToPOX(messageContext);
}
try {
messageContext.setProperty(SynapseConstants.ISRESPONSE_PROPERTY, Boolean.TRUE);
// check if addressing is already engaged for this message.
// if engaged we should use the addressing enabled Configuration context.
if (AddressingHelper.isReplyRedirected(messageContext) &&
!messageContext.getReplyTo().hasNoneAddress()) {
messageContext.setTo(messageContext.getReplyTo());
messageContext.setReplyTo(null);
messageContext.setWSAAction("");
messageContext.setSoapAction("");
messageContext.setProperty(
NhttpConstants.IGNORE_SC_ACCEPTED, Constants.VALUE_TRUE);
messageContext.setProperty(
AddressingConstants.DISABLE_ADDRESSING_FOR_OUT_MESSAGES, Boolean.FALSE);
}
if (messageContext.getEnvelope().hasFault() &&
AddressingHelper.isFaultRedirected(messageContext) &&
(messageContext.getFaultTo() == null || !messageContext.getFaultTo()
.hasNoneAddress())) {
messageContext.setTo(messageContext.getFaultTo());
messageContext.setFaultTo(null);
messageContext.setWSAAction("");
messageContext.setSoapAction("");
messageContext.setProperty(
NhttpConstants.IGNORE_SC_ACCEPTED, Constants.VALUE_TRUE);
messageContext.setProperty(
AddressingConstants.DISABLE_ADDRESSING_FOR_OUT_MESSAGES, Boolean.FALSE);
}
String preserveAddressingProperty = (String) smc.getProperty(
SynapseConstants.PRESERVE_WS_ADDRESSING);
if (preserveAddressingProperty != null &&
Boolean.parseBoolean(preserveAddressingProperty)) {
/*Avoiding duplicate addressing headers*/
messageContext.setProperty(AddressingConstants.REPLACE_ADDRESSING_HEADERS, "true");
messageContext.setMessageID(smc.getMessageID());
} else {
MessageHelper.removeAddressingHeaders(messageContext);
messageContext.setMessageID(UIDGenerator.generateURNString());
}
// determine weather we need to preserve the processed headers
String preserveHeaderProperty = (String) smc.getProperty(
SynapseConstants.PRESERVE_PROCESSED_HEADERS);
if (preserveHeaderProperty == null || !Boolean.parseBoolean(preserveHeaderProperty)) {
// remove the processed headers
MessageHelper.removeProcessedHeaders(messageContext,
(preserveAddressingProperty != null &&
Boolean.parseBoolean(preserveAddressingProperty))
);
}
// temporary workaround for https://issues.apache.org/jira/browse/WSCOMMONS-197
if (messageContext.isEngaged(SynapseConstants.SECURITY_MODULE_NAME) &&
messageContext.getEnvelope().getHeader() == null) {
SOAPFactory fac = messageContext.isSOAP11() ?
OMAbstractFactory.getSOAP11Factory() : OMAbstractFactory.getSOAP12Factory();
fac.createSOAPHeader(messageContext.getEnvelope());
}
Axis2FlexibleMEPClient.clearSecurtityProperties(messageContext.getOptions());
// Invoke Synapse Handlers
Iterator<SynapseHandler> iterator = smc.getEnvironment().getSynapseHandlers().iterator();
while (iterator.hasNext()) {
SynapseHandler handler = iterator.next();
if (!handler.handleResponseOutFlow(smc)) {
return;
}
}
doSOAPFormatConversion(smc);
// If the request arrives through an inbound endpoint
if (smc.getProperty(SynapseConstants.IS_INBOUND) != null
&& (Boolean) smc.getProperty(SynapseConstants.IS_INBOUND)) {
if (smc.getProperty(InboundEndpointConstants.INBOUND_ENDPOINT_RESPONSE_WORKER) != null) {
InboundResponseSender inboundResponseSender =
(InboundResponseSender) smc.getProperty(
InboundEndpointConstants.INBOUND_ENDPOINT_RESPONSE_WORKER);
inboundResponseSender.sendBack(smc);
} else {
String msg = "Inbound Response Sender not found -" +
" Inbound Endpoint may not support sending a response back";
log.error(msg);
throw new SynapseException(msg);
}
} else { // If the request arrives through a conventional transport listener
AxisEngine.send(messageContext);
}
} catch (AxisFault e) {
handleException(getResponseMessage(messageContext), e);
}
}
/**
* Check whether message body has a SOAPFault
*
* @param axis2Ctx axis2 message context
* @return whether message is a SOAPFault
*/
private static boolean isMessagePayloadHasASOAPFault(MessageContext axis2Ctx) {
SOAPBody body = axis2Ctx.getEnvelope().getBody();
if (body != null) {
OMElement element = body.getFirstElement();
if (element != null && "Fault".equalsIgnoreCase(element.getLocalName())) {
OMNamespace ns = element.getNamespace();
if (ns != null) {
String nsURI = ns.getNamespaceURI();
if ("http://schemas.xmlsoap.org/soap/envelope".equals(nsURI) ||
"http://schemas.xmlsoap.org/soap/envelope/".equals(nsURI) ||
"http://www.w3.org/2003/05/soap-envelope".equals(nsURI) ||
"http://www.w3.org/2003/05/soap-envelope/".equals(nsURI)) {
return true;
}
}
}
}
return false;
}
private static void handleException(String msg, Exception e) {
log.error(msg, e);
throw new SynapseException(msg, e);
}
private static String getResponseMessage(MessageContext msgContext) {
StringBuilder sb = new StringBuilder();
try {
String strEndpoint = (String) msgContext.getProperty(NhttpConstants.ENDPOINT_PREFIX);
if (strEndpoint != null) {
sb.append(strEndpoint + ", ");
}
Map<String, Object> mHeader = (Map<String, Object>) msgContext.getProperty
(org.apache.axis2.context.MessageContext.TRANSPORT_HEADERS);
if (mHeader != null) {
for (String strKey : mHeader.keySet()) {
sb.append(strKey + ":" + mHeader.get(strKey).toString() + ",");
}
}
sb.append(msgContext.getEnvelope().toString());
sb.append(" Unexpected error sending message back");
} catch (Exception e) {
sb.append(" Unexpected error sending message back");
}
return sb.toString();
}
/**
* Get the information of the input message context.
*
* @param smc Synapse message context
* */
private static String getInputInfo(org.apache.synapse.MessageContext smc) {
String inputInfo = null;
if (smc.getProperty("proxy.name") != null) {
inputInfo = "Proxy Name : " + smc.getProperty("proxy.name");
} else if (smc.getProperty("REST_API_CONTEXT") != null) {
inputInfo = "Rest API Context : " + smc.getProperty("REST_API_CONTEXT");
}
return inputInfo;
}
/**
* Convert the response SOAP format to the client format if it is required.
* @param synCtx response synapse message context
* @throws AxisFault
*/
private static void doSOAPFormatConversion(org.apache.synapse.MessageContext synCtx) throws AxisFault {
Object isClientDoingRest = synCtx.getProperty(SynapseConstants.IS_CLIENT_DOING_REST);
if (isClientDoingRest == null) {
return; // Request hasn't come through a Proxy or API or main sequence. So skip
}
if ((boolean) isClientDoingRest) {
return; // Skip the conversion for REST
}
Object isClientDoingSOAP11Obj = synCtx.getProperty(SynapseConstants.IS_CLIENT_DOING_SOAP11);
// Determine whether generated response is in SOAP11 format.
boolean isResponseSOAP11 = false;
MessageContext responseCtx = ((Axis2MessageContext) synCtx).getAxis2MessageContext();
Object headers = responseCtx.getProperty(org.apache.axis2.context.MessageContext.TRANSPORT_HEADERS);
if (headers != null && headers instanceof Map) {
Map headersMap = (Map) headers;
Object responseContentType = headersMap.get(CONTENT_TYPE_STRING);
if (responseContentType != null && responseContentType instanceof String) {
if (((String) responseContentType).trim().startsWith(SynapseConstants.SOAP11_CONTENT_TYPE) &&
!responseCtx.isDoingREST()) { // REST can also have text/xml
isResponseSOAP11 = true;
}
}
}
if ((Boolean) isClientDoingSOAP11Obj) { // If request is in SOAP11 format
if (isResponseSOAP11) { // Response is also in the SOAP11 format - no conversion required
return;
}
try { // Message need to be built prior to the conversion
RelayUtils.buildMessage(((Axis2MessageContext) synCtx).getAxis2MessageContext(), false);
} catch (Exception e) {
handleException("Error while building message", e);
}
if (!responseCtx.isSOAP11()) {
SOAPUtils.convertSOAP12toSOAP11(responseCtx);
}
responseCtx.setProperty(Constants.Configuration.MESSAGE_TYPE,
SynapseConstants.SOAP11_CONTENT_TYPE);
responseCtx.setProperty(Constants.Configuration.CONTENT_TYPE,
SynapseConstants.SOAP11_CONTENT_TYPE);
} else { // If request is in SOAP12 format
if (!isResponseSOAP11 && !responseCtx.isDoingREST()) { // Response is not SOAP11 not REST - it is in SOAP12
return;
}
try { // Message need to be built prior to the conversion
RelayUtils.buildMessage(((Axis2MessageContext) synCtx).getAxis2MessageContext(), false);
} catch (Exception e) {
handleException("Error while building message", e);
}
if (responseCtx.isSOAP11()) { // If response is in SOAP11
SOAPUtils.convertSOAP11toSOAP12(responseCtx);
}
responseCtx.setProperty(Constants.Configuration.MESSAGE_TYPE,
SynapseConstants.SOAP12_CONTENT_TYPE);
responseCtx.setProperty(Constants.Configuration.CONTENT_TYPE,
SynapseConstants.SOAP12_CONTENT_TYPE);
}
responseCtx.setDoingREST(false);
}
}