Added @since tags.

This commit is contained in:
Arjen Poutsma
2007-08-16 22:46:15 +00:00
parent 98a1db0f99
commit 2cabff12db
207 changed files with 300 additions and 170 deletions

View File

@@ -25,6 +25,7 @@ import org.springframework.ws.soap.SoapMessage;
*
* @author Arjen Poutsma
* @see SoapMessage
* @since 1.0
*/
public interface FaultAwareWebServiceMessage extends WebServiceMessage {

View File

@@ -20,6 +20,7 @@ package org.springframework.ws;
* Exception thrown when an endpoint cannot be resolved for an incoming message request.
*
* @author Arjen Poutsma
* @since 1.0
*/
public final class NoEndpointFoundException extends WebServiceException {

View File

@@ -16,20 +16,21 @@
package org.springframework.ws;
import org.springframework.core.NestedRuntimeException;
import java.io.Serializable;
import org.springframework.core.NestedRuntimeException;
/**
* Root of the hierarchy of Web Service exceptions.
*
* @author Arjen Poutsma
* @since 1.0
*/
public abstract class WebServiceException
extends NestedRuntimeException implements Serializable {
public abstract class WebServiceException extends NestedRuntimeException implements Serializable {
/**
* Create a new instance of the <code>WebServiceException</code> class.
*
* @param msg the detail message
*/
public WebServiceException(String msg) {
@@ -38,6 +39,7 @@ public abstract class WebServiceException
/**
* Create a new instance of the <code>WebServiceException</code> class.
*
* @param msg the detail message
* @param ex the root {@link Throwable exception}
*/

View File

@@ -29,6 +29,7 @@ import javax.xml.transform.Source;
* @author Arjen Poutsma
* @see org.springframework.ws.soap.SoapMessage
* @see WebServiceMessageFactory
* @since 1.0
*/
public interface WebServiceMessage {

View File

@@ -20,19 +20,16 @@ package org.springframework.ws;
* Base class for all web service message exceptions.
*
* @author Arjen Poutsma
* @since 1.0
*/
public abstract class WebServiceMessageException extends WebServiceException {
/**
* Constructor for <code>WebServiceMessageException</code>.
*/
/** Constructor for <code>WebServiceMessageException</code>. */
public WebServiceMessageException(String msg) {
super(msg);
}
/**
* Constructor for <code>WebServiceMessageException</code>.
*/
/** Constructor for <code>WebServiceMessageException</code>. */
public WebServiceMessageException(String msg, Throwable ex) {
super(msg, ex);
}

View File

@@ -20,13 +20,14 @@ import java.io.IOException;
import java.io.InputStream;
/**
* The <code>WebServiceMessageFactory</code> serves as a factory for
* {@link org.springframework.ws.WebServiceMessage WebServiceMessages}.
*
* The <code>WebServiceMessageFactory</code> serves as a factory for {@link org.springframework.ws.WebServiceMessage
* WebServiceMessages}.
* <p/>
* <p>Allows the creation of empty messages, or messages based on <code>InputStream</code>s.
*
* @author Arjen Poutsma
* @see org.springframework.ws.WebServiceMessage
* @since 1.0
*/
public interface WebServiceMessageFactory {
@@ -40,9 +41,8 @@ public interface WebServiceMessageFactory {
/**
* Reads a {@link WebServiceMessage} from the given input stream.
* <p/>
* If the given stream is an instance of
* {@link org.springframework.ws.transport.TransportInputStream TransportInputStream},
* the headers will be read from the request.
* If the given stream is an instance of {@link org.springframework.ws.transport.TransportInputStream
* TransportInputStream}, the headers will be read from the request.
*
* @param inputStream the inputstream to read the message from
* @return the created message

View File

@@ -22,11 +22,13 @@ import org.springframework.ws.WebServiceException;
* Exception thrown whenever an error occurs on the client-side.
*
* @author Arjen Poutsma
* @since 1.0
*/
public abstract class WebServiceClientException extends WebServiceException {
/**
* Create a new instance of the <code>WebServiceClientException</code> class.
*
* @param msg the detail message
*/
public WebServiceClientException(String msg) {
@@ -35,6 +37,7 @@ public abstract class WebServiceClientException extends WebServiceException {
/**
* Create a new instance of the <code>WebServiceClientException</code> class.
*
* @param msg the detail message
* @param ex the root {@link Throwable exception}
*/

View File

@@ -22,6 +22,7 @@ import org.springframework.ws.FaultAwareWebServiceMessage;
* Thrown by <code>SimpleFaultMessageResolver</code> when the response message has a fault.
*
* @author Arjen Poutsma
* @since 1.0
*/
public class WebServiceFaultException extends WebServiceClientException {

View File

@@ -22,11 +22,13 @@ import java.io.IOException;
* Exception thrown whenever an I/O error occurs on the client-side.
*
* @author Arjen Poutsma
* @since 1.0
*/
public class WebServiceIOException extends WebServiceClientException {
/**
* Create a new instance of the <code>WebServiceIOException</code> class.
*
* @param msg the detail message
*/
public WebServiceIOException(String msg) {
@@ -35,6 +37,7 @@ public class WebServiceIOException extends WebServiceClientException {
/**
* Create a new instance of the <code>WebServiceIOException</code> class.
*
* @param msg the detail message
* @param ex the root {@link IOException}
*/

View File

@@ -22,11 +22,13 @@ import javax.xml.transform.TransformerException;
* Exception thrown whenever a transformation error occurs <i>on the client-side</i>.
*
* @author Arjen Poutsma
* @since 1.0
*/
public class WebServiceTransformerException extends WebServiceClientException {
/**
* Create a new instance of the <code>WebServiceTransformerException</code> class.
*
* @param msg the detail message
*/
public WebServiceTransformerException(String msg) {
@@ -35,6 +37,7 @@ public class WebServiceTransformerException extends WebServiceClientException {
/**
* Create a new instance of the <code>WebServiceTransformerException</code> class.
*
* @param msg the detail message
* @param ex the root {@link Throwable exception}
*/

View File

@@ -22,11 +22,13 @@ import org.springframework.ws.transport.TransportException;
* Exception thrown whenever a transport error occurs on the client-side.
*
* @author Arjen Poutsma
* @since 1.0
*/
public class WebServiceTransportException extends WebServiceIOException {
/**
* Create a new instance of the <code>WebServiceTransportException</code> class.
*
* @param msg the detail message
*/
public WebServiceTransportException(String msg) {
@@ -35,6 +37,7 @@ public class WebServiceTransportException extends WebServiceIOException {
/**
* Create a new instance of the <code>WebServiceTransportException</code> class.
*
* @param msg the detail message
* @param ex the root {@link TransportException}
*/

View File

@@ -24,6 +24,7 @@ import org.springframework.ws.WebServiceMessage;
* Defines the interface for objects than can resolve fault {@link WebServiceMessage}.
*
* @author Arjen Poutsma
* @since 1.0
*/
public interface FaultMessageResolver {

View File

@@ -25,6 +25,7 @@ import org.springframework.ws.client.WebServiceFaultException;
*
* @author Arjen Poutsma
* @see WebServiceFaultException
* @since 1.0
*/
public class SimpleFaultMessageResolver implements FaultMessageResolver {

View File

@@ -33,6 +33,7 @@ import javax.xml.transform.TransformerException;
*
* @author Arjen Poutsma
* @see org.springframework.ws.client.core.WebServiceTemplate
* @since 1.0
*/
public interface SourceExtractor {

View File

@@ -28,6 +28,7 @@ import org.springframework.ws.WebServiceMessage;
* the <code>SOAPAction</code> header.
*
* @author Arjen Poutsma
* @since 1.0
*/
public interface WebServiceMessageCallback {

View File

@@ -33,6 +33,7 @@ import org.springframework.ws.WebServiceMessage;
* exception handling, or resource handling.
*
* @author Arjen Poutsma
* @since 1.0
*/
public interface WebServiceMessageExtractor {

View File

@@ -28,6 +28,7 @@ import org.springframework.ws.client.WebServiceClientException;
*
* @author Arjen Poutsma
* @see WebServiceTemplate
* @since 1.0
*/
public interface WebServiceOperations {

View File

@@ -40,6 +40,7 @@ import org.springframework.ws.transport.WebServiceMessageSender;
* @see #setMessageFactory(org.springframework.ws.WebServiceMessageFactory)
* @see org.springframework.ws.client.core.WebServiceTemplate
* @see #setMarshaller(org.springframework.oxm.Marshaller)
* @since 1.0
*/
public abstract class WebServiceGatewaySupport implements InitializingBean {

View File

@@ -33,6 +33,7 @@ import org.springframework.xml.transform.TransformerObjectSupport;
*
* @author Arjen Poutsma
* @see org.springframework.ws.client.core.WebServiceTemplate
* @since 1.0
*/
public abstract class WebServiceAccessor extends TransformerObjectSupport implements InitializingBean {

View File

@@ -23,6 +23,7 @@ import java.util.Map;
* Abstract base class for {@link MessageContext instances}.
*
* @author Arjen Poutsma
* @since 1.0
*/
public abstract class AbstractMessageContext implements MessageContext {

View File

@@ -27,6 +27,7 @@ import org.springframework.ws.WebServiceMessageFactory;
* Default implementation of <code>MessageContext</code>.
*
* @author Arjen Poutsma
* @since 1.0
*/
public class DefaultMessageContext extends AbstractMessageContext {

View File

@@ -23,11 +23,12 @@ import org.springframework.ws.WebServiceMessage;
/**
* Context holder for message requests.
*
* <p>Contains both the message request as well as the response. Response message are
* usually lazily created (but do not have to be).
* <p/>
* <p>Contains both the message request as well as the response. Response message are usually lazily created (but do not
* have to be).
*
* @author Arjen Poutsma
* @since 1.0
*/
public interface MessageContext {

View File

@@ -32,6 +32,7 @@ import org.springframework.util.Assert;
* Abstract implementation of the {@link MimeMessage} interface. Contains convenient default implementations.
*
* @author Arjen Poutsma
* @since 1.0
*/
public abstract class AbstractMimeMessage implements MimeMessage {
@@ -57,6 +58,7 @@ public abstract class AbstractMimeMessage implements MimeMessage {
* Activation framework <code>DataSource</code> that wraps a Spring <code>InputStreamSource</code>.
*
* @author Arjen Poutsma
* @since 1.0
*/
private static class InputStreamSourceDataSource implements DataSource {

View File

@@ -26,6 +26,7 @@ import javax.activation.DataHandler;
* @author Arjen Poutsma
* @see MimeMessage#getAttachments()
* @see MimeMessage#addAttachment
* @since 1.0
*/
public interface Attachment {

View File

@@ -23,6 +23,7 @@ import org.springframework.ws.WebServiceMessageException;
*
* @author Arjen Poutsma
* @see Attachment
* @since 1.0
*/
public class AttachmentException extends WebServiceMessageException {

View File

@@ -13,6 +13,7 @@ import org.springframework.ws.WebServiceMessage;
*
* @author Arjen Poutsma
* @see Attachment
* @since 1.0
*/
public interface MimeMessage extends WebServiceMessage {

View File

@@ -22,6 +22,7 @@ import org.springframework.ws.WebServiceMessage;
* Defines the contract for Plain Old XML messages. Currently only a tagging interface.
*
* @author Arjen Poutsma
* @since 1.0
*/
public interface PoxMessage extends WebServiceMessage {

View File

@@ -22,6 +22,7 @@ import org.springframework.ws.WebServiceMessageException;
* Specific subclass of <code>WebServiceMessageException</code> for Plain Old XML messages.
*
* @author Arjen Poutsma
* @since 1.0
*/
public abstract class PoxMessageException extends WebServiceMessageException {

View File

@@ -39,6 +39,7 @@ import org.w3c.dom.Element;
*
* @author Arjen Poutsma
* @see Document
* @since 1.0
*/
public class DomPoxMessage implements PoxMessage {

View File

@@ -22,6 +22,7 @@ import org.springframework.ws.pox.PoxMessageException;
* Specific subclass of <code>PoxMessageException</code> for DOM Plain Old XML messages.
*
* @author Arjen Poutsma
* @since 1.0
*/
public class DomPoxMessageException extends PoxMessageException {

View File

@@ -35,6 +35,7 @@ import org.xml.sax.SAXException;
*
* @author Arjen Poutsma
* @see org.springframework.ws.pox.dom.DomPoxMessage
* @since 1.0
*/
public class DomPoxMessageFactory extends TransformerObjectSupport implements WebServiceMessageFactory {

View File

@@ -22,18 +22,19 @@ import org.springframework.ws.context.MessageContext;
* Interface that must be implemented for each endpoint type to handle a message request. This interface is used to
* allow the <code>MessageDispatcher</code> to be indefinitely extensible. It accesses all installed endpoints through
* this interface, meaning that is does not contain code specific to any endpoint type.
*
* <p/>
* <p>This interface is not intended for application developers. It is available for those who want to develop their own
* message flow.
*
* @author Arjen Poutsma
* @see MessageDispatcher
* @since 1.0
*/
public interface EndpointAdapter {
/**
* Does this <code>EndpointAdapter</code> support the given <code>endpoint</code>?
*
* <p/>
* <p>Typical <code>EndpointAdapters</code> will base the decision on the endpoint type.
*
* @param endpoint endpoint object to check
@@ -45,8 +46,8 @@ public interface EndpointAdapter {
* Use the given <code>endpoint</code> to handle the request.
*
* @param messageContext the current message context
* @param endpoint the endpoint to use. This object must have previously been passed to the
* {@link #supports(Object)} method of this interface, which must have returned <code>true</code>
* @param endpoint the endpoint to use. This object must have previously been passed to the {@link
* #supports(Object)} method of this interface, which must have returned <code>true</code>
* @throws Exception in case of errors
*/
void invoke(MessageContext messageContext, Object endpoint) throws Exception;

View File

@@ -23,6 +23,7 @@ import org.springframework.ws.context.MessageContext;
* messages.
*
* @author Arjen Poutsma
* @since 1.0
*/
public interface EndpointExceptionResolver {

View File

@@ -37,6 +37,7 @@ import org.springframework.ws.context.MessageContext;
* @see EndpointInvocationChain#getInterceptors()
* @see org.springframework.ws.server.endpoint.interceptor.EndpointInterceptorAdapter
* @see org.springframework.ws.server.endpoint.mapping.AbstractEndpointMapping#setInterceptors(EndpointInterceptor[])
* @since 1.0
*/
public interface EndpointInterceptor {

View File

@@ -21,6 +21,7 @@ package org.springframework.ws.server;
*
* @author Arjen Poutsma
* @see EndpointInterceptor
* @since 1.0
*/
public class EndpointInvocationChain {

View File

@@ -34,6 +34,7 @@ import org.springframework.ws.context.MessageContext;
* @see org.springframework.ws.server.endpoint.mapping.AbstractEndpointMapping
* @see org.springframework.ws.server.endpoint.mapping.PayloadRootQNameEndpointMapping
* @see org.springframework.ws.soap.server.endpoint.mapping.SoapActionEndpointMapping
* @since 1.0
*/
public interface EndpointMapping {
@@ -45,9 +46,9 @@ public interface EndpointMapping {
* so that endpoints are not constrained in any way. For example, a <code>EndpointAdapter</code> could be written to
* allow another framework's endpoint objects to be used.
* <p/>
* Returns <code>null</code> if no match was found. This is by design. The <code>MessageDispatcher</code> will
* query all registered <code>EndpointMapping</code> beans to find a match, and only decide there is an error if
* none can find an endpoint.
* Returns <code>null</code> if no match was found. This is by design. The <code>MessageDispatcher</code> will query
* all registered <code>EndpointMapping</code> beans to find a match, and only decide there is an error if none can
* find an endpoint.
*
* @return a HandlerExecutionChain instance containing endpoint object and any interceptors, or <code>null</code> if
* no mapping is found

View File

@@ -70,6 +70,7 @@ import org.springframework.ws.transport.support.DefaultStrategiesHelper;
* @see EndpointAdapter
* @see EndpointExceptionResolver
* @see org.springframework.web.servlet.DispatcherServlet
* @since 1.0
*/
public class MessageDispatcher implements WebServiceMessageReceiver, BeanNameAware, ApplicationContextAware {

View File

@@ -34,6 +34,7 @@ import org.springframework.xml.transform.TransformerObjectSupport;
*
* @author Arjen Poutsma
* @see org.dom4j.Element
* @since 1.0
*/
public abstract class AbstractDom4jPayloadEndpoint extends TransformerObjectSupport implements PayloadEndpoint {

View File

@@ -39,6 +39,7 @@ import org.w3c.dom.Element;
* @author Arjen Poutsma
* @author Alef Arendsen
* @see #invokeInternal(org.w3c.dom.Element,org.w3c.dom.Document)
* @since 1.0
*/
public abstract class AbstractDomPayloadEndpoint extends TransformerObjectSupport implements PayloadEndpoint {

View File

@@ -30,6 +30,7 @@ import org.springframework.ws.server.EndpointExceptionResolver;
* <p>Provides a set of mapped endpoints that the resolver should map.
*
* @author Arjen Poutsma
* @since 1.0
*/
public abstract class AbstractEndpointExceptionResolver implements EndpointExceptionResolver, Ordered {

View File

@@ -33,6 +33,7 @@ import org.springframework.xml.transform.TransformerObjectSupport;
* are not in accordance with WS-I.
*
* @author Arjen Poutsma
* @since 1.0
*/
public abstract class AbstractJDomPayloadEndpoint extends TransformerObjectSupport implements PayloadEndpoint {

View File

@@ -35,6 +35,7 @@ import org.springframework.xml.transform.TransformerObjectSupport;
* changed using the <code>logRequest</code> and <code>logResponse</code> properties.
*
* @author Arjen Poutsma
* @since 1.0
*/
public abstract class AbstractLoggingInterceptor extends TransformerObjectSupport implements EndpointInterceptor {

View File

@@ -39,6 +39,7 @@ import org.springframework.ws.support.MarshallingUtils;
* @see #setUnmarshaller(org.springframework.oxm.Unmarshaller)
* @see Unmarshaller
* @see #invokeInternal(Object)
* @since 1.0
*/
public abstract class AbstractMarshallingPayloadEndpoint implements MessageEndpoint, InitializingBean {

View File

@@ -33,6 +33,7 @@ import org.xml.sax.ContentHandler;
* @author Arjen Poutsma
* @see #createContentHandler()
* @see #getResponse(org.xml.sax.ContentHandler)
* @since 1.0
*/
public abstract class AbstractSaxPayloadEndpoint extends TransformerObjectSupport implements PayloadEndpoint {

View File

@@ -45,6 +45,7 @@ import org.springframework.xml.transform.StaxSource;
*javax.xml.stream.XMLEventFactory)
* @see XMLEventReader
* @see XMLEventWriter
* @since 1.0
*/
public abstract class AbstractStaxEventPayloadEndpoint extends AbstractStaxPayloadEndpoint implements MessageEndpoint {

View File

@@ -28,6 +28,7 @@ import org.springframework.xml.transform.TransformerObjectSupport;
* @author Arjen Poutsma
* @see XMLInputFactory
* @see XMLOutputFactory
* @since 1.0
*/
public abstract class AbstractStaxPayloadEndpoint extends TransformerObjectSupport {
@@ -35,9 +36,7 @@ public abstract class AbstractStaxPayloadEndpoint extends TransformerObjectSuppo
private XMLOutputFactory outputFactory;
/**
* Returns an <code>XMLInputFactory</code> to read XML from.
*/
/** Returns an <code>XMLInputFactory</code> to read XML from. */
protected final XMLInputFactory getInputFactory() {
if (inputFactory == null) {
inputFactory = createXmlInputFactory();
@@ -45,9 +44,7 @@ public abstract class AbstractStaxPayloadEndpoint extends TransformerObjectSuppo
return inputFactory;
}
/**
* Returns an <code>XMLOutputFactory</code> to write XML to.
*/
/** Returns an <code>XMLOutputFactory</code> to write XML to. */
protected final XMLOutputFactory getOutputFactory() {
if (outputFactory == null) {
outputFactory = createXmlOutputFactory();

View File

@@ -42,6 +42,7 @@ import org.springframework.xml.transform.StaxSource;
* @see #invokeInternal(javax.xml.stream.XMLStreamReader,javax.xml.stream.XMLStreamWriter)
* @see XMLStreamReader
* @see XMLStreamWriter
* @since 1.0
*/
public abstract class AbstractStaxStreamPayloadEndpoint extends AbstractStaxPayloadEndpoint implements MessageEndpoint {

View File

@@ -54,6 +54,7 @@ import org.xml.sax.InputSource;
*
* @author Arjen Poutsma
* @see Element
* @since 1.0
*/
public abstract class AbstractXomPayloadEndpoint extends TransformerObjectSupport implements PayloadEndpoint {

View File

@@ -20,18 +20,19 @@ import org.springframework.ws.context.MessageContext;
/**
* Defines the basic contract for Web Services interested in the entire message payload.
*
* <p/>
* <p>The main entrypoint is {@link #invoke(MessageContext)}, which gets invoked with the message context. This context
* contains the {@link MessageContext#getRequest() request}, and can be used to create a response.
*
* @author Arjen Poutsma
* @see org.springframework.ws.server.endpoint.PayloadEndpoint
* @since 1.0
*/
public interface MessageEndpoint {
/**
* Invokes an operation.
*
* <p/>
* <p>The given <code>messageContext</code> can be used to create a response.
*
* @param messageContext the message context

View File

@@ -27,6 +27,7 @@ import org.springframework.util.Assert;
* Consists of a {@link Method}, and a bean {@link Object}.
*
* @author Arjen Poutsma
* @since 1.0
*/
public final class MethodEndpoint {

View File

@@ -24,6 +24,7 @@ import javax.xml.transform.Source;
* The main entrypoint is {@link #invoke(Source)}, which gets invoked with the contents of the requesting message.
*
* @author Arjen Poutsma
* @since 1.0
*/
public interface PayloadEndpoint {

View File

@@ -28,6 +28,7 @@ import org.springframework.xml.transform.TransformerObjectSupport;
* template methods for handling these method endpoints.
*
* @author Arjen Poutsma
* @since 1.0
*/
public abstract class AbstractMethodEndpointAdapter extends TransformerObjectSupport implements EndpointAdapter {

View File

@@ -48,6 +48,7 @@ import org.springframework.ws.support.MarshallingUtils;
* @author Arjen Poutsma
* @see #setMarshaller(org.springframework.oxm.Marshaller)
* @see #setUnmarshaller(org.springframework.oxm.Unmarshaller)
* @since 1.0
*/
public class MarshallingMethodEndpointAdapter extends AbstractMethodEndpointAdapter implements InitializingBean {

View File

@@ -29,6 +29,7 @@ import org.springframework.ws.soap.server.SoapMessageDispatcher;
*
* @author Arjen Poutsma
* @see org.springframework.ws.server.EndpointInvocationChain
* @since 1.0
*/
public class MessageEndpointAdapter implements EndpointAdapter {

View File

@@ -34,6 +34,7 @@ import org.springframework.ws.soap.server.SoapMessageDispatcher;
* This adapter is registered by default by the {@link MessageDispatcher} and {@link SoapMessageDispatcher}.
*
* @author Arjen Poutsma
* @since 1.0
*/
public class MessageMethodEndpointAdapter extends AbstractMethodEndpointAdapter {

View File

@@ -34,6 +34,7 @@ import org.springframework.xml.transform.TransformerObjectSupport;
* @author Arjen Poutsma
* @see org.springframework.ws.server.endpoint.PayloadEndpoint
* @see org.springframework.ws.server.EndpointInvocationChain
* @since 1.0
*/
public class PayloadEndpointAdapter extends TransformerObjectSupport implements EndpointAdapter {

View File

@@ -40,6 +40,7 @@ import org.springframework.ws.soap.server.SoapMessageDispatcher;
* This adapter is registered by default by the {@link MessageDispatcher} and {@link SoapMessageDispatcher}.
*
* @author Arjen Poutsma
* @since 1.0
*/
public class PayloadMethodEndpointAdapter extends AbstractMethodEndpointAdapter {

View File

@@ -47,6 +47,7 @@ import org.xml.sax.SAXParseException;
* @author Arjen Poutsma
* @see #getValidationRequestSource(org.springframework.ws.WebServiceMessage)
* @see #getValidationResponseSource(org.springframework.ws.WebServiceMessage)
* @since 1.0
*/
public abstract class AbstractValidatingInterceptor extends TransformerObjectSupport
implements EndpointInterceptor, InitializingBean {

View File

@@ -27,17 +27,14 @@ import org.w3c.dom.Element;
* pre-only/post-only interceptors.
*
* @author Arjen Poutsma
* @since 1.0
*/
public class EndpointInterceptorAdapter implements EndpointInterceptor {
/**
* Logger available to subclasses
*/
/** Logger available to subclasses */
protected final Log logger = LogFactory.getLog(getClass());
/**
* Returns <code>false</code>.
*/
/** Returns <code>false</code>. */
public boolean understands(Element header) {
return false;
}

View File

@@ -22,16 +22,16 @@ import org.springframework.ws.WebServiceMessage;
import org.springframework.ws.server.endpoint.AbstractLoggingInterceptor;
/**
* Simple {@link org.springframework.ws.server.EndpointInterceptor EndpointInterceptor}
* that logs the payload of request and response messages.
*
* <p>By default, both request and response messages are logged, but this behaviour
* can be changed using the {@link #logRequest} and {@link #logResponse}
* properties.
* Simple {@link org.springframework.ws.server.EndpointInterceptor EndpointInterceptor} that logs the payload of request
* and response messages.
* <p/>
* <p>By default, both request and response messages are logged, but this behaviour can be changed using the {@link
* #logRequest} and {@link #logResponse} properties.
*
* @author Arjen Poutsma
* @see #setLogRequest(boolean)
* @see #setLogResponse(boolean)
* @since 1.0
*/
public class PayloadLoggingInterceptor extends AbstractLoggingInterceptor {

View File

@@ -43,6 +43,7 @@ import org.springframework.xml.transform.ResourceSource;
* @author Arjen Poutsma
* @see #setRequestXslt(org.springframework.core.io.Resource)
* @see #setResponseXslt(org.springframework.core.io.Resource)
* @since 1.0
*/
public class PayloadTransformingInterceptor implements EndpointInterceptor, InitializingBean {

View File

@@ -29,6 +29,7 @@ import org.springframework.ws.server.EndpointMapping;
* @author Arjen Poutsma
* @see #getEndpointInternal(org.springframework.ws.context.MessageContext)
* @see org.springframework.ws.server.EndpointInterceptor
* @since 1.0
*/
public abstract class AbstractEndpointMapping extends ApplicationObjectSupport implements EndpointMapping, Ordered {

View File

@@ -34,6 +34,7 @@ import org.springframework.ws.context.MessageContext;
* result of a XPath validation. The values are always endpoint objects, or bean names of endpoint objects.
*
* @author Arjen Poutsma
* @since 1.0
*/
public abstract class AbstractMapBasedEndpointMapping extends AbstractEndpointMapping {

View File

@@ -36,6 +36,7 @@ import org.springframework.ws.server.endpoint.MethodEndpoint;
* #registerEndpoint(String,MethodEndpoint)}.
*
* @author Arjen Poutsma
* @since 1.0
*/
public abstract class AbstractMethodEndpointMapping extends AbstractEndpointMapping {

View File

@@ -25,6 +25,7 @@ import org.springframework.xml.namespace.QNameUtils;
* Abstract base class for <code>EndpointMapping</code>s that resolve qualified names as registration keys.
*
* @author Arjen Poutsma
* @since 1.0
*/
public abstract class AbstractQNameEndpointMapping extends AbstractMapBasedEndpointMapping {

View File

@@ -42,6 +42,7 @@ import org.springframework.ws.server.endpoint.support.PayloadRootUtils;
*
* @author Arjen Poutsma
* @see org.springframework.xml.namespace.QNameEditor
* @since 1.0
*/
public class PayloadRootQNameEndpointMapping extends AbstractQNameEndpointMapping {

View File

@@ -45,6 +45,7 @@ import org.springframework.ws.server.endpoint.support.PayloadRootUtils;
*
* @author Arjen Poutsma
* @see #setEndpoints(Object[])
* @since 1.0
*/
public class SimpleMethodEndpointMapping extends AbstractMethodEndpointMapping implements InitializingBean {

View File

@@ -54,6 +54,7 @@ import org.w3c.dom.Element;
* @author Arjen Poutsma
* @see #setExpression(String)
* @see #setNamespaces(java.util.Properties)
* @since 1.0
*/
public class XPathPayloadEndpointMapping extends AbstractMapBasedEndpointMapping implements InitializingBean {
@@ -65,16 +66,12 @@ public class XPathPayloadEndpointMapping extends AbstractMapBasedEndpointMapping
private TransformerFactory transformerFactory;
/**
* Sets the XPath expression to be used.
*/
/** Sets the XPath expression to be used. */
public void setExpression(String expression) {
expressionString = expression;
}
/**
* Sets the namespaces bindings used in the expression. Keys are prefixes, values are namespaces.
*/
/** Sets the namespaces bindings used in the expression. Keys are prefixes, values are namespaces. */
public void setNamespaces(Properties namespaces) {
this.namespaces = namespaces;
}

View File

@@ -35,6 +35,7 @@ import org.w3c.dom.Node;
* Helper class for determining the root qualified name of a Web Service payload.
*
* @author Arjen Poutsma
* @since 1.0
*/
public abstract class PayloadRootUtils {

View File

@@ -25,6 +25,7 @@ import org.springframework.ws.mime.AbstractMimeMessage;
* Abstract implementation of the {@link SoapMessage} interface. Contains convenient default implementations.
*
* @author Arjen Poutsma
* @since 1.0
*/
public abstract class AbstractSoapMessage extends AbstractMimeMessage implements SoapMessage {

View File

@@ -32,6 +32,7 @@ import javax.xml.transform.Source;
* @see #getPayloadSource()
* @see #getPayloadResult()
* @see SoapFault
* @since 1.0
*/
public interface SoapBody extends SoapElement {

View File

@@ -20,6 +20,7 @@ package org.springframework.ws.soap;
* Exception thrown when a SOAP body could not be accessed.
*
* @author Arjen Poutsma
* @since 1.0
*/
public class SoapBodyException extends SoapMessageException {

View File

@@ -25,6 +25,7 @@ import javax.xml.transform.Source;
*
* @author Arjen Poutsma
* @see SoapMessage
* @since 1.0
*/
public interface SoapElement {

View File

@@ -20,6 +20,7 @@ package org.springframework.ws.soap;
* Exception thrown when a SOAP element could not be accessed.
*
* @author Arjen Poutsma
* @since 1.0
*/
public class SoapElementException extends SoapMessageException {

View File

@@ -21,6 +21,7 @@ package org.springframework.ws.soap;
* <code>SoapHeader</code> and <code>SoapBody</code>.
*
* @author Arjen Poutsma
* @since 1.0
*/
public interface SoapEnvelope extends SoapElement {

View File

@@ -20,6 +20,7 @@ package org.springframework.ws.soap;
* Exception thrown when a SOAP body could not be accessed.
*
* @author Arjen Poutsma
* @since 1.0
*/
public class SoapEnvelopeException extends SoapMessageException {

View File

@@ -21,11 +21,11 @@ import javax.xml.namespace.QName;
/**
* Represents the <code>Fault</code> element in the body of a SOAP message.
* <p/>
* A fault consists of a {@link #getFaultCode() fault code},
* {@link #getFaultActorOrRole fault string/reason}, and
* A fault consists of a {@link #getFaultCode() fault code}, {@link #getFaultActorOrRole fault string/reason}, and
* {@link #getFaultActorOrRole() role}.
*
* @author Arjen Poutsma
* @since 1.0
*/
public interface SoapFault extends SoapElement {

View File

@@ -26,6 +26,7 @@ import javax.xml.transform.Result;
*
* @author Arjen Poutsma
* @see SoapFaultDetailElement
* @since 1.0
*/
public interface SoapFaultDetail extends SoapElement {

View File

@@ -24,16 +24,13 @@ import javax.xml.transform.Result;
*
* @author Arjen Poutsma
* @see SoapFaultDetail
* @since 1.0
*/
public interface SoapFaultDetailElement extends SoapElement {
/**
* Returns a <code>Result</code> that allows for writing to the <strong>contents</strong> of the detail element.
*/
/** Returns a <code>Result</code> that allows for writing to the <strong>contents</strong> of the detail element. */
Result getResult();
/**
* Adds a new text node to this element.
*/
/** Adds a new text node to this element. */
void addText(String text);
}

View File

@@ -20,6 +20,7 @@ package org.springframework.ws.soap;
* Exception thrown when a SOAP fault could not be accessed.
*
* @author Arjen Poutsma
* @since 1.0
*/
public class SoapFaultException extends SoapEnvelopeException {

View File

@@ -27,6 +27,7 @@ import javax.xml.transform.Result;
* @author Arjen Poutsma
* @see SoapHeaderElement
* @see SoapEnvelope#getHeader()
* @since 1.0
*/
public interface SoapHeader extends SoapElement {

View File

@@ -24,6 +24,7 @@ import javax.xml.transform.Result;
*
* @author Arjen Poutsma
* @see SoapHeader
* @since 1.0
*/
public interface SoapHeaderElement extends SoapElement {

View File

@@ -20,6 +20,7 @@ package org.springframework.ws.soap;
* Exception thrown when a SOAP header could not be accessed.
*
* @author Arjen Poutsma
* @since 1.0
*/
public class SoapHeaderException extends SoapMessageException {

View File

@@ -28,6 +28,7 @@ import org.springframework.ws.mime.MimeMessage;
* @see #getPayloadSource()
* @see #getPayloadResult()
* @see #getEnvelope()
* @since 1.0
*/
public interface SoapMessage extends MimeMessage, FaultAwareWebServiceMessage {

View File

@@ -20,19 +20,16 @@ package org.springframework.ws.soap;
* Exception thrown when a web service message cannot be created.
*
* @author Arjen Poutsma
* @since 1.0
*/
public class SoapMessageCreationException extends SoapMessageException {
/**
* Constructor for <code>SoapMessageCreationException</code>.
*/
/** Constructor for <code>SoapMessageCreationException</code>. */
public SoapMessageCreationException(String msg) {
super(msg);
}
/**
* Constructor for <code>SoapMessageCreationException</code>.
*/
/** Constructor for <code>SoapMessageCreationException</code>. */
public SoapMessageCreationException(String msg, Throwable ex) {
super(msg, ex);
}

View File

@@ -22,19 +22,16 @@ import org.springframework.ws.WebServiceMessageException;
* Base class for all SOAP message exceptions.
*
* @author Arjen Poutsma
* @since 1.0
*/
public abstract class SoapMessageException extends WebServiceMessageException {
/**
* Constructor for <code>SoapMessageException</code>.
*/
/** Constructor for <code>SoapMessageException</code>. */
public SoapMessageException(String msg) {
super(msg);
}
/**
* Constructor for <code>SoapMessageException</code>.
*/
/** Constructor for <code>SoapMessageException</code>. */
public SoapMessageException(String msg, Throwable ex) {
super(msg, ex);
}

View File

@@ -25,6 +25,7 @@ import org.springframework.ws.WebServiceMessageFactory;
* version is {@link SoapVersion#SOAP_11}.
*
* @author Arjen Poutsma
* @since 1.0
*/
public interface SoapMessageFactory extends WebServiceMessageFactory {

View File

@@ -25,6 +25,7 @@ import javax.xml.namespace.QName;
* @author Arjen Poutsma
* @see #SOAP_11
* @see #SOAP_12
* @since 1.0
*/
public interface SoapVersion {
@@ -229,39 +230,25 @@ public interface SoapVersion {
};
/**
* Returns the qualified name for a SOAP body.
*/
/** Returns the qualified name for a SOAP body. */
QName getBodyName();
/**
* Returns the <code>Content-Type</code> MIME header for a SOAP message.
*/
/** Returns the <code>Content-Type</code> MIME header for a SOAP message. */
String getContentType();
/**
* Returns the qualified name for a SOAP envelope.
*/
/** Returns the qualified name for a SOAP envelope. */
QName getEnvelopeName();
/**
* Returns the namespace URI for the SOAP envelope namespace.
*/
/** Returns the namespace URI for the SOAP envelope namespace. */
String getEnvelopeNamespaceUri();
/**
* Returns the qualified name for a SOAP fault.
*/
/** Returns the qualified name for a SOAP fault. */
QName getFaultName();
/**
* Returns the qualified name for a SOAP header.
*/
/** Returns the qualified name for a SOAP header. */
QName getHeaderName();
/**
* Returns the qualified name of the SOAP <code>MustUnderstand</code> attribute.
*/
/** Returns the qualified name of the SOAP <code>MustUnderstand</code> attribute. */
QName getMustUnderstandAttributeName();
/**
@@ -270,34 +257,22 @@ public interface SoapVersion {
*/
String getNextActorOrRoleUri();
/**
* Returns the URI indicating that a header element should never be directly processed.
*/
/** Returns the URI indicating that a header element should never be directly processed. */
String getNoneActorOrRoleUri();
/**
* Returns the qualified name of the <code>MustUnderstand</code> SOAP Fault value.
*/
/** Returns the qualified name of the <code>MustUnderstand</code> SOAP Fault value. */
QName getMustUnderstandFaultName();
/**
* Returns the qualified name of the Receiver/Server SOAP Fault value.
*/
/** Returns the qualified name of the Receiver/Server SOAP Fault value. */
QName getServerOrReceiverFaultName();
/**
* Returns the qualified name of the <code>VersionMismatch</code> SOAP Fault value.
*/
/** Returns the qualified name of the <code>VersionMismatch</code> SOAP Fault value. */
QName getVersionMismatchFaultName();
/**
* Returns the qualified name of the SOAP <code>actor</code>/<code>role</code> attribute.
*/
/** Returns the qualified name of the SOAP <code>actor</code>/<code>role</code> attribute. */
QName getActorOrRoleName();
/**
* Returns the qualified name of the Sender/Client SOAP Fault value.
*/
/** Returns the qualified name of the Sender/Client SOAP Fault value. */
QName getClientOrSenderFaultName();
/**

View File

@@ -27,6 +27,7 @@ import org.springframework.ws.mime.Attachment;
* Axiom-specific implementation of {@link org.springframework.ws.mime.Attachment}
*
* @author Arjen Poutsma
* @since 1.0
*/
class AxiomAttachment implements Attachment {

View File

@@ -26,6 +26,7 @@ import org.xml.sax.SAXException;
* <code>endDocument</code> is called. Used for returing <code>SAXResult</code>s from Axiom elements.
*
* @author Arjen Poutsma
* @since 1.0
*/
class AxiomContentHandler extends SAXOMBuilder {

View File

@@ -40,6 +40,7 @@ import org.springframework.xml.namespace.QNameUtils;
* Axiom-specific version of <code>org.springframework.ws.soap.Soap11Body</code>.
*
* @author Arjen Poutsma
* @since 1.0
*/
class AxiomSoap11Body extends AxiomSoapBody implements Soap11Body {

View File

@@ -29,6 +29,7 @@ import org.springframework.ws.soap.soap11.Soap11Fault;
* Axiom-specific version of <code>org.springframework.ws.soap.Soap11Fault</code>.
*
* @author Arjen Poutsma
* @since 1.0
*/
class AxiomSoap11Fault extends AxiomSoapFault implements Soap11Fault {

View File

@@ -30,6 +30,7 @@ import org.springframework.ws.soap.soap11.Soap11Header;
* Axiom-specific version of <code>org.springframework.ws.soap.Soap11Header</code>.
*
* @author Arjen Poutsma
* @since 1.0
*/
class AxiomSoap11Header extends AxiomSoapHeader implements Soap11Header {

View File

@@ -38,6 +38,7 @@ import org.springframework.ws.soap.soap12.Soap12Fault;
* Axiom-specific version of <code>org.springframework.ws.soap.Soap12Body</code>.
*
* @author Arjen Poutsma
* @since 1.0
*/
class AxiomSoap12Body extends AxiomSoapBody implements Soap12Body {

View File

@@ -39,6 +39,7 @@ import org.springframework.xml.namespace.QNameUtils;
* Axiom-specific version of <code>org.springframework.ws.soap.Soap12Header</code>.
*
* @author Arjen Poutsma
* @since 1.0
*/
class AxiomSoap12Header extends AxiomSoapHeader implements Soap12Header {

View File

@@ -34,6 +34,7 @@ import org.springframework.xml.transform.StaxSource;
* Axiom-specific version of <code>org.springframework.ws.soap.Soap11Body</code>.
*
* @author Arjen Poutsma
* @since 1.0
*/
abstract class AxiomSoapBody extends AxiomSoapElement implements SoapBody {

View File

@@ -20,6 +20,7 @@ import org.springframework.ws.soap.SoapEnvelopeException;
/**
* @author Arjen Poutsma
* @since 1.0
*/
public class AxiomSoapBodyException extends SoapEnvelopeException {

View File

@@ -35,6 +35,7 @@ import org.springframework.xml.transform.StaxSource;
* Axiom-specific version of {@link SoapElement}.
*
* @author Arjen Poutsma
* @since 1.0
*/
class AxiomSoapElement implements SoapElement {

View File

@@ -15,6 +15,7 @@ import org.springframework.ws.soap.SoapHeader;
* Axiom-Specific version of <code>org.springframework.ws.soap.SoapEnvelope</code>.
*
* @author Arjen Poutsma
* @since 1.0
*/
class AxiomSoapEnvelope extends AxiomSoapElement implements SoapEnvelope {

View File

@@ -20,6 +20,7 @@ import org.springframework.ws.soap.SoapEnvelopeException;
/**
* @author Arjen Poutsma
* @since 1.0
*/
public class AxiomSoapEnvelopeException extends SoapEnvelopeException {

Some files were not shown because too many files have changed in this diff Show More