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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interfaceDescription of a destination URI for validation, including its source.static interfaceDecides which destinations a sender may open a connection to.static enumSource of a destination URI. -
Method Summary
Modifier and TypeMethodDescriptioncreateConnection(URI uri) Create a newWebServiceConnectionto the specified URI.default booleanDeprecated.booleansupports(URI uri, WebServiceMessageSender.UriSource uriSource) Whether this sender supports the given URI for the suppliedWebServiceMessageSender.UriSource.default booleanWhether this sender is configured to accept destinations supplied by a remote peer at all.
-
Method Details
-
createConnection
Create a newWebServiceConnectionto 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
Whether this sender supports the given URI for the suppliedWebServiceMessageSender.UriSource.A URI is supported when this sender handles its transport and the configured
WebServiceMessageSender.DestinationPolicyaccepts it. When no policy is configured,WebServiceMessageSender.UriSource.APPLICATIONdestinations are accepted andWebServiceMessageSender.UriSource.REMOTEdestinations are rejected: only the application knows which peer-supplied destinations are legitimate, so there is no safe default.- Parameters:
uri- the URI to be checkeduriSource- whether the URI is application-controlled or remote-influenced- Returns:
trueif this sender accepts the URI for that source- Since:
- 3.1.9
-
supports
Deprecated.as of 3.1.9 in favor ofsupports(URI, UriSource)Whether this sender supports the given URI for application-controlled use.- Parameters:
uri- the URI to be checked- Returns:
trueif thisWebServiceMessageSendersupports the supplied URI
-
supportsRemoteDestinations
default boolean supportsRemoteDestinations()Whether this sender is configured to accept destinations supplied by a remote peer at all.Return
falsewhen the sender rejects everyWebServiceMessageSender.UriSource.REMOTEdestination out of hand, typically because noWebServiceMessageSender.DestinationPolicyis configured.- Returns:
falseif no remote destination can ever be accepted- Since:
- 3.1.10
-
supports(URI, UriSource)