net.javacrumbs.springws.test.generator.DefaultResponseGenerator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-ws-test Show documentation
Spring WS Test is a tool to simplify Spring WS client functional testing.
There is a newer version: 0.22
/**
 * Copyright 2009-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 net.javacrumbs.springws.test.generator;

import java.io.IOException;
import java.io.InputStream;
import java.net.URI;

import javax.xml.transform.stream.StreamSource;

import net.javacrumbs.springws.test.RequestProcessor;
import net.javacrumbs.springws.test.lookup.ResourceLookup;
import net.javacrumbs.springws.test.util.DefaultXmlUtil;
import net.javacrumbs.springws.test.util.TransportInputStreamWrapper;
import net.javacrumbs.springws.test.util.XmlUtil;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.core.Ordered;
import org.springframework.core.io.Resource;
import org.springframework.ws.WebServiceMessage;
import org.springframework.ws.WebServiceMessageFactory;

/**
 * Looks-up resource using {@link ResourceLookup} and generates {@link WebServiceMessage} based on the resource. 
 * If the resource does not contain SOAP envelope, an envelope is created. You can influence this behaviour by setting {@link #alwaysCreateEnvelope} and {@link #neverCreateEnvelope}.
 * @author Lukas Krecan
 *
 */
public class DefaultResponseGenerator implements RequestProcessor, Ordered {

	static final int DEFAULT_ORDER = 50;

	protected final Log logger = LogFactory.getLog(getClass());

	private ResourceLookup resourceLookup;
	
	private int order = DEFAULT_ORDER;
	
	private XmlUtil xmlUtil = DefaultXmlUtil.getInstance();
	
	private boolean alwaysCreateEnvelope = false; 

	private boolean neverCreateEnvelope = false; 

	public WebServiceMessage processRequest(URI uri, WebServiceMessageFactory messageFactory, WebServiceMessage request) throws IOException {
		Resource resultResource = getResultResource(uri, request);
		if (resultResource == null) {
			logger.debug("Resource not found, returning null.");
			return null;
		} else {
			if (shouldCreateSoapEnvelope(resultResource))
			{
				WebServiceMessage message = messageFactory.createWebServiceMessage();
				getXmlUtil().transform(new StreamSource(resultResource.getInputStream()), message.getPayloadResult());
				postprocessMessage(message, uri, messageFactory, request);
				logMessage(message);
				return message;	
			}
			else
			{
				WebServiceMessage message = messageFactory.createWebServiceMessage(createInputStream(resultResource));
				postprocessMessage(message, uri, messageFactory, request);
				logMessage(message);
				return message;
			}
		}
	}

	private void logMessage(WebServiceMessage message) {
		if (logger.isTraceEnabled())
		{
			logger.trace("Loaded message "+getXmlUtil().serializeDocument(message));
		}
	}

	/**
	 * Returns true if the soap envelope should be created.
	 * @param resultResource
	 * @return
	 * @throws IOException 
	 */
	protected boolean shouldCreateSoapEnvelope(Resource resultResource) throws IOException {
		return alwaysCreateEnvelope || (!neverCreateEnvelope && !getXmlUtil().isSoap(xmlUtil.loadDocument(resultResource)));
	}

	/**
	 * Creates input stream from the resource.
	 * @param resultResource
	 * @return
	 * @throws IOException
	 */
	protected InputStream createInputStream(final Resource resultResource) throws IOException {
		return new TransportInputStreamWrapper(resultResource);
		
	}

	protected void postprocessMessage(WebServiceMessage message, URI uri, WebServiceMessageFactory messageFactory,	WebServiceMessage request) {
		
	}


	/**
	 * Looks for the resource that should be used for result generation.
	 * @param uri
	 * @param request
	 * @return
	 * @throws IOException
	 */
	protected Resource getResultResource(URI uri, WebServiceMessage request) throws IOException {
		return resourceLookup.lookupResource(uri, request);
	}

	public ResourceLookup getResourceLookup() {
		return resourceLookup;
	}

	public void setResourceLookup(ResourceLookup resourceLookup) {
		this.resourceLookup = resourceLookup;
	}

	public int getOrder() {
		return order;
	}

	public void setOrder(int order) {
		this.order = order;
	}

	public XmlUtil getXmlUtil() {
		return xmlUtil;
	}

	public void setXmlUtil(XmlUtil xmlUtil) {
		this.xmlUtil = xmlUtil;
	}

	public boolean isAlwaysCreateEnvelope() {
		return alwaysCreateEnvelope;
	}

	public void setAlwaysCreateEnvelope(boolean alwaysCreateEnvelope) {
		this.alwaysCreateEnvelope = alwaysCreateEnvelope;
	}

	public boolean isNeverCreateEnvelope() {
		return neverCreateEnvelope;
	}

	public void setNeverCreateEnvelope(boolean neverCreateEnvelope) {
		this.neverCreateEnvelope = neverCreateEnvelope;
	}
}