Package org.springframework.ws.transport

Interface WebServiceMessageSender

All Known Implementing Classes:

AbstractHttpComponents5MessageSender, AbstractHttpWebServiceMessageSender, AbstractWebServiceMessageSender, ClientHttpRequestMessageSender, HttpComponents5MessageSender, HttpComponentsMessageSender, HttpsUrlConnectionMessageSender, HttpUrlConnectionMessageSender, JdkHttpClientMessageSender, JmsMessageSender, MailMessageSender, MockWebServiceMessageSender, SimpleHttpComponents5MessageSender, XmppMessageSender

public interface WebServiceMessageSender

Defines the methods for classes capable of sending and receiving WebServiceMessage instances for a given transport. Also validates if a destination URI is supported, which is used both for expressing that the instance can handle the URI but that it is acceptable for a given WebServiceMessageSender.UriSource.

The WebServiceMessageSender is basically a factory for WebServiceConnection objects.

Since:

1.0.0

See Also:

• WebServiceConnection

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	WebServiceMessageSender.DestinationDescriptor	Description of a destination URI for validation, including its source.
static interface	WebServiceMessageSender.DestinationPolicy<D extends WebServiceMessageSender.DestinationDescriptor>	Specifies the policy to apply for a given descriptor.
static enum	WebServiceMessageSender.UriSource	Source of a destination URI.

Method Summary

Modifier and Type	Method	Description
WebServiceConnection	createConnection(URI uri)	Create a new WebServiceConnection to the specified URI.
default boolean	supports(URI uri)	Deprecated. as of 3.1.9 in favor of supports(URI, UriSource)
boolean	supports(URI uri, WebServiceMessageSender.UriSource uriSource)	Whether this sender supports the given URI for the supplied WebServiceMessageSender.UriSource.

Method Details

createConnection

WebServiceConnection createConnection(URI uri)
                               throws IOException

Create a new WebServiceConnection to the specified URI.

Parameters:

uri - the URI to open a connection to

Returns:

the new connection

Throws:

IOException - in case of I/O errors

supports

boolean supports(URI uri,
 WebServiceMessageSender.UriSource uriSource)

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 supports(URI), and add stricter checks for WebServiceMessageSender.UriSource.REMOTE.

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

Since:

3.1.9

supports

@Deprecated
default boolean supports(URI uri)

Deprecated.

as of 3.1.9 in favor of supports(URI, UriSource)

Whether this sender supports the given URI for application-controlled use.

Parameters:

uri - the URI to be checked

Returns:

true if this WebServiceMessageSender supports the supplied URI