rocks.xmpp.extensions.httpbind

Class BoshConnection

java.lang.Object

rocks.xmpp.core.session.Connection

rocks.xmpp.extensions.httpbind.BoshConnection

All Implemented Interfaces:

AutoCloseable

public final class BoshConnection
extends Connection

The implementation of XEP-0124: Bidirectional-streams Over Synchronous HTTP (BOSH) and XEP-0206: XMPP Over BOSH.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the session as described in Terminating the HTTP Session.
void	connect(rocks.xmpp.addr.Jid from, String namespace, Consumer<rocks.xmpp.addr.Jid> onStreamOpened) Connects to the BOSH server.
long	detach() Detaches this BOSH session without closing (aka terminating) it.
String	getRoute() Gets the route.
String	getSessionId() Gets the session id of this BOSH connection.
String	getStreamId() Gets the stream id of this connection.
boolean	isSecure() Indicates whether this connection is secured by TLS/SSL.
boolean	isUsingAcknowledgements() Indicates, whether this connection is using acknowledgements.
CompletableFuture<Void>	send(StreamElement element) Sends an element over this connection.
String	toString()

Methods inherited from class rocks.xmpp.core.session.Connection

getHostname, getPort, getProxy

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

connect

public final void connect(rocks.xmpp.addr.Jid from,
                          String namespace,
                          Consumer<rocks.xmpp.addr.Jid> onStreamOpened)
                   throws IOException

Connects to the BOSH server.

Specified by:

connect in class Connection

Parameters:

from - The optional 'from' attribute in the initial BOSH session creation request.

namespace - The content namespace, e.g. "jabber:client".

onStreamOpened - The callback which gets notified when the stream gets opened, i.e. when the server has responded with a stream header. The parameter of the consumer is the stream id.

Throws:

IOException - If a connection could not be established.

isSecure

public final boolean isSecure()

Description copied from class: Connection

Indicates whether this connection is secured by TLS/SSL.

Specified by:

isSecure in class Connection

Returns:

True, if this connection is secured.

close

public final void close()

Closes the session as described in Terminating the HTTP Session.

This method can be called from different threads:

1. The application thread.
2. The reader thread, which closes the BOSH session after seeing an error from the connection manager.
3. The writer thread.

detach

public final long detach()

Detaches this BOSH session without closing (aka terminating) it. This way the BOSH session is still alive on the server and can be ported over to a web page, but new BOSH requests are no longer sent by this connection.

Returns:

The current request ID (RID) which was used for the last BOSH request.

See Also:

https://conversejs.org/docs/html/#prebinding-and-single-session-support

send

public final CompletableFuture<Void> send(StreamElement element)

Description copied from class: Connection

Sends an element over this connection.

Specified by:

send in class Connection

Parameters:

element - The element.

Returns:

The future representing the send process and which allows to cancel it.

getSessionId

public final String getSessionId()

Gets the session id of this BOSH connection.

Returns:

The session id.

getStreamId

public final String getStreamId()

Description copied from class: Connection

Gets the stream id of this connection.

Specified by:

getStreamId in class Connection

Returns:

The stream id.

isUsingAcknowledgements

public final boolean isUsingAcknowledgements()

Description copied from class: Connection

Indicates, whether this connection is using acknowledgements.

TCP and WebSocket connections use XEP-0198: Stream Management to acknowledge stanzas.

BOSH connections use another mechanism for acknowledgements, described in XEP-0124 § 9. Acknowledgements.

Specified by:

isUsingAcknowledgements in class Connection

Returns:

True, if this connection is using acknowledgements.

See Also:

XEP-0198: Stream Management, XEP-0124 § 9. Acknowledgements

getRoute

public final String getRoute()

Gets the route.

A connection manager MAY be configured to enable sessions with more than one server in different domains. When requesting a session with such a "proxy" connection manager, a client SHOULD include a 'route' attribute that specifies the protocol, hostname, and port of the server with which it wants to communicate, formatted as "proto:host:port" (e.g., "xmpp:example.com:9999").

Returns:

The route.

toString

public final String toString()

Overrides:

toString in class Object