1 /*
2 * Copyright 2008 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.soap.addressing.client;
18
19 import java.io.IOException;
20 import java.net.URI;
21 import java.net.URISyntaxException;
22 import javax.xml.transform.TransformerException;
23
24 import org.springframework.core.JdkVersion;
25 import org.springframework.util.Assert;
26 import org.springframework.ws.WebServiceMessage;
27 import org.springframework.ws.client.core.WebServiceMessageCallback;
28 import org.springframework.ws.soap.SoapMessage;
29 import org.springframework.ws.soap.addressing.core.EndpointReference;
30 import org.springframework.ws.soap.addressing.core.MessageAddressingProperties;
31 import org.springframework.ws.soap.addressing.messageid.MessageIdStrategy;
32 import org.springframework.ws.soap.addressing.messageid.RandomGuidMessageIdStrategy;
33 import org.springframework.ws.soap.addressing.messageid.UuidMessageIdStrategy;
34 import org.springframework.ws.soap.addressing.version.Addressing10;
35 import org.springframework.ws.soap.addressing.version.AddressingVersion;
36 import org.springframework.ws.transport.context.TransportContext;
37 import org.springframework.ws.transport.context.TransportContextHolder;
38
39 /**
40 * {@link WebServiceMessageCallback} implementation that sets the WS-Addressing <code>Action</code> header on the
41 * message.
42 * <p/>
43 * A usage example with {@link org.springframework.ws.client.core.WebServiceTemplate}:
44 * <pre>
45 * WebServiceTemplate template = new WebServiceTemplate(messageFactory);
46 * Result result = new DOMResult();
47 * template.sendSourceAndReceiveToResult(
48 * new StringSource("<content xmlns=\"http://tempuri.org\"/>"),
49 * new ActionCallback(new URI("http://tempuri.org/Action")),
50 * result);
51 * </pre>
52 *
53 * @author Arjen Poutsma
54 * @since 1.0.0
55 */
56 public class ActionCallback implements WebServiceMessageCallback {
57
58 private final AddressingVersion version;
59
60 private final URI action;
61
62 private final URI to;
63
64 private MessageIdStrategy messageIdStrategy;
65
66 private EndpointReference from;
67
68 private EndpointReference replyTo;
69
70 private EndpointReference faultTo;
71
72 /**
73 * Create a new <code>ActionCallback</code> with the given <code>Action</code>.
74 * <p/>
75 * The <code>To</code> header of the outgoing message will reflect the {@link org.springframework.ws.transport.WebServiceConnection#getUri()
76 * connection URI}.
77 * <p/>
78 * The {@link AddressingVersion} is set to {@link Addressing10}.
79 *
80 * @param action the value of the action property to set
81 */
82 public ActionCallback(String action) throws URISyntaxException {
83 this(new URI(action), new Addressing10(), null);
84 }
85
86 /**
87 * Create a new <code>ActionCallback</code> with the given <code>Action</code>.
88 * <p/>
89 * The <code>To</code> header of the outgoing message will reflect the {@link org.springframework.ws.transport.WebServiceConnection#getUri()
90 * connection URI}.
91 * <p/>
92 * The {@link AddressingVersion} is set to {@link Addressing10}.
93 *
94 * @param action the value of the action property to set
95 */
96 public ActionCallback(URI action) {
97 this(action, new Addressing10(), null);
98 }
99
100 /**
101 * Create a new <code>ActionCallback</code> with the given version and <code>Action</code>.
102 * <p/>
103 * The <code>To</code> header of the outgoing message will reflect the {@link org.springframework.ws.transport.WebServiceConnection#getUri()
104 * connection URI}.
105 *
106 * @param action the value of the action property to set
107 * @param version the WS-Addressing version to use
108 */
109 public ActionCallback(URI action, AddressingVersion version) {
110 this(action, version, null);
111 }
112
113 /**
114 * Create a new <code>ActionCallback</code> with the given version, <code>Action</code>, and optional
115 * <code>To</code>.
116 *
117 * @param action the value of the action property
118 * @param version the WS-Addressing version to use
119 * @param action the value of the destination property
120 */
121 public ActionCallback(URI action, AddressingVersion version, URI to) {
122 Assert.notNull(action, "'action' must not be null");
123 Assert.notNull(version, "'version' must not be null");
124 this.action = action;
125 this.version = version;
126 this.to = to;
127 if (JdkVersion.isAtLeastJava15()) {
128 messageIdStrategy = new UuidMessageIdStrategy();
129 }
130 else {
131 messageIdStrategy = new RandomGuidMessageIdStrategy();
132 }
133 }
134
135 /**
136 * Returns the WS-Addressing version
137 * @return
138 */
139 public AddressingVersion getVersion() {
140 return version;
141 }
142
143 /**
144 * Returns the message id strategy used for creating WS-Addressing MessageIds.
145 * <p/>
146 * By default, the {@link UuidMessageIdStrategy} is used on Java 5 and higher, and the {@link
147 * RandomGuidMessageIdStrategy} on Java 1.4.
148 */
149 public MessageIdStrategy getMessageIdStrategy() {
150 return messageIdStrategy;
151 }
152
153 /**
154 * Sets the message id strategy used for creating WS-Addressing MessageIds.
155 * <p/>
156 * By default, the {@link UuidMessageIdStrategy} is used on Java 5 and higher, and the {@link
157 * RandomGuidMessageIdStrategy} on Java 1.4.
158 */
159 public void setMessageIdStrategy(MessageIdStrategy messageIdStrategy) {
160 Assert.notNull(messageIdStrategy, "'messageIdStrategy' must not be null");
161 this.messageIdStrategy = messageIdStrategy;
162 }
163
164 /**
165 * Returns the {@code Action}.
166 * @see org.springframework.ws.soap.addressing.core.MessageAddressingProperties#getAction()
167 */
168 public URI getAction() {
169 return action;
170 }
171
172 /**
173 * Returns the {@code From}.
174 * @see org.springframework.ws.soap.addressing.core.MessageAddressingProperties#getFrom()
175 */
176 public EndpointReference getFrom() {
177 return from;
178 }
179
180 /**
181 * Sets the {@code From}.
182 * @see org.springframework.ws.soap.addressing.core.MessageAddressingProperties#getFrom()
183 */
184 public void setFrom(EndpointReference from) {
185 this.from = from;
186 }
187
188 /**
189 * Returns the {@code ReplyTo}.
190 * @see org.springframework.ws.soap.addressing.core.MessageAddressingProperties#getReplyTo()
191 */
192 public EndpointReference getReplyTo() {
193 return replyTo;
194 }
195
196 /**
197 * Sets the {@code ReplyTo}.
198 * @see org.springframework.ws.soap.addressing.core.MessageAddressingProperties#getReplyTo()
199 */
200 public void setReplyTo(EndpointReference replyTo) {
201 this.replyTo = replyTo;
202 }
203
204 /**
205 * Returns the {@code FaultTo}.
206 * @see org.springframework.ws.soap.addressing.core.MessageAddressingProperties#getFaultTo()
207 */
208 public EndpointReference getFaultTo() {
209 return faultTo;
210 }
211
212 /**
213 * Sets the {@code FaultTo}.
214 * @see org.springframework.ws.soap.addressing.core.MessageAddressingProperties#getFaultTo()
215 */
216 public void setFaultTo(EndpointReference faultTo) {
217 this.faultTo = faultTo;
218 }
219
220
221
222 /**
223 * Returns the <code>Destination</code> for outgoing messages.
224 * <p/>
225 * Defaults to the {@link org.springframework.ws.transport.WebServiceConnection#getUri() connection URI} if no
226 * destination was set.
227 */
228 protected URI getTo() {
229 if (to == null) {
230 TransportContext transportContext = TransportContextHolder.getTransportContext();
231 if (transportContext != null && transportContext.getConnection() != null) {
232 try {
233 return transportContext.getConnection().getUri();
234 }
235 catch (URISyntaxException ex) {
236 // ignore
237 }
238 }
239 throw new IllegalStateException("Could not obtain connection URI from Transport Context");
240 }
241 else {
242 return to;
243 }
244 }
245
246 public void doWithMessage(WebServiceMessage message) throws IOException, TransformerException {
247 Assert.isInstanceOf(SoapMessage.class, message);
248 SoapMessage soapMessage = (SoapMessage) message;
249 URI messageId = getMessageIdStrategy().newMessageId(soapMessage);
250 MessageAddressingProperties map =
251 new MessageAddressingProperties(getTo(), getFrom(), getReplyTo(), getFaultTo(), getAction(), messageId);
252 version.addAddressingHeaders(soapMessage, map);
253 }
254
255
256 }