View Javadoc

1   /*
2    * Copyright 2006 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.transport;
18  
19  import java.io.IOException;
20  import java.net.URI;
21  
22  import org.springframework.ws.WebServiceMessage;
23  
24  /**
25   * Defines the methods for classes capable of sending and receiving {@link WebServiceMessage} instances across a
26   * transport.
27   * <p/>
28   * The <code>WebServiceMessageSender</code> is basically a factory for {@link WebServiceConnection} objects.
29   *
30   * @author Arjen Poutsma
31   * @see WebServiceConnection
32   * @since 1.0.0
33   */
34  public interface WebServiceMessageSender {
35  
36      /**
37       * Create a new {@link WebServiceConnection} to the specified URI.
38       *
39       * @param uri the URI to open a connection to
40       * @return the new connection
41       * @throws IOException in case of I/O errors
42       */
43      WebServiceConnection createConnection(URI uri) throws IOException;
44  
45      /**
46       * Does this {@link WebServiceMessageSender} support the supplied URI?
47       *
48       * @param uri the URI to be checked
49       * @return <code>true</code> if this <code>WebServiceMessageSender</code> supports the supplied URI
50       */
51      boolean supports(URI uri);
52  
53  }