|
Spring Web Services Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.springframework.ws.client.core.support.WebServiceGatewaySupport
public abstract class WebServiceGatewaySupport
Convenient super class for application classes that need Web service access.
Requires aWebServiceMessageFactory
or a WebServiceTemplate
instance to be set. It will create its
own WebServiceTemplate
if WebServiceMessageFactory
is passed in.
In addition to the message factory property, this gateway offers Marshaller
and Unmarshaller
properties. Setting these is required when the marshalling
methods
of the template are to be used.
Note that when injecting a WebServiceTemplate
directly, the convenience setters (setMarshaller(Marshaller)
, setUnmarshaller(Unmarshaller)
, setMessageSender(WebServiceMessageSender)
, setMessageSenders(WebServiceMessageSender[])
, and setDefaultUri(String)
) should not be used on this class, but on the template directly.
setMessageFactory(WebServiceMessageFactory)
,
WebServiceTemplate
,
setMarshaller(Marshaller)
Field Summary | |
---|---|
protected Log |
logger
Logger available to subclasses. |
Constructor Summary | |
---|---|
protected |
WebServiceGatewaySupport()
Creates a new instance of the WebServiceGatewaySupport class, with a default
WebServiceTemplate . |
protected |
WebServiceGatewaySupport(WebServiceMessageFactory messageFactory)
Creates a new WebServiceGatewaySupport instance based on the given message factory. |
Method Summary | |
---|---|
void |
afterPropertiesSet()
|
String |
getDefaultUri()
Returns the default URI used by the gateway. |
DestinationProvider |
getDestinationProvider()
Returns the destination provider used by the gateway. |
ClientInterceptor[] |
getInterceptors()
Returns the ClientInterceptors used by the template. |
Marshaller |
getMarshaller()
Returns the Marshaller used by the gateway. |
WebServiceMessageFactory |
getMessageFactory()
Returns the WebServiceMessageFactory used by the gateway. |
WebServiceMessageSender[] |
getMessageSenders()
Returns the WebServiceMessageSender s used by the gateway. |
Unmarshaller |
getUnmarshaller()
Returns the Unmarshaller used by the gateway. |
WebServiceTemplate |
getWebServiceTemplate()
Returns the WebServiceTemplate for the gateway. |
protected void |
initGateway()
Subclasses can override this for custom initialization behavior. |
void |
setDefaultUri(String uri)
Sets the default URI used by the gateway. |
void |
setDestinationProvider(DestinationProvider destinationProvider)
Set the destination provider URI used by the gateway. |
void |
setInterceptors(ClientInterceptor[] interceptors)
Sets the ClientInterceptors used by the gateway. |
void |
setMarshaller(Marshaller marshaller)
Sets the Marshaller used by the gateway. |
void |
setMessageFactory(WebServiceMessageFactory messageFactory)
Set the WebServiceMessageFactory to be used by the gateway. |
void |
setMessageSender(WebServiceMessageSender messageSender)
Sets a single WebServiceMessageSender to be used by the gateway. |
void |
setMessageSenders(WebServiceMessageSender[] messageSenders)
Sets multiple WebServiceMessageSender to be used by the gateway. |
void |
setUnmarshaller(Unmarshaller unmarshaller)
Sets the Unmarshaller used by the gateway. |
void |
setWebServiceTemplate(WebServiceTemplate webServiceTemplate)
Sets the WebServiceTemplate to be used by the gateway. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected final Log logger
Constructor Detail |
---|
protected WebServiceGatewaySupport()
WebServiceGatewaySupport
class, with a default
WebServiceTemplate
.
protected WebServiceGatewaySupport(WebServiceMessageFactory messageFactory)
WebServiceGatewaySupport
instance based on the given message factory.
messageFactory
- the message factory to useMethod Detail |
---|
public final WebServiceMessageFactory getMessageFactory()
WebServiceMessageFactory
used by the gateway.
public final void setMessageFactory(WebServiceMessageFactory messageFactory)
WebServiceMessageFactory
to be used by the gateway.
public final String getDefaultUri()
public final void setDefaultUri(String uri)
public final DestinationProvider getDestinationProvider()
public final void setDestinationProvider(DestinationProvider destinationProvider)
public final void setMessageSender(WebServiceMessageSender messageSender)
WebServiceMessageSender
to be used by the gateway.
public final WebServiceMessageSender[] getMessageSenders()
WebServiceMessageSender
s used by the gateway.
public final void setMessageSenders(WebServiceMessageSender[] messageSenders)
WebServiceMessageSender
to be used by the gateway.
public final WebServiceTemplate getWebServiceTemplate()
WebServiceTemplate
for the gateway.
public final void setWebServiceTemplate(WebServiceTemplate webServiceTemplate)
WebServiceTemplate
to be used by the gateway.
When using this property, the convenience setters (setMarshaller(Marshaller)
, setUnmarshaller(Unmarshaller)
, setMessageSender(WebServiceMessageSender)
, setMessageSenders(WebServiceMessageSender[])
, and setDefaultUri(String)
) should not be set on this
class, but on the template directly.
public final Marshaller getMarshaller()
Marshaller
used by the gateway.
public final void setMarshaller(Marshaller marshaller)
Marshaller
used by the gateway. Setting this property is only required if the marshalling
functionality of WebServiceTemplate
is to be used.
WebServiceTemplate.marshalSendAndReceive(java.lang.Object)
public final Unmarshaller getUnmarshaller()
Unmarshaller
used by the gateway.
public final void setUnmarshaller(Unmarshaller unmarshaller)
Unmarshaller
used by the gateway. Setting this property is only required if the marshalling
functionality of WebServiceTemplate
is to be used.
WebServiceTemplate.marshalSendAndReceive(java.lang.Object)
public final ClientInterceptor[] getInterceptors()
ClientInterceptors
used by the template.
public final void setInterceptors(ClientInterceptor[] interceptors)
ClientInterceptors
used by the gateway.
public final void afterPropertiesSet() throws Exception
afterPropertiesSet
in interface InitializingBean
Exception
protected void initGateway() throws Exception
Exception
- if initialization fails
|
Spring Web Services Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |