View Javadoc

1   /*
2    * Copyright 2005-2010 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.test.support.creator;
18  
19  import java.io.IOException;
20  
21  import org.springframework.ws.WebServiceMessage;
22  import org.springframework.ws.WebServiceMessageFactory;
23  
24  /**
25   * Abstract base class for the [email protected] WebServiceMessageCreator} interface.
26   * <p/>
27   * Creates a message using the given [email protected] WebServiceMessageFactory}, and passes it on to [email protected]
28   * #doWithMessage(WebServiceMessage)}.
29   *
30   * @author Arjen Poutsma
31   * @since 2.0
32   */
33  public abstract class AbstractMessageCreator implements WebServiceMessageCreator {
34  
35      public final WebServiceMessage createMessage(WebServiceMessageFactory messageFactory) throws IOException {
36          WebServiceMessage message = messageFactory.createWebServiceMessage();
37          doWithMessage(message);
38          return message;
39      }
40  
41      /**
42       * Abstract template method, invoked by [email protected] #createMessage(WebServiceMessageFactory)} after a message has been
43       * created.
44       *
45       * @param message the message
46       * @throws IOException in case of I/O errors
47       */
48      protected abstract void doWithMessage(WebServiceMessage message) throws IOException;
49  
50  }