1 /*
2 * Copyright 2005-2012 the original author or authors.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package org.springframework.ws;
18
19 import java.io.IOException;
20 import java.io.InputStream;
21
22 /**
23 * The <code>WebServiceMessageFactory</code> serves as a factory for {@link org.springframework.ws.WebServiceMessage
24 * WebServiceMessages}.
25 * <p/>
26 * <p>Allows the creation of empty messages, or messages based on <code>InputStream</code>s.
27 *
28 * @author Arjen Poutsma
29 * @see org.springframework.ws.WebServiceMessage
30 * @since 1.0.0
31 */
32 public interface WebServiceMessageFactory {
33
34 /**
35 * Creates a new, empty <code>WebServiceMessage</code>.
36 *
37 * @return the empty message
38 */
39 WebServiceMessage createWebServiceMessage();
40
41 /**
42 * Reads a {@link WebServiceMessage} from the given input stream.
43 * <p/>
44 * If the given stream is an instance of {@link org.springframework.ws.transport.TransportInputStream
45 * TransportInputStream}, the headers will be read from the request.
46 *
47 * @param inputStream the input stream to read the message from
48 * @return the created message
49 * @throws InvalidXmlException if the XML read from the input stream is invalid
50 * @throws IOException if an I/O exception occurs
51 */
52 WebServiceMessage createWebServiceMessage(InputStream inputStream) throws InvalidXmlException, IOException;
53
54 }