Class AbstractWebServiceMessageSender<D extends WebServiceMessageSender.DestinationDescriptor>

java.lang.Object

org.springframework.ws.transport.AbstractWebServiceMessageSender<D>

Type Parameters:

D - concrete WebServiceMessageSender.DestinationDescriptor type

All Implemented Interfaces:

WebServiceMessageSender

Direct Known Subclasses:

AbstractHttpWebServiceMessageSender, MailMessageSender, XmppMessageSender

public abstract class AbstractWebServiceMessageSender<D extends WebServiceMessageSender.DestinationDescriptor>
extends Object
implements WebServiceMessageSender

Base class for WebServiceMessageSender implementations that share WebServiceMessageSender.DestinationPolicy handling for supports(URI, UriSource).

A URI filter must be provided to only accept a URI that the implementation handles, irrespective of whether it is acceptable according to an WebServiceMessageSender.UriSource. Implementations typically inspect the URI scheme (or other transport-specific traits) in that filter.

Since:

3.1.9

Nested Class Summary

Nested classes/interfaces inherited from interface WebServiceMessageSender

WebServiceMessageSender.DestinationDescriptor, WebServiceMessageSender.DestinationPolicy<D>, WebServiceMessageSender.UriSource

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractWebServiceMessageSender(Predicate<URI> supportedUriFilter)	Create an instance with the URI filter to apply to accept a given URI.

Method Summary

Modifier and Type	Method	Description
protected abstract D	createDescriptor(URI uri, WebServiceMessageSender.UriSource uriSource)	Create a WebServiceMessageSender.DestinationDescriptor for the given uri and uriSource.
protected abstract Predicate<D>	defaultChecks(WebServiceMessageSender.UriSource uriSource)	Return the default checks to apply for the given WebServiceMessageSender.UriSource.
protected @Nullable WebServiceMessageSender.DestinationPolicy<D>	getDestinationPolicy()	Return the configured WebServiceMessageSender.DestinationPolicy or null if none is set.
void	setDestinationPolicy(WebServiceMessageSender.DestinationPolicy<D> destinationPolicy)	Set a custom WebServiceMessageSender.DestinationPolicy to compose with the sender's default checks.
boolean	supports(URI uri, WebServiceMessageSender.UriSource uriSource)	Whether this sender supports the given URI for the supplied WebServiceMessageSender.UriSource.

Methods inherited from class Object

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

Methods inherited from interface WebServiceMessageSender

createConnection, supports

Constructor Details

AbstractWebServiceMessageSender

protected AbstractWebServiceMessageSender(Predicate<URI> supportedUriFilter)

Create an instance with the URI filter to apply to accept a given URI.

Parameters:

supportedUriFilter - the predicate to apply to a URI to test if it is supported by the instance

Method Details

setDestinationPolicy

public void setDestinationPolicy(WebServiceMessageSender.DestinationPolicy<D> destinationPolicy)

Set a custom WebServiceMessageSender.DestinationPolicy to compose with the sender's default checks. When unset, only default checks apply.

Parameters:

destinationPolicy - the policy to apply

getDestinationPolicy

protected @Nullable WebServiceMessageSender.DestinationPolicy<D> getDestinationPolicy()

Return the configured WebServiceMessageSender.DestinationPolicy or null if none is set.

Returns:

the custom destination policy or null if none is set.

supports

public boolean supports(URI uri,
 WebServiceMessageSender.UriSource uriSource)

Description copied from interface: WebServiceMessageSender

Whether this sender supports the given URI for the supplied WebServiceMessageSender.UriSource. Implementations typically apply the same transport rules for WebServiceMessageSender.UriSource.APPLICATION as for legacy WebServiceMessageSender.supports(URI), and add stricter checks for WebServiceMessageSender.UriSource.REMOTE.

Specified by:

supports in interface WebServiceMessageSender

Parameters:

uri - the URI to be checked

uriSource - whether the URI is application-controlled or remote-influenced

Returns:

true if this sender accepts the URI for that source

createDescriptor

protected abstract D createDescriptor(URI uri,
 WebServiceMessageSender.UriSource uriSource)

Create a WebServiceMessageSender.DestinationDescriptor for the given uri and uriSource.

Parameters:

uri - the URI to check

uriSource - the source of the URI

Returns:

a suitable descriptor

defaultChecks

protected abstract Predicate<D> defaultChecks(WebServiceMessageSender.UriSource uriSource)

Return the default checks to apply for the given WebServiceMessageSender.UriSource.

Returns:

the default checks to apply