Package org.springframework.ws.server.endpoint

Class AbstractMarshallingPayloadEndpoint

java.lang.Object
org.springframework.ws.server.endpoint.AbstractMarshallingPayloadEndpoint
All Implemented Interfaces:
org.springframework.beans.factory.InitializingBean, MessageEndpoint
Direct Known Subclasses:
AbstractValidatingMarshallingPayloadEndpoint
@Deprecated public abstract class AbstractMarshallingPayloadEndpoint extends Object implements MessageEndpoint, org.springframework.beans.factory.InitializingBean
Deprecated.
as of Spring Web Services 2.0, in favor of annotated endpoints
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 template method is invoked using the request object as a parameter, and allows for a response object to be returned.
Since:
1.0.0
Author:
Arjen Poutsma
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final org.apache.commons.logging.Log
    logger
    Deprecated.
    Logger available to subclasses.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    AbstractMarshallingPayloadEndpoint()
    Deprecated.
    Creates a new AbstractMarshallingPayloadEndpoint.
    protected
    AbstractMarshallingPayloadEndpoint(org.springframework.oxm.Marshaller marshaller)
    Deprecated.
    Creates a new AbstractMarshallingPayloadEndpoint with the given marshaller.
    protected
    AbstractMarshallingPayloadEndpoint(org.springframework.oxm.Marshaller marshaller, org.springframework.oxm.Unmarshaller unmarshaller)
    Deprecated.
    Creates a new AbstractMarshallingPayloadEndpoint with the given marshaller and unmarshaller.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    afterMarshallerSet()
    Deprecated.
    as of Spring Web Services 1.5: afterPropertiesSet() is no longer final, so this can safely be overridden in subclasses
    void
    afterPropertiesSet()
    Deprecated.
     
    org.springframework.oxm.Marshaller
    getMarshaller()
    Deprecated.
    Returns the marshaller used for transforming objects into XML.
    org.springframework.oxm.Unmarshaller
    getUnmarshaller()
    Deprecated.
    Returns the unmarshaller used for transforming XML into objects.
    final void
    invoke(MessageContext messageContext)
    Deprecated.
    Invokes an operation.
    protected abstract Object
    invokeInternal(Object requestObject)
    Deprecated.
    Template method that subclasses must implement to process a request.
    protected void
    onMarshalResponse(MessageContext messageContext, Object requestObject, Object responseObject)
    Deprecated.
    Callback for post-processing in terms of marshalling.
    protected boolean
    onUnmarshalRequest(MessageContext messageContext, Object requestObject)
    Deprecated.
    Callback for post-processing in terms of unmarshalling.
    final void
    setMarshaller(org.springframework.oxm.Marshaller marshaller)
    Deprecated.
    Sets the marshaller used for transforming objects into XML.
    final void
    setUnmarshaller(org.springframework.oxm.Unmarshaller unmarshaller)
    Deprecated.
    Sets the unmarshaller used for transforming XML into objects.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • logger

      protected final org.apache.commons.logging.Log logger
      Deprecated.
      Logger available to subclasses.

  • Constructor Details

    • AbstractMarshallingPayloadEndpoint

      protected AbstractMarshallingPayloadEndpoint()
      Deprecated.
      Creates a new AbstractMarshallingPayloadEndpoint. The Marshaller and Unmarshaller must be injected using properties.
      See Also:

    • AbstractMarshallingPayloadEndpoint

      protected AbstractMarshallingPayloadEndpoint(org.springframework.oxm.Marshaller marshaller)
      Deprecated.
      Creates a new AbstractMarshallingPayloadEndpoint with the given marshaller. The given Marshaller should also implements the Unmarshaller, since it is used for both marshalling and unmarshalling. If it is not, an exception is thrown.

      Note that all Marshaller implementations in Spring-WS also implement the Unmarshaller interface, so that you can safely use this constructor.

      Parameters:
      marshaller - object used as marshaller and unmarshaller
      Throws:
      IllegalArgumentException - when marshaller does not implement the Unmarshaller interface
      See Also:

    • AbstractMarshallingPayloadEndpoint

      protected AbstractMarshallingPayloadEndpoint(org.springframework.oxm.Marshaller marshaller, org.springframework.oxm.Unmarshaller unmarshaller)
      Deprecated.
      Creates a new AbstractMarshallingPayloadEndpoint with the given marshaller and unmarshaller.
      Parameters:
      marshaller - the marshaller to use
      unmarshaller - the unmarshaller to use

  • Method Details

    • getMarshaller

      public org.springframework.oxm.Marshaller getMarshaller()
      Deprecated.
      Returns the marshaller used for transforming objects into XML.

    • setMarshaller

      public final void setMarshaller(org.springframework.oxm.Marshaller marshaller)
      Deprecated.
      Sets the marshaller used for transforming objects into XML.

    • getUnmarshaller

      public org.springframework.oxm.Unmarshaller getUnmarshaller()
      Deprecated.
      Returns the unmarshaller used for transforming XML into objects.

    • setUnmarshaller

      public final void setUnmarshaller(org.springframework.oxm.Unmarshaller unmarshaller)
      Deprecated.
      Sets the unmarshaller used for transforming XML into objects.

    • afterPropertiesSet

      public void afterPropertiesSet() throws Exception
      Deprecated.
      Specified by:
      afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
      Throws:
      Exception

    • invoke

      public final void invoke(MessageContext messageContext) throws Exception
      Deprecated.
      Description copied from interface: MessageEndpoint
      Invokes an operation.

      The given messageContext can be used to create a response.

      Specified by:
      invoke in interface MessageEndpoint
      Parameters:
      messageContext - the message context
      Throws:
      Exception - if an exception occurs

    • onUnmarshalRequest

      protected boolean onUnmarshalRequest(MessageContext messageContext, Object requestObject) throws Exception
      Deprecated.
      Callback for post-processing in terms of unmarshalling. Called on each message request, after standard unmarshalling.

      Default implementation returns true.

      Parameters:
      messageContext - the message context
      requestObject - the object unmarshalled from the request
      Returns:
      true to continue and call invokeInternal(Object); false otherwise
      Throws:
      Exception

    • onMarshalResponse

      protected void onMarshalResponse(MessageContext messageContext, Object requestObject, Object responseObject)
      Deprecated.
      Callback for post-processing in terms of marshalling. Called on each message request, after standard marshalling of the response. Only invoked when invokeInternal(Object) returns an object.

      Default implementation is empty.

      Parameters:
      messageContext - the message context
      requestObject - the object unmarshalled from the request
      responseObject - the object marshalled to the MessageContext.getResponse() request}

    • afterMarshallerSet

      @Deprecated public void afterMarshallerSet() throws Exception
      Deprecated.
      as of Spring Web Services 1.5: afterPropertiesSet() is no longer final, so this can safely be overridden in subclasses
      Template method that gets called after the marshaller and unmarshaller have been set.

      The default implementation does nothing.

      Throws:
      Exception

    • invokeInternal

      protected abstract Object invokeInternal(Object requestObject) throws Exception
      Deprecated.
      Template method that subclasses must implement to process a request.

      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.

      Parameters:
      requestObject - the unmarshalled message payload as an object
      Returns:
      the object to be marshalled as response, or null if a response is not required
      Throws:
      Exception