Package rocks.xmpp.extensions.httpbind

Class BoshConnectionConfiguration.Builder

java.lang.Object

rocks.xmpp.core.net.client.ClientConnectionConfiguration.Builder<BoshConnectionConfiguration.Builder,BoshConnectionConfiguration>

rocks.xmpp.extensions.httpbind.BoshConnectionConfiguration.Builder

Enclosing class:

BoshConnectionConfiguration

public static final class BoshConnectionConfiguration.Builder
extends ClientConnectionConfiguration.Builder<BoshConnectionConfiguration.Builder,BoshConnectionConfiguration>

A builder to create a BoshConnectionConfiguration instance.

Method Summary

Modifier and Type	Method	Description
BoshConnectionConfiguration	build()	Builds the connection configuration.
BoshConnectionConfiguration.Builder	path(String path)	Sets the path on the host, e.g.
BoshConnectionConfiguration.Builder	route(String route)	Sets the route, formatted as "protocol:host:port" (e.g., "xmpp:example.com:9999").
BoshConnectionConfiguration.Builder	useKeySequence(boolean useKeySequence)	Indicates whether a key sequencing mechanism is used to secure a connection.
BoshConnectionConfiguration.Builder	wait(Duration wait)	Sets the longest time that the connection manager is allowed to wait before responding to any request during the session.

Methods inherited from class rocks.xmpp.core.net.client.ClientConnectionConfiguration.Builder

channelEncryption, compressionMethods, connector, connectTimeout, getConnector, hostname, hostnameVerifier, port, proxy, sslContext

Methods inherited from class java.lang.Object

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

Method Detail

path

public BoshConnectionConfiguration.Builder path(String path)

Sets the path on the host, e.g. "/http-bind/"

Parameters:

path - The path on the host.

Returns:

The builder.

wait

public BoshConnectionConfiguration.Builder wait(Duration wait)

Sets the longest time that the connection manager is allowed to wait before responding to any request during the session.

Parameters:

wait - The time in seconds.

Returns:

The builder.

See Also:

7.1 Session Creation Request

route

public BoshConnectionConfiguration.Builder route(String route)

Sets the route, formatted as "protocol:host:port" (e.g., "xmpp:example.com:9999").

Parameters:

route - The route.

Returns:

The builder.

See Also:

7.1 Session Creation Request

useKeySequence

public BoshConnectionConfiguration.Builder useKeySequence(boolean useKeySequence)

Indicates whether a key sequencing mechanism is used to secure a connection. Note that if the connection is already secured via HTTPS, it is not necessary to use this mechanism.

Parameters:

useKeySequence - If a key sequence should be used.

Returns:

The builder.

See Also:

15. Protecting Insecure Sessions

build

public BoshConnectionConfiguration build()

Description copied from class: ClientConnectionConfiguration.Builder

Builds the connection configuration.

Specified by:

build in class ClientConnectionConfiguration.Builder<BoshConnectionConfiguration.Builder,BoshConnectionConfiguration>

Returns:

The concrete connection configuration.