From 5abfd69fc48204ace3f21d5e68b22b0939d418d1 Mon Sep 17 00:00:00 2001 From: Arjen Poutsma Date: Thu, 6 May 2010 11:24:38 +0000 Subject: [PATCH] Deprected abstract endpoint, in favor of the @Endpoint model and arbitrary parameter injection --- .../endpoint/AbstractDom4jPayloadEndpoint.java | 8 +++++--- .../endpoint/AbstractDomPayloadEndpoint.java | 8 +++++--- .../endpoint/AbstractJDomPayloadEndpoint.java | 8 +++++--- .../AbstractMarshallingPayloadEndpoint.java | 16 +++++++++------- .../endpoint/AbstractSaxPayloadEndpoint.java | 5 ++++- .../AbstractStaxEventPayloadEndpoint.java | 2 ++ .../endpoint/AbstractStaxPayloadEndpoint.java | 2 ++ .../AbstractStaxStreamPayloadEndpoint.java | 2 ++ .../endpoint/AbstractXomPayloadEndpoint.java | 2 ++ 9 files changed, 36 insertions(+), 17 deletions(-) diff --git a/core/src/main/java/org/springframework/ws/server/endpoint/AbstractDom4jPayloadEndpoint.java b/core/src/main/java/org/springframework/ws/server/endpoint/AbstractDom4jPayloadEndpoint.java index 6802c455..2203ec2f 100644 --- a/core/src/main/java/org/springframework/ws/server/endpoint/AbstractDom4jPayloadEndpoint.java +++ b/core/src/main/java/org/springframework/ws/server/endpoint/AbstractDom4jPayloadEndpoint.java @@ -1,5 +1,5 @@ /* - * Copyright 2006 the original author or authors. + * Copyright 2005-2010 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. @@ -20,6 +20,8 @@ import javax.xml.transform.Source; import javax.xml.transform.TransformerException; import javax.xml.transform.dom.DOMSource; +import org.springframework.xml.transform.TransformerObjectSupport; + import org.dom4j.Document; import org.dom4j.DocumentHelper; import org.dom4j.Element; @@ -28,8 +30,6 @@ import org.dom4j.io.DocumentResult; import org.dom4j.io.DocumentSource; import org.w3c.dom.Node; -import org.springframework.xml.transform.TransformerObjectSupport; - /** * Abstract base class for endpoints that handle the message payload as dom4j elements. Offers the message payload as a * dom4j Element, and allows subclasses to create a response by returning an Element. @@ -40,7 +40,9 @@ import org.springframework.xml.transform.TransformerObjectSupport; * @author Arjen Poutsma * @see org.dom4j.Element * @since 1.0.0 + * @deprecated as of Spring Web Services 2.0, in favor of annotated endpoints */ +@Deprecated public abstract class AbstractDom4jPayloadEndpoint extends TransformerObjectSupport implements PayloadEndpoint { private boolean alwaysTransform = false; diff --git a/core/src/main/java/org/springframework/ws/server/endpoint/AbstractDomPayloadEndpoint.java b/core/src/main/java/org/springframework/ws/server/endpoint/AbstractDomPayloadEndpoint.java index bac6ba0c..0c0ba289 100644 --- a/core/src/main/java/org/springframework/ws/server/endpoint/AbstractDomPayloadEndpoint.java +++ b/core/src/main/java/org/springframework/ws/server/endpoint/AbstractDomPayloadEndpoint.java @@ -1,5 +1,5 @@ /* - * Copyright 2005 the original author or authors. + * Copyright 2005-2010 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. @@ -24,12 +24,12 @@ import javax.xml.transform.TransformerException; import javax.xml.transform.dom.DOMResult; import javax.xml.transform.dom.DOMSource; +import org.springframework.xml.transform.TransformerObjectSupport; + import org.w3c.dom.Document; import org.w3c.dom.Element; import org.w3c.dom.Node; -import org.springframework.xml.transform.TransformerObjectSupport; - /** * Abstract base class for endpoints that handle the message payload as DOM elements. *

@@ -43,7 +43,9 @@ import org.springframework.xml.transform.TransformerObjectSupport; * @author Alef Arendsen * @see #invokeInternal(org.w3c.dom.Element,org.w3c.dom.Document) * @since 1.0.0 + * @deprecated as of Spring Web Services 2.0, in favor of annotated endpoints */ +@Deprecated public abstract class AbstractDomPayloadEndpoint extends TransformerObjectSupport implements PayloadEndpoint { private DocumentBuilderFactory documentBuilderFactory; diff --git a/core/src/main/java/org/springframework/ws/server/endpoint/AbstractJDomPayloadEndpoint.java b/core/src/main/java/org/springframework/ws/server/endpoint/AbstractJDomPayloadEndpoint.java index 587026f9..6be8d919 100644 --- a/core/src/main/java/org/springframework/ws/server/endpoint/AbstractJDomPayloadEndpoint.java +++ b/core/src/main/java/org/springframework/ws/server/endpoint/AbstractJDomPayloadEndpoint.java @@ -1,5 +1,5 @@ /* - * Copyright 2006 the original author or authors. + * Copyright 2005-2010 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. @@ -20,6 +20,8 @@ import javax.xml.transform.Source; import javax.xml.transform.TransformerException; import javax.xml.transform.dom.DOMSource; +import org.springframework.xml.transform.TransformerObjectSupport; + import org.jdom.Document; import org.jdom.Element; import org.jdom.input.DOMBuilder; @@ -27,8 +29,6 @@ import org.jdom.transform.JDOMResult; import org.jdom.transform.JDOMSource; import org.w3c.dom.Node; -import org.springframework.xml.transform.TransformerObjectSupport; - /** * Abstract base class for endpoints that handle the message payload as JDOM elements. *

@@ -40,7 +40,9 @@ import org.springframework.xml.transform.TransformerObjectSupport; * * @author Arjen Poutsma * @since 1.0.0 + * @deprecated as of Spring Web Services 2.0, in favor of annotated endpoints */ +@Deprecated public abstract class AbstractJDomPayloadEndpoint extends TransformerObjectSupport implements PayloadEndpoint { private boolean alwaysTransform = false; diff --git a/core/src/main/java/org/springframework/ws/server/endpoint/AbstractMarshallingPayloadEndpoint.java b/core/src/main/java/org/springframework/ws/server/endpoint/AbstractMarshallingPayloadEndpoint.java index b0e29d62..f1db2c02 100644 --- a/core/src/main/java/org/springframework/ws/server/endpoint/AbstractMarshallingPayloadEndpoint.java +++ b/core/src/main/java/org/springframework/ws/server/endpoint/AbstractMarshallingPayloadEndpoint.java @@ -18,9 +18,6 @@ package org.springframework.ws.server.endpoint; import java.io.IOException; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - import org.springframework.beans.factory.InitializingBean; import org.springframework.oxm.Marshaller; import org.springframework.oxm.Unmarshaller; @@ -29,6 +26,9 @@ import org.springframework.ws.WebServiceMessage; import org.springframework.ws.context.MessageContext; import org.springframework.ws.support.MarshallingUtils; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + /** * Endpoint that unmarshals the request payload, and marshals the response object. This endpoint needs a * Marshaller and Unmarshaller, both of which can be set using properties. An abstract @@ -41,7 +41,9 @@ import org.springframework.ws.support.MarshallingUtils; * @see Unmarshaller * @see #invokeInternal(Object) * @since 1.0.0 + * @deprecated as of Spring Web Services 2.0, in favor of annotated endpoints */ +@Deprecated public abstract class AbstractMarshallingPayloadEndpoint implements MessageEndpoint, InitializingBean { /** Logger available to subclasses. */ @@ -78,7 +80,7 @@ public abstract class AbstractMarshallingPayloadEndpoint implements MessageEndpo Assert.notNull(marshaller, "marshaller must not be null"); if (!(marshaller instanceof Unmarshaller)) { throw new IllegalArgumentException("Marshaller [" + marshaller + "] does not implement the Unmarshaller " + - "interface. Please set an Unmarshaller explicitely by using the " + + "interface. Please set an Unmarshaller explicitly by using the " + "AbstractMarshallingPayloadEndpoint(Marshaller, Unmarshaller) constructor."); } else { @@ -189,7 +191,7 @@ public abstract class AbstractMarshallingPayloadEndpoint implements MessageEndpo * The default implementation does nothing. * * @deprecated as of Spring Web Services 1.5: {@link #afterPropertiesSet()} is no longer final, so this can safely - * be overriden in subclasses + * be overridden in subclasses */ @Deprecated public void afterMarshallerSet() throws Exception { @@ -198,10 +200,10 @@ public abstract class AbstractMarshallingPayloadEndpoint implements MessageEndpo /** * Template method that subclasses must implement to process a request. *

- * The unmarshaled request object is passed as a parameter, and the returned object is marshalled to a response. If + * The unmarshalled request object is passed as a parameter, and the returned object is marshalled to a response. If * no response is required, return null. * - * @param requestObject the unnmarshalled message payload as an object + * @param requestObject the unmarshalled message payload as an object * @return the object to be marshalled as response, or null if a response is not required */ protected abstract Object invokeInternal(Object requestObject) throws Exception; diff --git a/core/src/main/java/org/springframework/ws/server/endpoint/AbstractSaxPayloadEndpoint.java b/core/src/main/java/org/springframework/ws/server/endpoint/AbstractSaxPayloadEndpoint.java index 1e99844b..88c31cce 100644 --- a/core/src/main/java/org/springframework/ws/server/endpoint/AbstractSaxPayloadEndpoint.java +++ b/core/src/main/java/org/springframework/ws/server/endpoint/AbstractSaxPayloadEndpoint.java @@ -1,5 +1,5 @@ /* - * Copyright 2005 the original author or authors. + * Copyright 2005-2010 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. @@ -20,6 +20,7 @@ import javax.xml.transform.Source; import javax.xml.transform.sax.SAXResult; import org.springframework.xml.transform.TransformerObjectSupport; + import org.xml.sax.ContentHandler; /** @@ -34,7 +35,9 @@ import org.xml.sax.ContentHandler; * @see #createContentHandler() * @see #getResponse(org.xml.sax.ContentHandler) * @since 1.0.0 + * @deprecated as of Spring Web Services 2.0, in favor of annotated endpoints */ +@Deprecated public abstract class AbstractSaxPayloadEndpoint extends TransformerObjectSupport implements PayloadEndpoint { /** diff --git a/core/src/main/java/org/springframework/ws/server/endpoint/AbstractStaxEventPayloadEndpoint.java b/core/src/main/java/org/springframework/ws/server/endpoint/AbstractStaxEventPayloadEndpoint.java index ea4d8557..f986b6e7 100644 --- a/core/src/main/java/org/springframework/ws/server/endpoint/AbstractStaxEventPayloadEndpoint.java +++ b/core/src/main/java/org/springframework/ws/server/endpoint/AbstractStaxEventPayloadEndpoint.java @@ -46,7 +46,9 @@ import org.springframework.xml.transform.TraxUtils; * @see XMLEventReader * @see XMLEventWriter * @since 1.0.0 + * @deprecated as of Spring Web Services 2.0, in favor of annotated endpoints */ +@Deprecated @SuppressWarnings("Since15") public abstract class AbstractStaxEventPayloadEndpoint extends AbstractStaxPayloadEndpoint implements MessageEndpoint { diff --git a/core/src/main/java/org/springframework/ws/server/endpoint/AbstractStaxPayloadEndpoint.java b/core/src/main/java/org/springframework/ws/server/endpoint/AbstractStaxPayloadEndpoint.java index 7eb957c5..9c48c0c8 100644 --- a/core/src/main/java/org/springframework/ws/server/endpoint/AbstractStaxPayloadEndpoint.java +++ b/core/src/main/java/org/springframework/ws/server/endpoint/AbstractStaxPayloadEndpoint.java @@ -29,7 +29,9 @@ import org.springframework.xml.transform.TransformerObjectSupport; * @see XMLInputFactory * @see XMLOutputFactory * @since 1.0.0 + * @deprecated as of Spring Web Services 2.0, in favor of annotated endpoints */ +@Deprecated @SuppressWarnings("Since15") public abstract class AbstractStaxPayloadEndpoint extends TransformerObjectSupport { diff --git a/core/src/main/java/org/springframework/ws/server/endpoint/AbstractStaxStreamPayloadEndpoint.java b/core/src/main/java/org/springframework/ws/server/endpoint/AbstractStaxStreamPayloadEndpoint.java index 60bd1039..0b138f4a 100644 --- a/core/src/main/java/org/springframework/ws/server/endpoint/AbstractStaxStreamPayloadEndpoint.java +++ b/core/src/main/java/org/springframework/ws/server/endpoint/AbstractStaxStreamPayloadEndpoint.java @@ -43,7 +43,9 @@ import org.springframework.xml.transform.TraxUtils; * @see XMLStreamReader * @see XMLStreamWriter * @since 1.0.0 + * @deprecated as of Spring Web Services 2.0, in favor of annotated endpoints */ +@Deprecated @SuppressWarnings("Since15") public abstract class AbstractStaxStreamPayloadEndpoint extends AbstractStaxPayloadEndpoint implements MessageEndpoint { diff --git a/core/src/main/java/org/springframework/ws/server/endpoint/AbstractXomPayloadEndpoint.java b/core/src/main/java/org/springframework/ws/server/endpoint/AbstractXomPayloadEndpoint.java index 4d837e0c..9738fab7 100644 --- a/core/src/main/java/org/springframework/ws/server/endpoint/AbstractXomPayloadEndpoint.java +++ b/core/src/main/java/org/springframework/ws/server/endpoint/AbstractXomPayloadEndpoint.java @@ -60,7 +60,9 @@ import org.xml.sax.XMLReader; * @author Arjen Poutsma * @see Element * @since 1.0.0 + * @deprecated as of Spring Web Services 2.0, in favor of annotated endpoints */ +@Deprecated @SuppressWarnings("Since15") public abstract class AbstractXomPayloadEndpoint extends TransformerObjectSupport implements PayloadEndpoint {