net.javacrumbs.smock.common.MessageFactory Maven / Gradle / Ivy
/*
* Copyright 2006-2007 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;
import java.io.IOException;
import java.io.InputStream;
/**
* The WebServiceMessageFactory serves as a factory for {@link org.springframework.ws.WebServiceMessage
* WebServiceMessages}.
*
* Allows the creation of empty messages, or messages based on InputStreams.
*
* Copy of from Spring WS WebServiceMessageFactory. We do not want to be dependent on Spring WS here, in common library.
*
* @author Arjen Poutsma
* @see org.springframework.ws.WebServiceMessage
* @since 1.0.0
*/
public interface MessageFactory {
/**
* Creates a new, empty WebServiceMessage.
*
* @return the empty message
*/
Message createWebServiceMessage();
/**
* Reads a {@link WebServiceMessage} from the given input stream.
*
* If the given stream is an instance of {@link org.springframework.ws.transport.TransportInputStream
* TransportInputStream}, the headers will be read from the request.
*
* @param inputStream the inputstream to read the message from
* @return the created message
* @throws java.io.IOException if an I/O exception occurs
*/
Message createWebServiceMessage(InputStream inputStream) throws IOException;
}