Top Description Fields Constructors Methods
org.freedesktop.dbus.connections.config

public final Class SaslConfigBuilder<R>

extends Object
Class Inheritance
Imports
org.freedesktop.dbus.connections.transports.TransportBuilder.SaslAuthMode, java.util.OptionalLong
Configuration used to setup a sasl authentication.
Author
hypfvieh
Since
v4.2.2 - 2023-02-03

Field Summary

Modifier and TypeField and Description
private SaslConfig
saslConfig

private final TransportConfigBuilder<?, R>
transportBuilder

Constructor Summary

AccessConstructor and Description
pack-priv
SaslConfigBuilder(TransportConfigBuilder<?, R> _transportBuilder)

Method Summary

Modifier and TypeMethod and Description
public TransportConfigBuilder<?, R>

Returns:

previous builder, maybe null
back()

Return to the previous builder.

public SaslConfig

Returns:

SaslConfig
build()

Returns the created configuration.

public SaslConfigBuilder<R>

Returns:

this
withAuthMode(TransportBuilder.SaslAuthMode
auth mode to set
_types)

Setup the authentication mode to use.

pack-priv SaslConfigBuilder<R>

Returns:

this
withConfig(SaslConfig
sasl config
_cfg)

Replace the current SaslConfig with the given instance.

public SaslConfigBuilder<R>

Returns:

this
withSaslUid(Long
uid to use
_saslUid)

Setup the user ID to use for authentication when using unix sockets.

public SaslConfigBuilder<R>

Returns:

this
withStrictCookiePermissions(boolean
boolean
_strictCookiePermissions)

Enable/disable checking of file permissions of the cookie files (used for DBUS_COOKIE_SHA1).

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

saslConfigback to summary
private SaslConfig saslConfig
transportBuilderback to summary
private final TransportConfigBuilder<?, R> transportBuilder

Constructor Detail

SaslConfigBuilderback to summary
pack-priv SaslConfigBuilder(TransportConfigBuilder<?, R> _transportBuilder)

Method Detail

backback to summary
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:TransportConfigBuilder<?, R>

previous builder, maybe null

buildback to summary
public SaslConfig build()

Returns the created configuration.

Returns:SaslConfig

SaslConfig

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

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

Parameters
_types:TransportBuilder.SaslAuthMode

auth mode to set

Returns:SaslConfigBuilder<R>

this

withConfigback to summary
pack-priv SaslConfigBuilder<R> withConfig(SaslConfig _cfg)

Replace the current SaslConfig with the given instance.
Will do nothing if null is given.

Parameters
_cfg:SaslConfig

sasl config

Returns:SaslConfigBuilder<R>

this

withSaslUidback to summary
public SaslConfigBuilder<R> withSaslUid(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
_saslUid:Long

uid to use

Returns:SaslConfigBuilder<R>

this

withStrictCookiePermissionsback to summary
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

boolean

Returns:SaslConfigBuilder<R>

this