Browse Source

Clarified Spring 4.0's dependency on JAX-WS 2.1+ / JAXB 2.1+ in javadoc

pull/358/head
Juergen Hoeller 12 years ago
parent
commit
5e88fe5842
  1. 3
      spring-oxm/src/main/java/org/springframework/oxm/jaxb/Jaxb2Marshaller.java
  2. 111
      spring-web/src/main/java/org/springframework/remoting/jaxws/AbstractJaxWsServiceExporter.java
  3. 9
      spring-web/src/main/java/org/springframework/remoting/jaxws/JaxWsPortClientInterceptor.java
  4. 1
      spring-web/src/main/java/org/springframework/remoting/jaxws/LocalJaxWsServiceFactory.java

3
spring-oxm/src/main/java/org/springframework/oxm/jaxb/Jaxb2Marshaller.java

@ -100,7 +100,8 @@ import org.springframework.util.StringUtils; @@ -100,7 +100,8 @@ import org.springframework.util.StringUtils;
import org.springframework.util.xml.StaxUtils;
/**
* Implementation of the {@code Marshaller} interface for JAXB 2.0.
* Implementation of the {@code GenericMarshaller} interface for JAXB 2.1/2.2,
* as included in JDK 6 update 4+ and Java 7/8.
*
* <p>The typical usage will be to set either the "contextPath" or the "classesToBeBound"
* property on this bean, possibly customize the marshaller and unmarshaller by setting

111
spring-web/src/main/java/org/springframework/remoting/jaxws/AbstractJaxWsServiceExporter.java

@ -1,5 +1,5 @@ @@ -1,5 +1,5 @@
/*
* Copyright 2002-2012 the original author or authors.
* Copyright 2002-2013 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.
@ -16,7 +16,6 @@ @@ -16,7 +16,6 @@
package org.springframework.remoting.jaxws;
import java.lang.reflect.Method;
import java.util.Arrays;
import java.util.LinkedHashSet;
import java.util.Map;
@ -37,12 +36,11 @@ import org.springframework.beans.factory.ListableBeanFactory; @@ -37,12 +36,11 @@ import org.springframework.beans.factory.ListableBeanFactory;
import org.springframework.beans.factory.config.ConfigurableBeanFactory;
import org.springframework.util.Assert;
import org.springframework.util.ClassUtils;
import org.springframework.util.ReflectionUtils;
/**
* Abstract exporter for JAX-WS services, autodetecting annotated service beans
* (through the JAX-WS {@link javax.jws.WebService} annotation).
* Compatible with JAX-WS 2.0, 2.1 and 2.2.
* (through the JAX-WS {@link javax.jws.WebService} annotation). Compatible with
* JAX-WS 2.1 and 2.2, as included in JDK 6 update 4+ and Java 7/8.
*
* <p>Subclasses need to implement the {@link #publishEndpoint} template methods
* for actual endpoint exposure.
@ -62,6 +60,8 @@ public abstract class AbstractJaxWsServiceExporter implements BeanFactoryAware, @@ -62,6 +60,8 @@ public abstract class AbstractJaxWsServiceExporter implements BeanFactoryAware,
private String bindingType;
private WebServiceFeature[] endpointFeatures;
private Object[] webServiceFeatures;
private ListableBeanFactory beanFactory;
@ -97,11 +97,25 @@ public abstract class AbstractJaxWsServiceExporter implements BeanFactoryAware, @@ -97,11 +97,25 @@ public abstract class AbstractJaxWsServiceExporter implements BeanFactoryAware,
this.bindingType = bindingType;
}
/**
* Specify WebServiceFeature objects (e.g. as inner bean definitions)
* to apply to JAX-WS endpoint creation.
* @since 4.0
*/
public void setEndpointFeatures(WebServiceFeature... endpointFeatures) {
this.endpointFeatures = endpointFeatures;
}
/**
* Allows for providing JAX-WS 2.2 WebServiceFeature specifications:
* in the form of actual {@link javax.xml.ws.WebServiceFeature} objects,
* WebServiceFeature Class references, or WebServiceFeature class names.
* <p>As of Spring 4.0, this is effectively just an alternative way of
* specifying {@link #setEndpointFeatures "endpointFeatures"}. Do not specify
* both properties at the same time; prefer "endpointFeatures" moving forward.
* @deprecated as of Spring 4.0, in favor of {@link #setEndpointFeatures}
*/
@Deprecated
public void setWebServiceFeatures(Object[] webServiceFeatures) {
this.webServiceFeatures = webServiceFeatures;
}
@ -176,14 +190,48 @@ public abstract class AbstractJaxWsServiceExporter implements BeanFactoryAware, @@ -176,14 +190,48 @@ public abstract class AbstractJaxWsServiceExporter implements BeanFactoryAware,
* @see Endpoint#create(String, Object)
*/
protected Endpoint createEndpoint(Object bean) {
if (this.webServiceFeatures != null) {
return new FeatureEndpointProvider().createEndpoint(this.bindingType, bean, this.webServiceFeatures);
if (this.endpointFeatures != null || this.webServiceFeatures != null) {
WebServiceFeature[] endpointFeaturesToUse = this.endpointFeatures;
if (endpointFeaturesToUse == null) {
endpointFeaturesToUse = new WebServiceFeature[this.webServiceFeatures.length];
for (int i = 0; i < this.webServiceFeatures.length; i++) {
endpointFeaturesToUse[i] = convertWebServiceFeature(this.webServiceFeatures[i]);
}
}
return Endpoint.create(this.bindingType, bean, endpointFeaturesToUse);
}
else {
return Endpoint.create(this.bindingType, bean);
}
}
private WebServiceFeature convertWebServiceFeature(Object feature) {
Assert.notNull(feature, "WebServiceFeature specification object must not be null");
if (feature instanceof WebServiceFeature) {
return (WebServiceFeature) feature;
}
else if (feature instanceof Class) {
return (WebServiceFeature) BeanUtils.instantiate((Class<?>) feature);
}
else if (feature instanceof String) {
try {
Class<?> featureClass = getBeanClassLoader().loadClass((String) feature);
return (WebServiceFeature) BeanUtils.instantiate(featureClass);
}
catch (ClassNotFoundException ex) {
throw new IllegalArgumentException("Could not load WebServiceFeature class [" + feature + "]");
}
}
else {
throw new IllegalArgumentException("Unknown WebServiceFeature specification type: " + feature.getClass());
}
}
private ClassLoader getBeanClassLoader() {
return (beanFactory instanceof ConfigurableBeanFactory ?
((ConfigurableBeanFactory) beanFactory).getBeanClassLoader() : ClassUtils.getDefaultClassLoader());
}
/**
* Actually publish the given endpoint. To be implemented by subclasses.
@ -210,53 +258,4 @@ public abstract class AbstractJaxWsServiceExporter implements BeanFactoryAware, @@ -210,53 +258,4 @@ public abstract class AbstractJaxWsServiceExporter implements BeanFactoryAware,
}
}
/**
* Inner class in order to avoid a hard-coded JAX-WS 2.2 dependency.
* JAX-WS 2.0 and 2.1 didn't have WebServiceFeatures for endpoints yet...
*/
private class FeatureEndpointProvider {
public Endpoint createEndpoint(String bindingType, Object implementor, Object[] features) {
WebServiceFeature[] wsFeatures = new WebServiceFeature[features.length];
for (int i = 0; i < features.length; i++) {
wsFeatures[i] = convertWebServiceFeature(features[i]);
}
try {
Method create = Endpoint.class.getMethod("create", String.class, Object.class, WebServiceFeature[].class);
return (Endpoint) ReflectionUtils.invokeMethod(create, null, bindingType, implementor, wsFeatures);
}
catch (NoSuchMethodException ex) {
throw new IllegalStateException("JAX-WS 2.2 not available - cannot create feature endpoints", ex);
}
}
private WebServiceFeature convertWebServiceFeature(Object feature) {
Assert.notNull(feature, "WebServiceFeature specification object must not be null");
if (feature instanceof WebServiceFeature) {
return (WebServiceFeature) feature;
}
else if (feature instanceof Class) {
return (WebServiceFeature) BeanUtils.instantiate((Class<?>) feature);
}
else if (feature instanceof String) {
try {
Class<?> featureClass = getBeanClassLoader().loadClass((String) feature);
return (WebServiceFeature) BeanUtils.instantiate(featureClass);
}
catch (ClassNotFoundException ex) {
throw new IllegalArgumentException("Could not load WebServiceFeature class [" + feature + "]");
}
}
else {
throw new IllegalArgumentException("Unknown WebServiceFeature specification type: " + feature.getClass());
}
}
private ClassLoader getBeanClassLoader() {
return (beanFactory instanceof ConfigurableBeanFactory ?
((ConfigurableBeanFactory) beanFactory).getBeanClassLoader() : ClassUtils.getDefaultClassLoader());
}
}
}

