/*
* Copyright 2006-2010 the original author or authors.
*
* Licensed 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 com.consol.citrus.ws.server;
import com.consol.citrus.endpoint.EndpointAdapter;
import com.consol.citrus.endpoint.adapter.EmptyResponseEndpointAdapter;
import com.consol.citrus.exceptions.CitrusRuntimeException;
import com.consol.citrus.message.*;
import com.consol.citrus.ws.client.WebServiceEndpointConfiguration;
import com.consol.citrus.ws.message.SoapFault;
import com.consol.citrus.ws.message.SoapMessageHeaders;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.util.*;
import org.springframework.ws.context.MessageContext;
import org.springframework.ws.server.endpoint.MessageEndpoint;
import org.springframework.ws.soap.*;
import org.springframework.ws.soap.axiom.AxiomSoapMessage;
import org.springframework.ws.soap.saaj.SaajSoapMessage;
import org.springframework.ws.soap.server.endpoint.SoapFaultDefinition;
import org.springframework.ws.soap.soap11.Soap11Body;
import org.springframework.ws.soap.soap12.Soap12Body;
import org.springframework.ws.soap.soap12.Soap12Fault;
import org.springframework.ws.transport.WebServiceConnection;
import org.springframework.ws.transport.context.TransportContextHolder;
import org.springframework.ws.transport.http.HttpServletConnection;
import org.springframework.xml.namespace.QNameUtils;
import org.springframework.xml.transform.StringSource;
import org.w3c.dom.Document;
import javax.xml.namespace.QName;
import javax.xml.soap.MimeHeaders;
import javax.xml.transform.*;
import javax.xml.transform.dom.DOMSource;
import java.io.IOException;
import java.util.List;
import java.util.Map.Entry;
/**
* SpringWS {@link MessageEndpoint} implementation. Endpoint will delegate message processing to
* a {@link EndpointAdapter} implementation.
*
* @author Christoph Deppisch
*/
public class WebServiceEndpoint implements MessageEndpoint {
/** EndpointAdapter handling incoming requests and providing proper responses */
private EndpointAdapter endpointAdapter = new EmptyResponseEndpointAdapter();
/** Default namespace for all SOAP header entries */
private String defaultNamespaceUri;
/** Default prefix for all SOAP header entries */
private String defaultPrefix = "";
/** Endpoint configuration */
private WebServiceEndpointConfiguration endpointConfiguration = new WebServiceEndpointConfiguration();
/** Logger */
private static Logger log = LoggerFactory.getLogger(WebServiceEndpoint.class);
/** JMS headers begin with this prefix */
private static final String DEFAULT_JMS_HEADER_PREFIX = "JMS";
/**
* @see org.springframework.ws.server.endpoint.MessageEndpoint#invoke(org.springframework.ws.context.MessageContext)
* @throws CitrusRuntimeException
*/
public void invoke(final MessageContext messageContext) throws Exception {
Assert.notNull(messageContext.getRequest(), "Request must not be null - unable to send message");
Message requestMessage = endpointConfiguration.getMessageConverter().convertInbound(messageContext.getRequest(), messageContext, endpointConfiguration);
log.info("Received SOAP request:\n" + requestMessage.toString());
//delegate request processing to endpoint adapter
Message replyMessage = endpointAdapter.handleMessage(requestMessage);
if (simulateHttpStatusCode(replyMessage)) {
return;
}
if (replyMessage != null && replyMessage.getPayload() != null) {
log.info("Sending SOAP response:\n" + replyMessage.toString());
SoapMessage response = (SoapMessage) messageContext.getResponse();
//add soap fault or normal soap body to response
if (replyMessage instanceof SoapFault) {
addSoapFault(response, (SoapFault) replyMessage);
} else {
addSoapBody(response, replyMessage);
}
addSoapHeaders(response, replyMessage);
addMimeHeaders(response, replyMessage);
} else {
log.info("No reply message from endpoint adapter '" + endpointAdapter + "'");
log.warn("No SOAP response for calling client");
}
}
/**
* If Http status code is set on reply message headers simulate Http error with status code.
* No SOAP response is sent back in this case.
* @param replyMessage
* @return
* @throws IOException
*/
private boolean simulateHttpStatusCode(Message replyMessage) throws IOException {
if (replyMessage == null || CollectionUtils.isEmpty(replyMessage.copyHeaders())) {
return false;
}
for (Entry<String, Object> headerEntry : replyMessage.copyHeaders().entrySet()) {
if (headerEntry.getKey().equalsIgnoreCase(SoapMessageHeaders.HTTP_STATUS_CODE)) {
WebServiceConnection connection = TransportContextHolder.getTransportContext().getConnection();
int statusCode = Integer.valueOf(headerEntry.getValue().toString());
if (connection instanceof HttpServletConnection) {
((HttpServletConnection)connection).setFault(false);
((HttpServletConnection)connection).getHttpServletResponse().setStatus(statusCode);
return true;
} else {
log.warn("Unable to set custom Http status code on connection other than HttpServletConnection (" + connection.getClass().getName() + ")");
}
}
}
return false;
}
/**
* Adds mime headers outside of SOAP envelope. Header entries that go to this header section
* must have internal http header prefix defined in {@link com.consol.citrus.ws.message.SoapMessageHeaders}.
* @param response the soap response message.
* @param replyMessage the internal reply message.
*/
private void addMimeHeaders(SoapMessage response, Message replyMessage) {
for (Entry<String, Object> headerEntry : replyMessage.copyHeaders().entrySet()) {
if (headerEntry.getKey().toLowerCase().startsWith(SoapMessageHeaders.HTTP_PREFIX)) {
String headerName = headerEntry.getKey().substring(SoapMessageHeaders.HTTP_PREFIX.length());
if (response instanceof SaajSoapMessage) {
SaajSoapMessage saajSoapMessage = (SaajSoapMessage) response;
MimeHeaders headers = saajSoapMessage.getSaajMessage().getMimeHeaders();
headers.setHeader(headerName, headerEntry.getValue().toString());
} else if (response instanceof AxiomSoapMessage) {
log.warn("Unable to set mime message header '" + headerName + "' on AxiomSoapMessage - unsupported");
} else {
log.warn("Unsupported SOAP message implementation - unable to set mime message header '" + headerName + "'");
}
}
}
}
/**
* Add message payload as SOAP body element to the SOAP response.
* @param response
* @param replyMessage
*/
private void addSoapBody(SoapMessage response, Message replyMessage) throws TransformerException {
if (!(replyMessage.getPayload() instanceof String) ||
StringUtils.hasText(replyMessage.getPayload().toString())) {
Source responseSource = getPayloadAsSource(replyMessage.getPayload());
TransformerFactory transformerFactory = TransformerFactory.newInstance();
Transformer transformer = transformerFactory.newTransformer();
transformer.transform(responseSource, response.getPayloadResult());
}
}
/**
* Translates message headers to SOAP headers in response.
* @param response
* @param replyMessage
*/
private void addSoapHeaders(SoapMessage response, Message replyMessage) throws TransformerException {
for (Entry<String, Object> headerEntry : replyMessage.copyHeaders().entrySet()) {
if (MessageHeaderUtils.isSpringInternalHeader(headerEntry.getKey()) ||
headerEntry.getKey().startsWith(DEFAULT_JMS_HEADER_PREFIX)) {
continue;
}
if (headerEntry.getKey().equalsIgnoreCase(SoapMessageHeaders.SOAP_ACTION)) {
response.setSoapAction(headerEntry.getValue().toString());
} else if (!headerEntry.getKey().startsWith(MessageHeaders.PREFIX)) {
SoapHeaderElement headerElement;
if (QNameUtils.validateQName(headerEntry.getKey())) {
QName qname = QNameUtils.parseQNameString(headerEntry.getKey());
if (StringUtils.hasText(qname.getNamespaceURI())) {
headerElement = response.getSoapHeader().addHeaderElement(qname);
} else {
headerElement = response.getSoapHeader().addHeaderElement(getDefaultQName(headerEntry.getKey()));
}
} else {
throw new SoapHeaderException("Failed to add SOAP header '" + headerEntry.getKey() + "', " +
"because of invalid QName");
}
headerElement.setText(headerEntry.getValue().toString());
}
}
for (String headerData : replyMessage.getHeaderData()) {
TransformerFactory transformerFactory = TransformerFactory.newInstance();
Transformer transformer = transformerFactory.newTransformer();
transformer.transform(new StringSource(headerData),
response.getSoapHeader().getResult());
}
}
/**
* Adds a SOAP fault to the SOAP response body. The SOAP fault is declared
* as QName string in the response message's header (see {@link com.consol.citrus.ws.message.SoapMessageHeaders})
*
* @param response
* @param replyMessage
*/
private void addSoapFault(SoapMessage response, SoapFault replyMessage) throws TransformerException {
SoapBody soapBody = response.getSoapBody();
org.springframework.ws.soap.SoapFault soapFault;
if (SoapFaultDefinition.SERVER.equals(replyMessage.getFaultCodeQName()) ||
SoapFaultDefinition.RECEIVER.equals(replyMessage.getFaultCodeQName())) {
soapFault = soapBody.addServerOrReceiverFault(replyMessage.getFaultString(),
replyMessage.getLocale());
} else if (SoapFaultDefinition.CLIENT.equals(replyMessage.getFaultCodeQName()) ||
SoapFaultDefinition.SENDER.equals(replyMessage.getFaultCodeQName())) {
soapFault = soapBody.addClientOrSenderFault(replyMessage.getFaultString(),
replyMessage.getLocale());
} else if (soapBody instanceof Soap11Body) {
Soap11Body soap11Body = (Soap11Body) soapBody;
soapFault = soap11Body.addFault(replyMessage.getFaultCodeQName(),
replyMessage.getFaultString(),
replyMessage.getLocale());
} else if (soapBody instanceof Soap12Body) {
Soap12Body soap12Body = (Soap12Body) soapBody;
Soap12Fault soap12Fault = soap12Body.addServerOrReceiverFault(replyMessage.getFaultString(),
replyMessage.getLocale());
soap12Fault.addFaultSubcode(replyMessage.getFaultCodeQName());
soapFault = soap12Fault;
} else {
throw new CitrusRuntimeException("Found unsupported SOAP implementation. Use SOAP 1.1 or SOAP 1.2.");
}
if (replyMessage.getFaultActor() != null) {
soapFault.setFaultActorOrRole(replyMessage.getFaultActor());
}
List<String> soapFaultDetails = replyMessage.getFaultDetails();
if (!soapFaultDetails.isEmpty()) {
TransformerFactory transformerFactory = TransformerFactory.newInstance();
Transformer transformer = transformerFactory.newTransformer();
transformer.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "yes");
SoapFaultDetail faultDetail = soapFault.addFaultDetail();
for (int i = 0; i < soapFaultDetails.size(); i++) {
transformer.transform(new StringSource(soapFaultDetails.get(i)), faultDetail.getResult());
}
}
}
/**
* Get the message payload object as {@link Source}, supported payload types are
* {@link Source}, {@link Document} and {@link String}.
* @param replyPayload payload object
* @return {@link Source} representation of the payload
*/
private Source getPayloadAsSource(Object replyPayload) {
if (replyPayload instanceof Source) {
return (Source) replyPayload;
} else if (replyPayload instanceof Document) {
return new DOMSource((Document) replyPayload);
} else if (replyPayload instanceof String) {
return new StringSource((String) replyPayload);
} else {
throw new CitrusRuntimeException("Unknown type for reply message payload (" + replyPayload.getClass().getName() + ") " +
"Supported types are " + "'" + Source.class.getName() + "', " + "'" + Document.class.getName() + "'" +
", or '" + String.class.getName() + "'");
}
}
/**
* Get the default QName from local part.
* @param localPart
* @return
*/
private QName getDefaultQName(String localPart) {
if (StringUtils.hasText(defaultNamespaceUri)) {
return QNameUtils.createQName(defaultNamespaceUri, localPart, defaultPrefix);
} else {
throw new SoapHeaderException("Failed to add SOAP header '" + localPart + "', " +
"because neither valid QName nor default namespace-uri is set!");
}
}
/**
* Gets the endpoint adapter.
* @return
*/
public EndpointAdapter getEndpointAdapter() {
return endpointAdapter;
}
/**
* Set the endpoint adapter.
* @param endpointAdapter the endpointAdapter to set
*/
public void setEndpointAdapter(EndpointAdapter endpointAdapter) {
this.endpointAdapter = endpointAdapter;
}
/**
* Gets the default header namespace uri.
* @return
*/
public String getDefaultNamespaceUri() {
return defaultNamespaceUri;
}
/**
* Set the default namespace used in SOAP response headers.
* @param defaultNamespaceUri the defaultNamespaceUri to set
*/
public void setDefaultNamespaceUri(String defaultNamespaceUri) {
this.defaultNamespaceUri = defaultNamespaceUri;
}
/**
* Gets the default header prefix.
* @return
*/
public String getDefaultPrefix() {
return defaultPrefix;
}
/**
* Set the default namespace prefix used in SOAP response headers.
* @param defaultPrefix the defaultPrefix to set
*/
public void setDefaultPrefix(String defaultPrefix) {
this.defaultPrefix = defaultPrefix;
}
/**
* Gets the endpoint configuration.
* @return
*/
public WebServiceEndpointConfiguration getEndpointConfiguration() {
return endpointConfiguration;
}
/**
* Sets the endpoint configuration.
* @param endpointConfiguration
*/
public void setEndpointConfiguration(WebServiceEndpointConfiguration endpointConfiguration) {
this.endpointConfiguration = endpointConfiguration;
}
}