rocks.xmpp.core.session

Class XmppSessionConfiguration.Builder

java.lang.Object

rocks.xmpp.core.session.XmppSessionConfiguration.Builder

Enclosing class:

XmppSessionConfiguration

public static final class XmppSessionConfiguration.Builder
extends Object

A builder to create an XmppSessionConfiguration instance.

Method Summary

Modifier and Type	Method and Description
XmppSessionConfiguration.Builder	authenticationMechanisms(String... authenticationMechanisms) Sets the preferred mechanisms used for this XMPP session.
XmppSessionConfiguration	build() Builds the configuration.
XmppSessionConfiguration.Builder	cacheDirectory(Path path) Sets the caching directory for directory-based caches used for: XEP-0084: User Avatar XEP-0115: Entity Capabilities XEP-0153: vCard-Based Avatars If you want to disable the use of directory caching, pass null.
XmppSessionConfiguration.Builder	context(CoreContext context) Deprecated. Use extensions(Extension...) in order to add custom extensions.
XmppSessionConfiguration.Builder	debugger(Class<? extends XmppDebugger> xmppDebugger) Sets the debugger.
XmppSessionConfiguration.Builder	defaultResponseTimeout(int defaultResponseTimeout) Sets the default response timeout for synchronous calls, usually IQ calls.
XmppSessionConfiguration.Builder	extensions(Extension... extensions) Adds extensions to the session.
XmppSessionConfiguration.Builder	initialPresence(Supplier<Presence> presenceSupplier) Sets a supplier for initial presence which is sent during login.

Methods inherited from class java.lang.Object

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

Method Detail

debugger

public final XmppSessionConfiguration.Builder debugger(Class<? extends XmppDebugger> xmppDebugger)

Sets the debugger.

Parameters:

xmppDebugger - The debugger or null, if you don't want to use a debugger.

Returns:

The debugger.

context

@Deprecated
public final XmppSessionConfiguration.Builder context(CoreContext context)

Deprecated. Use extensions(Extension...) in order to add custom extensions.

Sets XMPP context which is used to setup the JAXBContext and which defines the initial extension managers.

Parameters:

context - The context.

Returns:

The builder.

extensions

public final XmppSessionConfiguration.Builder extensions(Extension... extensions)

Adds extensions to the session.

Parameters:

extensions - The extensions.

Returns:

The builder.

defaultResponseTimeout

public final XmppSessionConfiguration.Builder defaultResponseTimeout(int defaultResponseTimeout)

Sets the default response timeout for synchronous calls, usually IQ calls.

Parameters:

defaultResponseTimeout - The default response timeout.

Returns:

The builder.

authenticationMechanisms

public final XmppSessionConfiguration.Builder authenticationMechanisms(String... authenticationMechanisms)

Sets the preferred mechanisms used for this XMPP session.

6.3.3. Mechanism Preferences

Any entity that will act as a SASL client or a SASL server MUST maintain an ordered list of its preferred SASL mechanisms according to the client or server, where the list is ordered according to local policy or user configuration (which SHOULD be in order of perceived strength to enable the strongest authentication possible). The initiating entity MUST maintain its own preference order independent of the preference order of the receiving entity. A client MUST try SASL mechanisms in its preference order. For example, if the server offers the ordered list "PLAIN SCRAM-SHA-1 GSSAPI" or "SCRAM-SHA-1 GSSAPI PLAIN" but the client's ordered list is "GSSAPI SCRAM-SHA-1", the client MUST try GSSAPI first and then SCRAM-SHA-1 but MUST NOT try PLAIN (since PLAIN is not on its list).

Parameters:

authenticationMechanisms - The preferred mechanisms.

Returns:

The builder.

cacheDirectory

public final XmppSessionConfiguration.Builder cacheDirectory(Path path)

Sets the caching directory for directory-based caches used for:

• XEP-0084: User Avatar
• XEP-0115: Entity Capabilities
• XEP-0153: vCard-Based Avatars

If you want to disable the use of directory caching, pass null.

Parameters:

path - The directory.

Returns:

The builder.

See Also:

XmppSessionConfiguration.getCacheDirectory()

initialPresence

public final XmppSessionConfiguration.Builder initialPresence(Supplier<Presence> presenceSupplier)

Sets a supplier for initial presence which is sent during login. If the supplier is null or returns null, no initial presence is sent.

Parameters:

presenceSupplier - The presence supplier.

Returns:

The builder.

See Also:

4.2. Initial Presence

build

public final XmppSessionConfiguration build()

Builds the configuration.

Returns:

The configuration.