Package org.springframework.ws.transport.xmpp

Class XmppMessageSender

java.lang.Object

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

org.springframework.ws.transport.xmpp.XmppMessageSender

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean, WebServiceMessageSender

public class XmppMessageSender
extends AbstractWebServiceMessageSender<XmppDestinationDescriptor>
implements org.springframework.beans.factory.InitializingBean

WebServiceMessageSender implementation that uses XMPP Messages. Requires a connectionto be set.

This message sender supports URI's of the following format:

xmpp:to

The to represents a Jabber ID.

For WebServiceMessageSender.UriSource.APPLICATION, default checks accept any xmpp: URI. For WebServiceMessageSender.UriSource.REMOTE, default checks require a configured XMPPConnection and accept only URIs whose JID domain matches the connection's XMPP service domain (see XmppDestinationDescriptor.domain()). Use a WebServiceMessageSender.DestinationPolicy for allow-lists, multi-tenant routing, or stricter JID checks.

Since:

2.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.ws.transport.WebServiceMessageSender

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_MESSAGE_ENCODING	Default encoding used to read from and write to Message messages.
static final long	DEFAULT_RECEIVE_TIMEOUT	Default timeout for receive operations: -1 indicates a blocking receive without timeout.

Constructor Summary

Constructors

Constructor	Description
XmppMessageSender()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
WebServiceConnection	createConnection(URI uri)	Create a new WebServiceConnection to the specified URI.
protected XmppDestinationDescriptor	createDescriptor(URI uri, WebServiceMessageSender.UriSource uriSource)	Create a WebServiceMessageSender.DestinationDescriptor for the given uri and uriSource.
protected String	createThread()
protected Predicate<XmppDestinationDescriptor>	defaultChecks(WebServiceMessageSender.UriSource uriSource)	Return the default checks to apply for the given WebServiceMessageSender.UriSource.
void	setConnection(org.jivesoftware.smack.XMPPConnection connection)	Sets the XMPPConnection.
void	setMessageEncoding(String messageEncoding)	Sets the encoding used to read from Message object.
void	setReceiveTimeout(long receiveTimeout)	Set the timeout to use for receive calls.

Methods inherited from class org.springframework.ws.transport.AbstractWebServiceMessageSender

getDestinationPolicy, setDestinationPolicy, supports

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.ws.transport.WebServiceMessageSender

supports

Field Details

DEFAULT_RECEIVE_TIMEOUT

public static final long DEFAULT_RECEIVE_TIMEOUT

Default timeout for receive operations: -1 indicates a blocking receive without timeout.

See Also:

• Constant Field Values

DEFAULT_MESSAGE_ENCODING

public static final String DEFAULT_MESSAGE_ENCODING

Default encoding used to read from and write to Message messages.

See Also:

• Constant Field Values

Constructor Details

XmppMessageSender

public XmppMessageSender()

Method Details

setConnection

public void setConnection(org.jivesoftware.smack.XMPPConnection connection)

Sets the XMPPConnection. Setting this property is required.

setReceiveTimeout

public void setReceiveTimeout(long receiveTimeout)

Set the timeout to use for receive calls. The default is -1, which means no timeout.

See Also:

• StanzaCollector.nextResult(long)

setMessageEncoding

public void setMessageEncoding(String messageEncoding)

Sets the encoding used to read from Message object. Defaults to UTF-8.

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

createConnection

public WebServiceConnection createConnection(URI uri)
                                      throws IOException

Description copied from interface: WebServiceMessageSender

Create a new WebServiceConnection to the specified URI.

Specified by:

createConnection in interface WebServiceMessageSender

Parameters:

uri - the URI to open a connection to

Returns:

the new connection

Throws:

IOException - in case of I/O errors

createDescriptor

protected XmppDestinationDescriptor createDescriptor(URI uri,
 WebServiceMessageSender.UriSource uriSource)

Description copied from class: AbstractWebServiceMessageSender

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

Specified by:

createDescriptor in class AbstractWebServiceMessageSender<XmppDestinationDescriptor>

Parameters:

uri - the URI to check

uriSource - the source of the URI

Returns:

a suitable descriptor

defaultChecks

protected Predicate<XmppDestinationDescriptor> defaultChecks(WebServiceMessageSender.UriSource uriSource)

Description copied from class: AbstractWebServiceMessageSender

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

Specified by:

defaultChecks in class AbstractWebServiceMessageSender<XmppDestinationDescriptor>

Returns:

the default checks to apply

createThread

protected String createThread()