/**
* Handle the response or error (during a failed send) message received for an outgoing request
*
* @param messageID Request message ID
* @param response the Axis2 MessageContext that has been received and has to be handled
* @param synapseOutMsgCtx the corresponding (outgoing) Synapse MessageContext for the above Axis2
* MC, that holds Synapse specific information such as the error handler stack and local
* properties etc.
* @throws AxisFault if the message cannot be processed
*/
private void handleMessage(
String messageID,
MessageContext response,
org.apache.synapse.MessageContext synapseOutMsgCtx,
AsyncCallback callback)
throws AxisFault {
// apply the tenant information to the out message context
TenantInfoConfigurator configurator =
synapseOutMsgCtx.getEnvironment().getTenantInfoConfigurator();
if (configurator != null) {
configurator.applyTenantInfo(synapseOutMsgCtx);
}
Object o = response.getProperty(SynapseConstants.SENDING_FAULT);
if (o != null && Boolean.TRUE.equals(o)) {
StatisticsReporter.reportFaultForAll(
synapseOutMsgCtx, ErrorLogFactory.createErrorLog(response));
// there is a sending fault. propagate the fault to fault handlers.
Stack faultStack = synapseOutMsgCtx.getFaultStack();
if (faultStack != null && !faultStack.isEmpty()) {
// if we have access to the full synapseOutMsgCtx.getEnvelope(), then let
// it flow with the error details. Else, replace its envelope with the
// fault envelope
try {
synapseOutMsgCtx.getEnvelope().build();
} catch (OMException x) {
synapseOutMsgCtx.setEnvelope(response.getEnvelope());
}
Exception e = (Exception) response.getProperty(SynapseConstants.ERROR_EXCEPTION);
synapseOutMsgCtx.setProperty(SynapseConstants.SENDING_FAULT, Boolean.TRUE);
synapseOutMsgCtx.setProperty(
SynapseConstants.ERROR_CODE, response.getProperty(SynapseConstants.ERROR_CODE));
synapseOutMsgCtx.setProperty(
SynapseConstants.ERROR_MESSAGE, response.getProperty(SynapseConstants.ERROR_MESSAGE));
synapseOutMsgCtx.setProperty(
SynapseConstants.ERROR_DETAIL, response.getProperty(SynapseConstants.ERROR_DETAIL));
synapseOutMsgCtx.setProperty(SynapseConstants.ERROR_EXCEPTION, e);
if (log.isDebugEnabled()) {
log.debug(
"[Failed Request Message ID : "
+ messageID
+ "]"
+ " [New to be Retried Request Message ID : "
+ synapseOutMsgCtx.getMessageID()
+ "]");
}
int errorCode = (Integer) response.getProperty(SynapseConstants.ERROR_CODE);
// If a timeout has occured and the timeout action of the callback is to discard the message
if (errorCode == SynapseConstants.NHTTP_CONNECTION_TIMEOUT
&& callback.getTimeOutAction() == SynapseConstants.DISCARD) {
// Do not execute any fault sequences. Discard message
if (log.isWarnEnabled()) {
log.warn(
"Synapse timed out for the request with Message ID : "
+ messageID
+ ". Ignoring fault handlers since the timeout action is DISCARD");
}
faultStack.removeAllElements();
} else {
((FaultHandler) faultStack.pop()).handleFault(synapseOutMsgCtx, null);
}
}
} else {
// there can always be only one instance of an Endpoint in the faultStack of a message
// if the send was successful, so remove it before we proceed any further
Stack faultStack = synapseOutMsgCtx.getFaultStack();
Endpoint successfulEndpoint = null;
if (faultStack != null && !faultStack.isEmpty() && faultStack.peek() instanceof Endpoint) {
successfulEndpoint = (Endpoint) faultStack.pop();
}
if (log.isDebugEnabled()) {
log.debug("Synapse received an asynchronous response message");
log.debug(
"Received To: " + (response.getTo() != null ? response.getTo().getAddress() : "null"));
log.debug(
"SOAPAction: "
+ (response.getSoapAction() != null ? response.getSoapAction() : "null"));
log.debug(
"WSA-Action: " + (response.getWSAAction() != null ? response.getWSAAction() : "null"));
String[] cids = response.getAttachmentMap().getAllContentIDs();
if (cids != null && cids.length > 0) {
for (String cid : cids) {
log.debug("Attachment : " + cid);
}
}
log.debug("Body : \n" + response.getEnvelope());
}
MessageContext axisOutMsgCtx =
((Axis2MessageContext) synapseOutMsgCtx).getAxis2MessageContext();
// Processes 'Accept-Encoding'
ResponseAcceptEncodingProcessor.process(response, axisOutMsgCtx);
response.setServiceContext(null);
response.setOperationContext(axisOutMsgCtx.getOperationContext());
response.setAxisMessage(
axisOutMsgCtx.getAxisOperation().getMessage(WSDLConstants.MESSAGE_LABEL_OUT_VALUE));
// set properties on response
response.setServerSide(true);
response.setProperty(SynapseConstants.ISRESPONSE_PROPERTY, Boolean.TRUE);
response.setProperty(
MessageContext.TRANSPORT_OUT, axisOutMsgCtx.getProperty(MessageContext.TRANSPORT_OUT));
response.setProperty(
org.apache.axis2.Constants.OUT_TRANSPORT_INFO,
axisOutMsgCtx.getProperty(org.apache.axis2.Constants.OUT_TRANSPORT_INFO));
response.setTransportIn(axisOutMsgCtx.getTransportIn());
response.setTransportOut(axisOutMsgCtx.getTransportOut());
// If request is REST assume that the response is REST too
response.setDoingREST(axisOutMsgCtx.isDoingREST());
if (axisOutMsgCtx.isDoingMTOM()) {
response.setDoingMTOM(true);
response.setProperty(
org.apache.axis2.Constants.Configuration.ENABLE_MTOM,
org.apache.axis2.Constants.VALUE_TRUE);
}
if (axisOutMsgCtx.isDoingSwA()) {
response.setDoingSwA(true);
response.setProperty(
org.apache.axis2.Constants.Configuration.ENABLE_SWA,
org.apache.axis2.Constants.VALUE_TRUE);
}
// when axis2 receives a soap message without addressing headers it users
// DISABLE_ADDRESSING_FOR_OUT_MESSAGES property to keep it and hence avoid addressing
// headers on the response. this causes a problem for synapse if the original message
// it receivs (from client) has addressing and the synaspse service invocation has not
// engage addressing. in this case when synapse receives the response from the server
// addessing In handler dissable addressing since that response does not have addressing
// headers. synapse sends the response to its orignal client using the same message
// context. Then this response does not have addressing headers since it already
// disable. to avoid this we need to set the DISABLE_ADDRESSING_FOR_OUT_MESSAGES
// property state to original state.
if (axisOutMsgCtx.getProperty(AddressingConstants.DISABLE_ADDRESSING_FOR_OUT_MESSAGES)
!= null) {
response.setProperty(
AddressingConstants.DISABLE_ADDRESSING_FOR_OUT_MESSAGES,
axisOutMsgCtx.getProperty(AddressingConstants.DISABLE_ADDRESSING_FOR_OUT_MESSAGES));
} else {
response.removeProperty(AddressingConstants.DISABLE_ADDRESSING_FOR_OUT_MESSAGES);
}
Object messageType =
axisOutMsgCtx.getProperty(org.apache.axis2.Constants.Configuration.MESSAGE_TYPE);
if (!HTTPConstants.MEDIA_TYPE_X_WWW_FORM.equals(messageType)) {
// copy the message type property that's used by the out message to the
// response message
response.setProperty(org.apache.axis2.Constants.Configuration.MESSAGE_TYPE, messageType);
}
// compare original received message (axisOutMsgCtx) soap version with the response
// if they are different change to original version
if (axisOutMsgCtx.isSOAP11() != response.isSOAP11()) {
if (axisOutMsgCtx.isSOAP11()) {
SOAPUtils.convertSOAP12toSOAP11(response);
} else {
SOAPUtils.convertSOAP11toSOAP12(response);
}
}
if (axisOutMsgCtx.getMessageID() != null) {
response.setRelationships(new RelatesTo[] {new RelatesTo(axisOutMsgCtx.getMessageID())});
}
response.setReplyTo(axisOutMsgCtx.getReplyTo());
response.setFaultTo(axisOutMsgCtx.getFaultTo());
if (axisOutMsgCtx.isPropertyTrue(NhttpConstants.IGNORE_SC_ACCEPTED)) {
response.setProperty(NhttpConstants.FORCE_SC_ACCEPTED, Constants.VALUE_TRUE);
}
// create the synapse message context for the response
Axis2MessageContext synapseInMessageContext =
new Axis2MessageContext(
response, synapseOutMsgCtx.getConfiguration(), synapseOutMsgCtx.getEnvironment());
synapseInMessageContext.setResponse(true);
Object obj = synapseOutMsgCtx.getProperty(SynapseConstants.FORCE_ERROR_PROPERTY);
String errorOnSOAPFault = (String) obj;
if (Constants.VALUE_TRUE.equals(errorOnSOAPFault) && successfulEndpoint != null) {
if (log.isDebugEnabled()) {
log.debug("FORCE_ERROR_ON_SOAP_FAULT is true, checking for SOAPFault");
}
try {
RelayUtils.buildMessage(
((Axis2MessageContext) synapseInMessageContext).getAxis2MessageContext(), true);
} catch (Exception e) {
// handleException("Error while building message", e, synapseInMessageContext);
}
if ((synapseInMessageContext.getEnvelope() != null)
&& synapseInMessageContext.getEnvelope().hasFault()) {
if (log.isDebugEnabled()) {
log.debug(
"SOAPFault found in response message, forcing endpoint "
+ successfulEndpoint.getName()
+ " to fail");
}
// setup new pipe configuration..if failure happens (this will be setup as the source
// writer and during the TargetContext
// clean up operation the writer will be reset and pull to the buffer
MessageContext axis2OUTMC =
((Axis2MessageContext) synapseOutMsgCtx).getAxis2MessageContext();
NHttpServerConnection conn =
(NHttpServerConnection) axis2OUTMC.getProperty("pass-through.Source-Connection");
if (conn != null) {
SourceConfiguration sourceConfiguration =
(SourceConfiguration) axis2OUTMC.getProperty("PASS_THROUGH_SOURCE_CONFIGURATION");
Pipe pipe =
new Pipe(
conn,
sourceConfiguration.getBufferFactory().getBuffer(),
"source",
sourceConfiguration);
axis2OUTMC.setProperty(PassThroughConstants.PASS_THROUGH_PIPE, pipe);
}
StatisticsReporter.reportFaultForAll(
synapseOutMsgCtx, ErrorLogFactory.createErrorLog(response));
synapseOutMsgCtx.setProperty(SynapseConstants.SENDING_FAULT, Boolean.TRUE);
synapseOutMsgCtx.setProperty(
SynapseConstants.ERROR_CODE, SynapseConstants.ENDPOINT_CUSTOM_ERROR);
((FaultHandler) successfulEndpoint).handleFault(synapseOutMsgCtx, null);
return;
} else {
successfulEndpoint.onSuccess();
}
} else if (successfulEndpoint != null) {
successfulEndpoint.onSuccess();
}
synapseInMessageContext.setTo(
new EndpointReference(AddressingConstants.Final.WSA_ANONYMOUS_URL));
synapseInMessageContext.setTracingState(synapseOutMsgCtx.getTracingState());
// set the properties of the original MC to the new MC
for (Object key : synapseOutMsgCtx.getPropertyKeySet()) {
synapseInMessageContext.setProperty(
(String) key, synapseOutMsgCtx.getProperty((String) key));
}
// Copy SequenceCallStack from original MC to the new MC
if (synapseOutMsgCtx.isContinuationEnabled()) {
// Set the message direction
if (!synapseOutMsgCtx.isResponse()) {
synapseInMessageContext.setResponse(false);
}
Stack<ContinuationState> seqContinuationStates =
synapseOutMsgCtx.getContinuationStateStack();
for (int i = 0; i < seqContinuationStates.size(); i++) {
synapseInMessageContext.pushContinuationState(seqContinuationStates.get(i));
}
}
// If this response is related to session affinity endpoints -Server initiated session
Dispatcher dispatcher =
(Dispatcher)
synapseOutMsgCtx.getProperty(SynapseConstants.PROP_SAL_ENDPOINT_CURRENT_DISPATCHER);
if (dispatcher != null && dispatcher.isServerInitiatedSession()) {
dispatcher.updateSession(synapseInMessageContext);
}
StatisticsReporter.reportForAllOnResponseReceived(synapseInMessageContext);
// send the response message through the synapse mediation flow
try {
synapseOutMsgCtx.getEnvironment().injectMessage(synapseInMessageContext);
} catch (SynapseException syne) {
Stack stack = synapseInMessageContext.getFaultStack();
if (stack != null && !stack.isEmpty()) {
((FaultHandler) stack.pop()).handleFault(synapseInMessageContext, syne);
} else {
log.error(
"Synapse encountered an exception, "
+ "No error handlers found - [Message Dropped]\n"
+ syne.getMessage());
}
}
}
}
/** Process the incoming request */
@SuppressWarnings({"unchecked"})
public void run() {
String method = request.getRequestLine().getMethod().toUpperCase();
msgContext.setProperty(
Constants.Configuration.HTTP_METHOD, request.getRequestLine().getMethod());
if (NHttpConfiguration.getInstance().isHttpMethodDisabled(method)) {
handleException("Unsupported method : " + method, null);
}
// String uri = request.getRequestLine().getUri();
String oriUri = request.getRequestLine().getUri();
String restUrlPostfix = NhttpUtil.getRestUrlPostfix(oriUri, cfgCtx.getServicePath());
msgContext.setProperty(NhttpConstants.REST_URL_POSTFIX, restUrlPostfix);
String servicePrefix = oriUri.substring(0, oriUri.indexOf(restUrlPostfix));
if (servicePrefix.indexOf("://") == -1) {
HttpInetConnection inetConn = (HttpInetConnection) conn;
InetAddress localAddr = inetConn.getLocalAddress();
if (localAddr != null) {
servicePrefix =
schemeName
+ "://"
+ localAddr.getHostName()
+ ":"
+ inetConn.getLocalPort()
+ servicePrefix;
}
if (inetConn.getLocalPort() > 0) {
msgContext.setProperty(NhttpConstants.SERVER_PORT, inetConn.getLocalPort());
}
}
msgContext.setProperty(NhttpConstants.SERVICE_PREFIX, servicePrefix);
if ("GET".equals(method)) {
httpGetRequestProcessor.process(request, response, msgContext, conn, os, isRestDispatching);
} else if ("POST".equals(method)) {
processEntityEnclosingMethod();
} else if ("PUT".equals(method)) {
processEntityEnclosingMethod();
} else if ("HEAD".equals(method)) {
processNonEntityEnclosingMethod();
} else if ("OPTIONS".equals(method)) {
processNonEntityEnclosingMethod();
} else if ("DELETE".equals(method)) {
processGetAndDelete("DELETE");
} else if ("TRACE".equals(method)) {
processNonEntityEnclosingMethod();
} else {
handleException("Unsupported method : " + method, null);
}
// here the RequestResponseTransport plays an important role when it comes to
// dual channel invocation. This is becasue we need to ACK to the request once the request
// is received to synapse. Otherwise we will not be able to support the single channel
// invocation within the actual service and synapse for a dual channel request from the
// client.
if (isAckRequired()) {
String respWritten = "";
if (msgContext.getOperationContext() != null) {
respWritten =
(String) msgContext.getOperationContext().getProperty(Constants.RESPONSE_WRITTEN);
}
boolean respWillFollow =
!Constants.VALUE_TRUE.equals(respWritten) && !"SKIP".equals(respWritten);
boolean acked =
(((RequestResponseTransport)
msgContext.getProperty(RequestResponseTransport.TRANSPORT_CONTROL))
.getStatus()
== RequestResponseTransport.RequestResponseTransportStatus.ACKED);
boolean forced = msgContext.isPropertyTrue(NhttpConstants.FORCE_SC_ACCEPTED);
boolean nioAck = msgContext.isPropertyTrue("NIO-ACK-Requested", false);
if (respWillFollow || acked || forced || nioAck) {
if (!nioAck) {
if (log.isDebugEnabled()) {
log.debug(
"Sending 202 Accepted response for MessageID : "
+ msgContext.getMessageID()
+ " response written : "
+ respWritten
+ " response will follow : "
+ respWillFollow
+ " acked : "
+ acked
+ " forced ack : "
+ forced);
}
response.setStatusCode(HttpStatus.SC_ACCEPTED);
} else {
if (log.isDebugEnabled()) {
log.debug(
"Sending ACK response with status "
+ msgContext.getProperty(NhttpConstants.HTTP_SC)
+ ", for MessageID : "
+ msgContext.getMessageID());
}
response.setStatusCode(
Integer.parseInt(msgContext.getProperty(NhttpConstants.HTTP_SC).toString()));
Map<String, String> responseHeaders =
(Map<String, String>) msgContext.getProperty(MessageContext.TRANSPORT_HEADERS);
if (responseHeaders != null) {
for (String headerName : responseHeaders.keySet()) {
response.addHeader(headerName, responseHeaders.get(headerName));
String excessProp = NhttpConstants.EXCESS_TRANSPORT_HEADERS;
Map map = (Map) msgContext.getProperty(excessProp);
if (map != null) {
log.debug(
"Number of excess values for "
+ headerName
+ " header is : "
+ ((Collection) (map.get(headerName))).size());
for (Iterator iterator = map.keySet().iterator(); iterator.hasNext(); ) {
String key = (String) iterator.next();
for (String excessVal : (Collection<String>) map.get(key)) {
response.addHeader(headerName, (String) excessVal);
}
}
}
}
}
}
if (metrics != null) {
metrics.incrementMessagesSent();
}
try {
/*
* Remove Content-Length and Transfer-Encoding headers, if already present.
* */
response.removeHeaders(HTTP.TRANSFER_ENCODING);
response.removeHeaders(HTTP.CONTENT_LEN);
serverHandler.commitResponse(conn, response);
} catch (HttpException e) {
if (metrics != null) {
metrics.incrementFaultsSending();
}
handleException("Unexpected HTTP protocol error : " + e.getMessage(), e);
} catch (ConnectionClosedException e) {
if (metrics != null) {
metrics.incrementFaultsSending();
}
log.warn("Connection closed by client (Connection closed)");
} catch (IllegalStateException e) {
if (metrics != null) {
metrics.incrementFaultsSending();
}
log.warn("Connection closed by client (Buffer closed)");
} catch (IOException e) {
if (metrics != null) {
metrics.incrementFaultsSending();
}
handleException("IO Error sending response message", e);
} catch (Exception e) {
if (metrics != null) {
metrics.incrementFaultsSending();
}
handleException("General Error sending response message", e);
}
if (is != null) {
try {
is.close();
} catch (IOException ignore) {
}
}
// make sure that the output stream is flushed and closed properly
try {
os.flush();
os.close();
} catch (IOException ignore) {
}
}
}
}
