rocks.xmpp.extensions.httpbind

Class BoshConnection

java.lang.Object

rocks.xmpp.core.session.Connection

rocks.xmpp.extensions.httpbind.BoshConnection

All Implemented Interfaces:

Closeable, AutoCloseable

public final class BoshConnection
extends Connection

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

Author:

Christian Schudt

Field Summary

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

hostname, port

Method Summary

Modifier and Type	Method and Description
void	close() Closes the session as described in Terminating the HTTP Session.
void	connect() Connects to the 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.
protected void	restartStream() Restarts the stream.
void	send(ClientStreamElement element) Sends an element.

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

compressStream, getHostname, getPort, getProxy, getXmppSession, initialize

Methods inherited from class java.lang.Object

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

Method Detail

connect

public void connect()
             throws IOException

Description copied from class: Connection

Connects to the server.

Specified by:

connect in class Connection

Throws:

IOException - If no connection could be established, e.g. due to unknown host.

restartStream

protected void restartStream()

Restarts the stream.

Authentication and Resource Binding

Upon receiving the <success/> element, the client MUST then ask the connection manager to restart the stream by sending a "restart request" that is structured as follows

• The BOSH <body/> element MUST include a boolean 'restart' attribute (qualified by the 'urn:xmpp:xbosh' namespace) whose value is set to "true".
• The BOSH <body/> element SHOULD include the 'to' attribute.
• The BOSH <body/> element SHOULD include the 'xml:lang' attribute.
• The BOSH <body/> element SHOULD be empty (i.e., not contain an XML stanza). However, if the client includes an XML stanza in the body, the connection manager SHOULD ignore it.

Specified by:

restartStream in class Connection

close

public void close()
           throws IOException

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.

Throws:

IOException - If the underlying HTTP connection threw an exception.

detach

public 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 void send(ClientStreamElement element)

Description copied from class: Connection

Sends an element.

Specified by:

send in class Connection

Parameters:

element - The element.

getSessionId

public String getSessionId()

Gets the session id of this BOSH connection.

Returns:

The session id.

getRoute

public 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.