@Deprecated public abstract class AbstractMarshallingPayloadEndpoint extends Object implements MessageEndpoint, org.springframework.beans.factory.InitializingBean
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.setMarshaller(org.springframework.oxm.Marshaller)
,
Marshaller
,
setUnmarshaller(org.springframework.oxm.Unmarshaller)
,
Unmarshaller
,
invokeInternal(Object)
Modifier and Type | Field and Description |
---|---|
protected org.apache.commons.logging.Log |
logger
Deprecated.
Logger available to subclasses.
|
Modifier | Constructor and 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. |
Modifier and Type | Method and 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.
|
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.
|
void |
setMarshaller(org.springframework.oxm.Marshaller marshaller)
Deprecated.
Sets the marshaller used for transforming objects into XML.
|
void |
setUnmarshaller(org.springframework.oxm.Unmarshaller unmarshaller)
Deprecated.
Sets the unmarshaller used for transforming XML into objects.
|
protected final org.apache.commons.logging.Log logger
protected AbstractMarshallingPayloadEndpoint()
AbstractMarshallingPayloadEndpoint
. The Marshaller
and Unmarshaller
must be injected using properties.protected AbstractMarshallingPayloadEndpoint(org.springframework.oxm.Marshaller marshaller)
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.
marshaller
- object used as marshaller and unmarshallerIllegalArgumentException
- when marshaller
does not implement the Unmarshaller
interfaceAbstractMarshallingPayloadEndpoint(Marshaller,Unmarshaller)
protected AbstractMarshallingPayloadEndpoint(org.springframework.oxm.Marshaller marshaller, org.springframework.oxm.Unmarshaller unmarshaller)
AbstractMarshallingPayloadEndpoint
with the given marshaller and unmarshaller.marshaller
- the marshaller to useunmarshaller
- the unmarshaller to usepublic org.springframework.oxm.Marshaller getMarshaller()
public final void setMarshaller(org.springframework.oxm.Marshaller marshaller)
public org.springframework.oxm.Unmarshaller getUnmarshaller()
public final void setUnmarshaller(org.springframework.oxm.Unmarshaller unmarshaller)
public void afterPropertiesSet() throws Exception
afterPropertiesSet
in interface org.springframework.beans.factory.InitializingBean
Exception
public final void invoke(MessageContext messageContext) throws Exception
MessageEndpoint
The given messageContext
can be used to create a response.
invoke
in interface MessageEndpoint
messageContext
- the message contextException
- if an exception occursprotected boolean onUnmarshalRequest(MessageContext messageContext, Object requestObject) throws Exception
Default implementation returns true
.
messageContext
- the message contextrequestObject
- the object unmarshalled from the request
true
to continue and call invokeInternal(Object)
; false
otherwiseException
protected void onMarshalResponse(MessageContext messageContext, Object requestObject, Object responseObject)
invokeInternal(Object)
returns an object.
Default implementation is empty.
messageContext
- the message contextrequestObject
- the object unmarshalled from the request
responseObject
- the object marshalled to the MessageContext.getResponse()
request}@Deprecated public void afterMarshallerSet() throws Exception
afterPropertiesSet()
is no longer final, so this can safely
be overridden in subclassesThe default implementation does nothing.
Exception
protected abstract Object invokeInternal(Object requestObject) throws Exception
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
.
requestObject
- the unmarshalled message payload as an objectnull
if a response is not requiredException
Copyright © 2020 Pivotal Software. All rights reserved.