net.javacrumbs.smock.common.Message Maven / Gradle / Ivy
/*
* Copyright 2005-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.OutputStream;
import javax.xml.transform.Result;
import javax.xml.transform.Source;
/**
* Represents a protocol-agnostic XML message.
*
* Contains methods that provide access to the payload of the message.
*
* Copy of from Spring WS WebServiceMessage. We do not want to be dependent on Spring WS here, in common library.
*
* @author Arjen Poutsma
* @author Lukas Krecan
* @see org.springframework.ws.soap.SoapMessage
* @see WebServiceMessageFactory
* @since 1.0.0
*/
public interface Message {
/**
* Returns the contents of the message as a {@link Source}.
Depending on the implementation, this can be
* retrieved multiple times, or just a single time.
*
* @return the message contents
*/
Source getPayloadSource();
/**
* Returns the contents of the message as a {@link Result}.
*
* Calling this method removes the current payload.
*
* Implementations that are read-only will throw an {@link UnsupportedOperationException}.
*
* @return the message contents
* @throws UnsupportedOperationException if the message is read-only
*/
Result getPayloadResult();
/**
* Writes the entire message to the given output stream. If the given stream is an instance of {@link
* org.springframework.ws.transport.TransportOutputStream}, the corresponding headers will be written as well.
*
* @param outputStream the stream to write to
* @throws IOException if an I/O exception occurs
*/
void writeTo(OutputStream outputStream) throws IOException;
/**
* Returns envelope source for SOAP message.
* @return
*/
Source getEnvelopeSource();
}