9
spring-web/src/main/java/org/springframework/remoting/jaxws/JaxWsPortClientInterceptor.java

@ -1,5 +1,5 @@ @@ -1,5 +1,5 @@
/*
* Copyright 2002-2012 the original author or authors.
* Copyright 2002-2013 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.
@ -47,8 +47,9 @@ import org.springframework.util.ClassUtils; @@ -47,8 +47,9 @@ import org.springframework.util.ClassUtils;
import org.springframework.util.StringUtils;
/**
* {@link org.aopalliance.intercept.MethodInterceptor} for accessing a specific
* port of a JAX-WS service. Compatible with JAX-WS 2.1 and 2.2.
* {@link org.aopalliance.intercept.MethodInterceptor} for accessing a
* specific port of a JAX-WS service. Compatible with JAX-WS 2.1 and 2.2,
* as included in JDK 6 update 4+ and Java 7/8.
*
* <p>Uses either {@link LocalJaxWsServiceFactory}'s facilities underneath,
* or takes an explicit reference to an existing JAX-WS Service instance
@ -262,7 +263,7 @@ public class JaxWsPortClientInterceptor extends LocalJaxWsServiceFactory @@ -262,7 +263,7 @@ public class JaxWsPortClientInterceptor extends LocalJaxWsServiceFactory
/**
* Specify WebServiceFeature objects (e.g. as inner bean definitions)
* to apply to JAX-WS port stub creation.
* <p>Note: This mechanism requires a fully JAX-WS 2.1 compliant provider.
* @since 4.0
* @see Service#getPort(Class, javax.xml.ws.WebServiceFeature...)
* @see #setServiceFeatures
*/

1
spring-web/src/main/java/org/springframework/remoting/jaxws/LocalJaxWsServiceFactory.java

@ -115,6 +115,7 @@ public class LocalJaxWsServiceFactory { @@ -115,6 +115,7 @@ public class LocalJaxWsServiceFactory {
* Specify WebServiceFeature objects (e.g. as inner bean definitions)
* to apply to JAX-WS service creation.
* <p>Note: This mechanism requires JAX-WS 2.2 or higher.
* @since 4.0
* @see Service#create(QName, WebServiceFeature...)
*/
public void setServiceFeatures(WebServiceFeature... serviceFeatures) {

Loading…
Cancel
Save