CommonSmockServer.java

/**
 * 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.smock.common.server;

import java.util.Collections;
import java.util.Map;

import javax.xml.transform.Source;
import javax.xml.transform.dom.DOMSource;

import net.javacrumbs.smock.common.SmockCommon;
import net.javacrumbs.smock.common.TemplateAwareMessageCreator;
import net.javacrumbs.smock.common.TemplateAwareMessageMatcher;
import net.javacrumbs.smock.common.TemplateProcessor;

import org.springframework.core.io.Resource;
import org.w3c.dom.Document;

/**
 * Adds extra functionality to Spring WS server test support. 
 * @author Lukas Krecan
 *
 */
public class CommonSmockServer extends SmockCommon {

	private static final Map<String, Object> EMPTY_MAP = Collections.<String, Object>emptyMap();

	/**
	 * Create a request with the given resource as content. If the content is payload it will be wrapped into a SOAP, 
	 * if the content contains the whole message, it will be used as it is. Supports templates that will be resolved by {@link TemplateProcessor}.
	 * 
	 * @param messageResource the message content
	 * @return the request creator
	 */
	public static ParametrizableRequestCreator withMessage(String messageResource) {
		return withMessage(fromResource(messageResource));
	}
	/**
	 * Create a request with the given {@link Resource} as content. If the content is payload it will be wrapped into a SOAP, 
	 * if the content contains the whole message, it will be used as it is. Supports templates that will be resolved by {@link TemplateProcessor}.
	 *
	 * @param messageResource
	 * @return the request creator
	 */
	public static ParametrizableRequestCreator withMessage(Resource messageResource) {
		return withMessage(createSource(messageResource));
	}
    /**
     * Create a request with the given {@link Resource} XML as content. If the content is payload it will be wrapped into a SOAP, 
	 * if the content contains the whole message, it will be used as it is. Supports templates that will be resolved by {@link TemplateProcessor}.
     *
     * @param message 
     * @return the request creator
     */
    public static ParametrizableRequestCreator withMessage(Source message) {
    	return new TemplateAwareMessageCreator(message,EMPTY_MAP, getTemplateProcessor());
    }
    /**
     * Create a request with the given {@link Resource} XML as content. If the content is payload it will be wrapped into a SOAP, 
	 * if the content contains the whole message, it will be used as it is. Supports templates that will be resolved by {@link TemplateProcessor}.
     * @param message
     * @return
     */
    public static ParametrizableRequestCreator withMessage(Document message) {
    	return withMessage(new DOMSource(message));
    }
    
    /**
     * Expects the given message. If the message contains only payload, only the payloads will be compared. If it contains whole message, 
     * whole messages will be compared. Control message can be preprocessed by {@link TemplateProcessor}. 
     * @param messageResource
     * @return
     */
    public static ParametrizableResponseMatcher message(String messageResource)
    {
    	return message(fromResource(messageResource));
    }
    /**
     * Expects the given message. If the message contains only payload, only the payloads will be compared. If it contains whole message, 
     * whole messages will be compared. Control message can be preprocessed by {@link TemplateProcessor}. 
     * @param messageResource
     * @return
     */
    public static ParametrizableResponseMatcher message(Resource messageResource)
    {
    	return message(createSource(messageResource));
    }
    /**
     * Expects the given message. If the message contains only payload, only the payloads will be compared. If it contains whole message, 
     * whole messages will be compared. Control message can be preprocessed by {@link TemplateProcessor}. 
     * @param content
     * @return
     */
	public static ParametrizableResponseMatcher message(Source content) {
		return new TemplateAwareMessageMatcher(content, EMPTY_MAP, getTemplateProcessor());
	}
	/**
	 * Expects the given message. If the message contains only payload, only the payloads will be compared. If it contains whole message, 
     * whole messages will be compared. Control message can be preprocessed by {@link TemplateProcessor}. 
	 * @param message
	 * @return
	 */
	public static ParametrizableResponseMatcher message(Document message) {
		return message(new DOMSource(message));
	}
}