rocks.xmpp.core.session

Class ConnectionConfiguration.Builder<T extends ConnectionConfiguration.Builder<T>>

java.lang.Object

rocks.xmpp.core.session.ConnectionConfiguration.Builder<T>

Type Parameters:

T - The concrete builder class.

Direct Known Subclasses:

BoshConnectionConfiguration.Builder, TcpConnectionConfiguration.Builder

Enclosing class:

ConnectionConfiguration

public abstract static class ConnectionConfiguration.Builder<T extends ConnectionConfiguration.Builder<T>>
extends Object

An abstract builder class for building immutable configuration objects.

Method Summary

Modifier and Type	Method and Description
abstract ConnectionConfiguration	build() Builds the connection configuration.
T	compressionMethods(CompressionMethod... compressionMethods) Sets the compression method.
T	connectTimeout(int connectTimeout) Sets a timeout for the connection establishment.
T	hostname(String hostname) Sets the hostname.
T	hostnameVerifier(HostnameVerifier hostnameVerifier) Sets an optional hostname verifier, used to verify the hostname in the certificate presented by the server.
T	port(int port) Sets the port.
T	proxy(Proxy proxy) Sets the proxy, e.g. if you are behind a HTTP proxy and use a BOSH connection.
T	secure(boolean secure) Sets whether the connection is secured via SSL.
T	sslContext(SSLContext sslContext) Sets a custom SSL context, used to secure the connection.

Methods inherited from class java.lang.Object

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

Method Detail

hostname

public final T hostname(String hostname)

Sets the hostname.

Parameters:

hostname - The hostname.

Returns:

The builder.

port

public final T port(int port)

Sets the port.

Parameters:

port - The port.

Returns:

The builder.

proxy

public final T proxy(Proxy proxy)

Sets the proxy, e.g. if you are behind a HTTP proxy and use a BOSH connection.

Parameters:

proxy - The proxy.

Returns:

The builder.

secure

public final T secure(boolean secure)

Sets whether the connection is secured via SSL.

A standard TCP connection starts with a plain socket and negotiates a secure SSL connection during stream negotiation via 'StartTLS'. Hence, setting secure(true) means, you start with a plain socket and upgrade it to a secure socket during XMPP negotiation.

Setting secure(false) means, you start with plain socket and won't upgrade to a secure socket. However, some servers require that the client secures the connection, in which case an exception is thrown during connecting.

If your server expects the connection to be secured immediately (often on port 5223), you should set a custom SSL socket factory.

See RFC 6120 § 5. STARTTLS Negotiation for further information.

HTTP (BOSH) and WebSocket connections provide TLS outside of the XMPP layer, i.e. it's not negotiated in XMPP. Setting secure(true) for these connection methods means the connection connects via https or wss respectively.

If you set this to true, you should also set an SSLContext. Otherwise SSLContext.getDefault() is used.

Parameters:

secure - If the connection is secured via SSL.

Returns:

The builder.

See Also:

sslContext(SSLContext)

sslContext

public final T sslContext(SSLContext sslContext)

Sets a custom SSL context, used to secure the connection. This SSL context only takes effect, when setting secure(true).

Parameters:

sslContext - The SSL context.

Returns:

The builder.

See Also:

secure(boolean)

hostnameVerifier

public final T hostnameVerifier(HostnameVerifier hostnameVerifier)

Sets an optional hostname verifier, used to verify the hostname in the certificate presented by the server. If no verifier is set, the hostname is verified nonetheless using the default.

Parameters:

hostnameVerifier - The hostname verifier.

Returns:

The builder.

connectTimeout

public final T connectTimeout(int connectTimeout)

Sets a timeout for the connection establishment.

Connecting to a XMPP server involves multiple steps:

• DNS lookup
• Connection establishment of the underlying transport (e.g. TCP or HTTP)
• XMPP stream negotiation

This timeout is only used for DNS lookup (which is not used in all cases) and for connection establishment of the underlying transport (e.g. for a socket connection), but not for stream negotiation. Therefore it does not reflect how long the whole connection process may take, but should be understood as hint for establishing the underlying XMPP transport.

XMPP stream negotiation is configured via XmppSessionConfiguration.Builder.defaultResponseTimeout(java.time.Duration)

Parameters:

connectTimeout - The timeout in milliseconds.

Returns:

The builder.

Throws:

IllegalArgumentException - If the timeout is negative.

See Also:

XmppSession.connect()

compressionMethods

public final T compressionMethods(CompressionMethod... compressionMethods)

Sets the compression method.

Parameters:

compressionMethods - The compression methods.

Returns:

The builder.

See Also:

CompressionMethod.ZLIB, CompressionMethod.GZIP, CompressionMethod.DEFLATE

build

public abstract ConnectionConfiguration build()

Builds the connection configuration.

Returns:

The concrete connection configuration.