Package org.freedesktop.dbus.connections.config

Class SaslConfigBuilder<R>

java.lang.Object

org.freedesktop.dbus.connections.config.SaslConfigBuilder<R>

public final class SaslConfigBuilder<R>
extends java.lang.Object

Configuration used to setup a sasl authentication.

Since:

v4.2.2 - 2023-02-03

Field Summary

Fields

Modifier and Type	Field	Description
private SaslConfig	saslConfig
private java.util.function.Supplier<TransportConfigBuilder<?,R>>	transportBuilder

Constructor Summary

Constructors

Constructor	Description
SaslConfigBuilder(SaslConfig _saslConfig, java.util.function.Supplier<TransportConfigBuilder<?,R>> _transportBuilder)

Method Summary

Modifier and Type	Method	Description
TransportConfigBuilder<?,R>	back()	Return to the previous builder.
SaslConfig	build()	Returns the created configuration.
SaslConfigBuilder<R>	withAuthMode(TransportBuilder.SaslAuthMode _types)	Setup the authentication mode to use.
SaslConfigBuilder<R>	withSaslUid(java.lang.Long _saslUid)	Setup the user ID to use for authentication when using unix sockets. Will default to the user ID of the user running the current process.
SaslConfigBuilder<R>	withStrictCookiePermissions(boolean _strictCookiePermissions)	Enable/disable checking of file permissions of the cookie files (used for DBUS_COOKIE_SHA1). Cookie permission check will only be used on Linux/Unix like OSes. Default is false (no strict checking).

Methods inherited from class java.lang.Object

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

Field Detail

saslConfig

private final SaslConfig saslConfig

transportBuilder

private final java.util.function.Supplier<TransportConfigBuilder<?,R>> transportBuilder

Constructor Detail

SaslConfigBuilder

SaslConfigBuilder(SaslConfig _saslConfig,
                  java.util.function.Supplier<TransportConfigBuilder<?,R>> _transportBuilder)

Method Detail

back

public TransportConfigBuilder<?,R> back()

Return to the previous builder.

This allows you to return from the this builder to the builder which started this builder so you can continue using the previous builder.

Returns:

previous builder, maybe null

withAuthMode

public SaslConfigBuilder<R> withAuthMode(TransportBuilder.SaslAuthMode _types)

Setup the authentication mode to use.
null values will be ignored.

Parameters:

_types - auth mode to set

Returns:

this

withSaslUid

public SaslConfigBuilder<R> withSaslUid(java.lang.Long _saslUid)

Setup the user ID to use for authentication when using unix sockets.
Will default to the user ID of the user running the current process.

Parameters:

_guid - guid to use

Returns:

this

withStrictCookiePermissions

public SaslConfigBuilder<R> withStrictCookiePermissions(boolean _strictCookiePermissions)

Enable/disable checking of file permissions of the cookie files (used for DBUS_COOKIE_SHA1).
Cookie permission check will only be used on Linux/Unix like OSes.
Default is false (no strict checking).

Parameters:

_strictCookiePermissions - boolean

Returns:

this

build

public SaslConfig build()

Returns the created configuration.

Returns:

SaslConfig