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.client.support;
18  
19  import java.io.IOException;
20  
21  import org.springframework.beans.factory.InitializingBean;
22  import org.springframework.util.Assert;
23  import org.springframework.ws.WebServiceMessageFactory;
24  import org.springframework.ws.transport.WebServiceConnection;
25  import org.springframework.ws.transport.WebServiceMessageSender;
26  import org.springframework.xml.transform.TransformerObjectSupport;
27  
28  /**
29   * Base class for <code>WebServiceTemplate</code> and other WS-accessing helpers. Defines common properties like the
30   * {@link WebServiceMessageFactory} and {@link WebServiceMessageSender}.
31   * <p/>
32   * Not intended to be used directly. See {@link org.springframework.ws.client.core.WebServiceTemplate}.
33   *
34   * @author Arjen Poutsma
35   * @see org.springframework.ws.client.core.WebServiceTemplate
36   * @since 1.0.0
37   */
38  public abstract class WebServiceAccessor extends TransformerObjectSupport implements InitializingBean {
39  
40      private WebServiceMessageFactory messageFactory;
41  
42      private WebServiceMessageSender[] messageSenders;
43  
44      /** Returns the message factory used for creating messages. */
45      public WebServiceMessageFactory getMessageFactory() {
46          return messageFactory;
47      }
48  
49      /** Sets the message factory used for creating messages. */
50      public void setMessageFactory(WebServiceMessageFactory messageFactory) {
51          this.messageFactory = messageFactory;
52      }
53  
54      /** Returns the message senders used for sending messages. */
55      public WebServiceMessageSender[] getMessageSenders() {
56          return messageSenders;
57      }
58  
59      /**
60       * Sets the single message sender used for sending messages.
61       * <p/>
62       * This message sender will be used to resolve an URI to a {@link WebServiceConnection}.
63       *
64       * @see #createConnection(String)
65       */
66      public void setMessageSender(WebServiceMessageSender messageSender) {
67          Assert.notNull(messageSender, "'messageSender' must not be null");
68          messageSenders = new WebServiceMessageSender[]{messageSender};
69      }
70  
71      /**
72       * Sets the message senders used for sending messages.
73       * <p/>
74       * These message senders will be used to resolve an URI to a {@link WebServiceConnection}.
75       *
76       * @see #createConnection(String)
77       */
78      public void setMessageSenders(WebServiceMessageSender[] messageSenders) {
79          Assert.notEmpty(messageSenders, "'messageSenders' must not be empty");
80          this.messageSenders = messageSenders;
81      }
82  
83      public void afterPropertiesSet() {
84          Assert.notNull(getMessageFactory(), "Property 'messageFactory' is required");
85          Assert.notEmpty(getMessageSenders(), "Property 'messageSenders' is required");
86      }
87  
88      /**
89       * Creates a connection to the given URI, or throws an exception when it cannot be resolved.
90       * <p/>
91       * Default implementation iterates over all configured {@link WebServiceMessageSender} objects, and calls {@link
92       * WebServiceMessageSender#supports(String)} for each of them. If the sender supports the parameter URI, it creates
93       * a connection using {@link WebServiceMessageSender#createConnection(String)} .
94       *
95       * @param uri the URI to open a connection to
96       * @return the created connection
97       * @throws IllegalArgumentException when the uri cannot be resolved
98       * @throws IOException              when an I/O error occurs
99       */
100     protected WebServiceConnection createConnection(String uri) throws IOException {
101         Assert.notEmpty(getMessageSenders(), "Property 'messageSenders' is required");
102         WebServiceMessageSender[] messageSenders = getMessageSenders();
103         for (int i = 0; i < messageSenders.length; i++) {
104             if (messageSenders[i].supports(uri)) {
105                 if (logger.isDebugEnabled()) {
106                     logger.debug("Opening connection to [" + uri + "] using [" + messageSenders[i] + "]");
107                 }
108                 return messageSenders[i].createConnection(uri);
109             }
110         }
111         throw new IllegalArgumentException("Could not resolve [" + uri + "] to a WebServiceMessageSender");
112     }
113 
114 }