Spring/spring-ws
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

- Split out WS-Addressing to multiple packages (SWS-84)

Browse Source 
- Javadoc
This commit is contained in:
Arjen Poutsma
2008-02-23 17:28:10 +00:00
parent 5e5ae16391
commit dc664b7301
13 changed files with 115 additions and 143 deletions
Download Patch File Download Diff File Expand all files Collapse all files

78
core/src/main/java/org/springframework/ws/soap/addressing/AbstractActionMethodEndpointMapping.java
View File

@@ -1,78 +0,0 @@
/*
* Copyright 2008 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.ws.soap.addressing;
import java.lang.reflect.Method;
import java.net.URI;
import org.springframework.aop.support.AopUtils;
import org.springframework.core.JdkVersion;
import org.springframework.util.Assert;
import org.springframework.ws.server.endpoint.MethodEndpoint;
/**
* @author Arjen Poutsma
* @since 1.5.0
*/
public abstract class AbstractActionMethodEndpointMapping extends AbstractActionEndpointMapping {
/**
* Helper method that registers the methods of the given bean. This method iterates over the methods of the bean,
* and calls {@link #getActionForMethod(Method)} for each. If this returns a URI, the method is registered using
* {@link #registerEndpoint(URI, Object)}.
*
* @see #getActionForMethod (java.lang.reflect.Method)
*/
protected void registerMethods(Object endpoint) {
Assert.notNull(endpoint, "'endpoint' must not be null");
Method[] methods = getEndpointClass(endpoint).getMethods();
for (int i = 0; i < methods.length; i++) {
if (JdkVersion.isAtLeastJava15() && methods[i].isSynthetic() ||
methods[i].getDeclaringClass().equals(Object.class)) {
continue;
}
URI action = getActionForMethod(methods[i]);
if (action != null) {
registerEndpoint(action, new MethodEndpoint(endpoint, methods[i]));
}
}
}
/**
* Returns the the action URI for the given method. Returns <code>null</code> if the method is not to be registered,
* which is the default.
*
* @param method the method
* @return the action URI, or <code>null</code> if the method is not to be registered
*/
protected URI getActionForMethod(Method method) {
return null;
}
/**
* Return the class or interface to use for method reflection.
* <p/>
* Default implementation delegates to {@link AopUtils#getTargetClass(Object)}.
*
* @param endpoint the bean instance (might be an AOP proxy)
* @return the bean class to expose
*/
protected Class getEndpointClass(Object endpoint) {
return AopUtils.getTargetClass(endpoint);
}
}

6
core/src/main/java/org/springframework/ws/soap/addressing/EndpointReference.java → core/src/main/java/org/springframework/ws/soap/addressing/core/EndpointReference.java
View File

