rocks.xmpp.core.session

Class Connection

java.lang.Object

rocks.xmpp.core.session.Connection

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

BoshConnection, TcpConnection

public abstract class Connection
extends Object
implements AutoCloseable

The base connection class which provides hostname, port and proxy information.

Method Summary

Modifier and Type	Method and Description
abstract void	connect(rocks.xmpp.addr.Jid from, String namespace, Consumer<rocks.xmpp.addr.Jid> onStreamOpened) Connects to the server and provides an optional 'from' attribute.
String	getHostname() Gets the hostname, which is used for the connection.
int	getPort() Gets the port, which is used for the connection.
Proxy	getProxy() Gets the proxy.
abstract String	getStreamId() Gets the stream id of this connection.
abstract boolean	isSecure() Indicates whether this connection is secured by TLS/SSL.
abstract boolean	isUsingAcknowledgements() Indicates, whether this connection is using acknowledgements.
abstract CompletableFuture<Void>	send(StreamElement streamElement) Sends an element over this connection.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

getHostname

public final String getHostname()

Gets the hostname, which is used for the connection.

Returns:

The hostname.

getPort

public final int getPort()

Gets the port, which is used for the connection.

Returns:

The port.

getProxy

public final Proxy getProxy()

Gets the proxy.

Returns:

The proxy.

send

public abstract CompletableFuture<Void> send(StreamElement streamElement)

Sends an element over this connection.

Parameters:

streamElement - The element.

Returns:

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

connect

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

Connects to the server and provides an optional 'from' attribute.

Parameters:

from - The 'from' attribute.

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 no connection could be established, e.g. due to unknown host.

isSecure

public abstract boolean isSecure()

Indicates whether this connection is secured by TLS/SSL.

Returns:

True, if this connection is secured.

getStreamId

public abstract String getStreamId()

Gets the stream id of this connection.

Returns:

The stream id.

isUsingAcknowledgements

public abstract boolean isUsingAcknowledgements()

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.

Returns:

True, if this connection is using acknowledgements.

See Also:

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