@@ -14,7 +14,7 @@
* limitations under the License.
*/
package org.springframework.ws.soap.addressing;
package org.springframework.ws.soap.addressing.core;
import java.net.URI;
import java.util.Collections;
@@ -54,11 +54,11 @@ public final class EndpointReference {
/**
* Creates a new instance of the {@link EndpointReference} class with the given address, reference properties, and
* reference paramters.
* reference parameters.
*
* @param address the endpoint address
* @param referenceProperties the reference properties, as a list of {@link Node}
* @param referenceProperties the reference parameters, as a list of {@link Node}
* @param referenceParameters the reference parameters, as a list of {@link Node}
*/
public EndpointReference(URI address, List referenceProperties, List referenceParameters) {
Assert.notNull(address, "address must not be null");

43
core/src/main/java/org/springframework/ws/soap/addressing/MessageAddressingProperties.java → core/src/main/java/org/springframework/ws/soap/addressing/core/MessageAddressingProperties.java
View File

@@ -14,7 +14,7 @@
* limitations under the License.
*/
package org.springframework.ws.soap.addressing;
package org.springframework.ws.soap.addressing.core;
import java.net.URI;
import java.util.Collections;
@@ -76,6 +76,14 @@ public final class MessageAddressingProperties {
this.referenceParameters = Collections.EMPTY_LIST;
}
/**
* Constructs a new {@link MessageAddressingProperties} that forms a reply to the given EPR.
*
* @param epr the endpoint reference to create a reply for
* @param action the value of the action property
* @param messageId the value of the message id property
* @param relatesTo the value of the relates to property
*/
private MessageAddressingProperties(EndpointReference epr, URI action, URI messageId, URI relatesTo) {
this.to = epr.getAddress();
this.action = action;
@@ -134,36 +142,25 @@ public final class MessageAddressingProperties {
}
/**
* Indicates whether is {@link MessageAddressingProperties} is valid, i.e. whether all required elements are
* listed.
* <p/>
* Returns <code>true</code> if the to and action properties have been set, and - if a reply or fault endpoint has
* been set - also checks for the message id.
* Creates a {@link MessageAddressingProperties} that can be used for creating a reply to the given {@link
* EndpointReference}. The {@link #getTo() destination} property will be populated with the {@link
* EndpointReference#getAddress() address} of the given EPR, and the {@link #getRelatesTo() relationship} property
* will be set to the {@link #getMessageId() message id} property of this instance. the action is specified, the
*
* @param epr the endpoint reference to create a reply to
* @param action the action
*/
public boolean isValid() {
if (to == null) {
return false;
}
if (action == null) {
return false;
}
if (replyTo != null || faultTo != null) {
return messageId != null;
}
return true;
}
public MessageAddressingProperties getReplyProperties(EndpointReference epr, URI action, URI messageId) {
return new MessageAddressingProperties(epr, action, messageId, this.messageId);
}
/**
* Indicates whether is {@link MessageAddressingProperties} has all required properties. Returns <code>true</code>
* if the destination and action properties have been set, and if a reply or fault endpoint has been set, also
* checks for the message id.
* Indicates whether is {@link MessageAddressingProperties} has all required properties.
*
* @return <code>true</code> if the to and action properties have been set, and - if a reply or fault endpoint has
* been set - also checks for the message id
*/
public boolean hasRequiredProperties() {
// TODO: make sure this is handled according to the spec
if (to == null) {
return false;
}

6
core/src/main/java/org/springframework/ws/soap/addressing/core/package.html Normal file
View File

@@ -0,0 +1,6 @@
<html>
<body>
Core package for WS-Addressing support. Contains the <code>EndpointReference</code> and
<code>MessageAddressingProperties</code> classes.
</body>
</html>

8
core/src/main/java/org/springframework/ws/soap/addressing/messageid/MessageIdStrategy.java
View File

@@ -18,7 +18,7 @@ package org.springframework.ws.soap.addressing.messageid;
import java.net.URI;
import org.springframework.ws.context.MessageContext;
import org.springframework.ws.soap.SoapMessage;
/**
* Strategy interface that encapsulates the creation and validation of WS-Addressing <code>MessageID</code>s.
@@ -37,11 +37,11 @@ public interface MessageIdStrategy {
boolean isDuplicate(URI messageId);
/**
* Returns a new WS-Addressing <code>MessageID</code> for the {@link MessageContext#getResponse() response} in the
* given message context.
* Returns a new WS-Addressing <code>MessageID</code> for the given {@link SoapMessage}.
*
* @param message the message to create an id for
* @return the new message id
*/
URI newMessageId(MessageContext messageContext);
URI newMessageId(SoapMessage message);
}

4
core/src/main/java/org/springframework/ws/soap/addressing/messageid/RandomGuidMessageIdStrategy.java
View File

@@ -18,7 +18,7 @@ package org.springframework.ws.soap.addressing.messageid;
import java.net.URI;
import org.springframework.ws.context.MessageContext;
import org.springframework.ws.soap.SoapMessage;
/**
* Implementation of the {@link MessageIdStrategy} interface that uses a {@link RandomGuid} to generate a Message Id.
@@ -46,7 +46,7 @@ public class RandomGuidMessageIdStrategy implements MessageIdStrategy {
return false;
}
public URI newMessageId(MessageContext messageContext) {
public URI newMessageId(SoapMessage message) {
return URI.create(PREFIX + new RandomGuid(secure).toString());
}
}

4
core/src/main/java/org/springframework/ws/soap/addressing/messageid/UuidMessageIdStrategy.java
View File

@@ -19,7 +19,7 @@ package org.springframework.ws.soap.addressing.messageid;
import java.net.URI;
import java.util.UUID;
import org.springframework.ws.context.MessageContext;
import org.springframework.ws.soap.SoapMessage;
/**
* Implementation of the {@link MessageIdStrategy} interface that uses a {@link UUID} to generate a Message Id. The UUID
@@ -39,7 +39,7 @@ public class UuidMessageIdStrategy implements MessageIdStrategy {
return false;
}
public URI newMessageId(MessageContext messageContext) {
public URI newMessageId(SoapMessage message) {
return URI.create(PREFIX + UUID.randomUUID().toString());
}
}

41
core/src/main/java/org/springframework/ws/soap/addressing/AbstractActionEndpointMapping.java → core/src/main/java/org/springframework/ws/soap/addressing/server/AbstractActionEndpointMapping.java
View File

@@ -14,7 +14,7 @@
* limitations under the License.
*/
package org.springframework.ws.soap.addressing;
package org.springframework.ws.soap.addressing.server;
import java.net.URI;
import java.util.HashMap;
@@ -24,8 +24,12 @@ import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.util.Assert;
import org.springframework.ws.soap.addressing.core.MessageAddressingProperties;
/**
* Abstract base class for WS-Addressing <code>Action</code>-mapped {@link org.springframework.ws.server.EndpointMapping}
* implementations. Provides infrastructure for mapping endpoints to actions.
*
* @author Arjen Poutsma
* @since 1.5.0
*/
@@ -37,6 +41,31 @@ public abstract class AbstractActionEndpointMapping extends AbstractAddressingEn
private ApplicationContext applicationContext;
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
this.applicationContext = applicationContext;
}
protected final Object getEndpointInternal(MessageAddressingProperties map) {
Object endpoint = lookupEndpoint(map.getAction());
if (endpoint != null) {
URI endpointAddress = getEndpointAddress(endpoint);
if (endpointAddress == null || endpointAddress.equals(map.getTo())) {
return endpoint;
}
}
return null;
}
/**
* Returns the address property of the given endpoint. The value of this property should match the {@link
* MessageAddressingProperties#getTo() destination} of incoming messages. May return <code>null</code> to ignore
* the destination.
*
* @param endpoint the endpoint to return the address for
* @return the endpoint address; or <code>null</code> to ignore the destination property
*/
protected abstract URI getEndpointAddress(Object endpoint);
/**
* Looks up an endpoint instance for the given action. All keys are tried in order.
*
@@ -47,10 +76,6 @@ public abstract class AbstractActionEndpointMapping extends AbstractAddressingEn
return endpointMap.get(action);
}
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
this.applicationContext = applicationContext;
}
/**
* Register the specified endpoint for the given action URI.
*
@@ -87,11 +112,5 @@ public abstract class AbstractActionEndpointMapping extends AbstractAddressingEn
}
}
protected final Object getEndpointInternal(MessageAddressingProperties map) {
return getEndpointInternal(map.getTo(), map.getAction());
}
protected abstract Object getEndpointInternal(URI to, URI action);
}

32
core/src/main/java/org/springframework/ws/soap/addressing/AbstractAddressingEndpointMapping.java → core/src/main/java/org/springframework/ws/soap/addressing/server/AbstractAddressingEndpointMapping.java
View File

@@ -14,7 +14,7 @@
* limitations under the License.
*/
package org.springframework.ws.soap.addressing;
package org.springframework.ws.soap.addressing.server;
import java.net.URI;
import java.util.Arrays;
@@ -31,16 +31,36 @@ import org.springframework.ws.server.EndpointMapping;
import org.springframework.ws.soap.SoapHeader;
import org.springframework.ws.soap.SoapHeaderElement;
import org.springframework.ws.soap.SoapMessage;
import org.springframework.ws.soap.addressing.core.MessageAddressingProperties;
import org.springframework.ws.soap.addressing.messageid.MessageIdStrategy;
import org.springframework.ws.soap.addressing.messageid.RandomGuidMessageIdStrategy;
import org.springframework.ws.soap.addressing.messageid.UuidMessageIdStrategy;
import org.springframework.ws.soap.addressing.version.WsAddressing200408;
import org.springframework.ws.soap.addressing.version.WsAddressing200605;
import org.springframework.ws.soap.addressing.version.WsAddressingVersion;
import org.springframework.ws.soap.server.SoapEndpointInvocationChain;
import org.springframework.ws.soap.server.SoapEndpointMapping;
import org.springframework.ws.transport.WebServiceMessageSender;
import org.springframework.xml.transform.TransformerObjectSupport;
/**
* Abstract base class for {@link EndpointMapping} implementations that implement WS-Addressing.
* Abstract base class for {@link EndpointMapping} implementations that handle WS-Addressing. Besides the normal {@link
* SoapEndpointMapping} properties, this mapping has a {@link #setVersions(WsAddressingVersion[]) versions} property,
* which defines the WS-Addressing specifications supported. By default, these are {@link WsAddressing200408} and {@link
* WsAddressing200605}.
* <p/>
* The {@link #setMessageIdStrategy(MessageIdStrategy) messageIdStrategy} property defines the strategy to use for
* creating reply <code>MessageIDs</code>. By default, this is the {@link UuidMessageIdStrategy} on Java 5 and higher,
* and the {@link RandomGuidMessageIdStrategy} on Java 1.4.
* <p/>
* The {@link #setMessageSenders(WebServiceMessageSender[]) messageSenders} are used to send out-of-band reply messages.
* If a request messages defines a non-anonymous reply address, these senders will be used to send the message.
* <p/>
* This mapping (and all subclasses) uses an implicit WS-Addressing {@link EndpointInterceptor}, which is added in every
* {@link EndpointInvocationChain} produced. As such, this mapping does not have the standard <code>interceptors</code>
* property, but rather a {@link #setPreInterceptors(EndpointInterceptor[]) preInterceptors} and {@link
* #setPostInterceptors(EndpointInterceptor[]) postInterceptors} property, which are added before and after the implicit
* WS-Addressing interceptor, respectively.
*
* @author Arjen Poutsma
* @since 1.5.0
@@ -54,7 +74,7 @@ public abstract class AbstractAddressingEndpointMapping extends TransformerObjec
private MessageIdStrategy messageIdStrategy;
private WebServiceMessageSender[] messageSenders;
private WebServiceMessageSender[] messageSenders = new WebServiceMessageSender[0];
private WsAddressingVersion[] versions;
@@ -115,16 +135,18 @@ public abstract class AbstractAddressingEndpointMapping extends TransformerObjec
}
/**
* Sets the message id provider used for creating WS-Addressing MessageIds.
* Sets the message id strategy used for creating WS-Addressing MessageIds.
* <p/>
* By default, the {@link UuidMessageIdStrategy} is used on Java 5 and higher, and the {@link
* RandomGuidMessageIdStrategy} on Java 1.4.
*/
public final void setMessageIdProvider(MessageIdStrategy messageIdStrategy) {
public final void setMessageIdStrategy(MessageIdStrategy messageIdStrategy) {
Assert.notNull(messageIdStrategy, "'messageIdStrategy' must not be null");
this.messageIdStrategy = messageIdStrategy;
}
public final void setMessageSenders(WebServiceMessageSender[] messageSenders) {
Assert.notNull(messageSenders, "'messageSenders' must not be null");
this.messageSenders = messageSenders;
}

24
core/src/main/java/org/springframework/ws/soap/addressing/SimpleActionEndpointMapping.java → core/src/main/java/org/springframework/ws/soap/addressing/server/SimpleActionEndpointMapping.java
View File

@@ -14,7 +14,7 @@
* limitations under the License.
*/
package org.springframework.ws.soap.addressing;
package org.springframework.ws.soap.addressing.server;
import java.net.URI;
import java.net.URISyntaxException;
@@ -41,12 +41,12 @@ import org.springframework.beans.BeansException;
* The syntax is WS_ADDRESSING_ACTION=ENDPOINT_BEAN_NAME.
* <p/>
* If set, the {@link #setAddress(URI) address} property should be equal to the {@link
* MessageAddressingProperties#getTo() destination} property of the incominging message. As such, it can be used to
* create multiple Endpoint References, by defining multiple <code>SimpleActionEndpointMapping</code> bean definitions
* with different <code>address</code>property values.
* org.springframework.ws.soap.addressing.core.MessageAddressingProperties#getTo() destination} property of the
* incominging message. As such, it can be used to create multiple Endpoint References, by defining multiple
* <code>SimpleActionEndpointMapping</code> bean definitions with different <code>address</code> property values.
*
* @author Arjen Poutsma
* @see MessageAddressingProperties#getAction()
* @see org.springframework.ws.soap.addressing.core.MessageAddressingProperties#getAction()
* @since 1.5.0
*/
public class SimpleActionEndpointMapping extends AbstractActionEndpointMapping {
@@ -93,7 +93,8 @@ public class SimpleActionEndpointMapping extends AbstractActionEndpointMapping {
/**
* Set the address property. If set, value of this property is compared to the {@link
* MessageAddressingProperties#getTo() destination} property of the incominging message.
* org.springframework.ws.soap.addressing.core.MessageAddressingProperties#getTo() destination} property of the
* incominging message.
*
* @param address the address URI
*/
@@ -106,14 +107,6 @@ public class SimpleActionEndpointMapping extends AbstractActionEndpointMapping {
registerEndpoints(actionMap);
}
protected Object getEndpointInternal(URI to, URI action) {
// MAP address much match the defined EPR address
if (address != null && !address.equals(to)) {
return null;
}
return lookupEndpoint(action);
}
/**
* Register all endpoints specified in the action map.
*
@@ -139,4 +132,7 @@ public class SimpleActionEndpointMapping extends AbstractActionEndpointMapping {
}
}
protected URI getEndpointAddress(Object endpoint) {
return address;
}
}

5
core/src/main/java/org/springframework/ws/soap/addressing/server/package.html Normal file
View File

@@ -0,0 +1,5 @@
<html>
<body>
Contains servers-side WS-Addressing support, in the form of <code>EndpointMappings</code>.
</body>
</html>

5
core/src/main/java/org/springframework/ws/soap/addressing/version/package.html Normal file
View File

@@ -0,0 +1,5 @@
<html>
<body>
Contains abstractions over various versions of the WS-Addressing specification.
</body>
</html>

2
core/src/test/java/org/springframework/ws/soap/addressing/AbstractWsAddressingTestCase.java
View File

@@ -33,7 +33,7 @@ public abstract class AbstractWsAddressingTestCase extends XMLTestCase {
protected SaajSoapMessage loadSaajMessage(String fileName) throws SOAPException, IOException {
MimeHeaders mimeHeaders = new MimeHeaders();
mimeHeaders.addHeader("Content-Type", " application/soap+xml");
InputStream is = getClass().getResourceAsStream(fileName);
InputStream is = AbstractWsAddressingTestCase.class.getResourceAsStream(fileName);
assertNotNull("Could not load " + fileName, is);
try {
return new SaajSoapMessage(messageFactory.createMessage(mimeHeaders, is));