Package org.freedesktop.dbus.connections.impl

Class DBusConnectionBuilder

java.lang.Object

org.freedesktop.dbus.connections.impl.BaseConnectionBuilder<DBusConnectionBuilder,DBusConnection>

org.freedesktop.dbus.connections.impl.DBusConnectionBuilder

public final class DBusConnectionBuilder
extends BaseConnectionBuilder<DBusConnectionBuilder,DBusConnection>

Builder to create a new DBusConnection.

Version:

4.1.0 - 2022-02-04

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	machineId
private boolean	registerSelf
private boolean	shared

Constructor Summary

Constructors

Modifier	Constructor	Description
private	DBusConnectionBuilder(BusAddress _address, java.lang.String _machineId)

Method Summary

Modifier and Type	Method	Description
DBusConnection	build()	Create the new DBusConnection.
static DBusConnectionBuilder	forAddress(java.lang.String _address)	Use the given address to create the connection (e.g.
static DBusConnectionBuilder	forAddress(BusAddress _address)	Use the given address to create the connection (e.g.
static DBusConnectionBuilder	forSessionBus()	Create a new default connection connecting to the DBus session bus.
static DBusConnectionBuilder	forSessionBus(java.lang.String _machineIdFileLocation)	Create a new default connection connecting to DBus session bus but use an alternative input for the machineID.
static DBusConnectionBuilder	forSystemBus()	Create new default connection to the DBus system bus.
static DBusConnectionBuilder	forType(DBusConnection.DBusBusType _type)	Create a default connection to DBus using the given bus type.
static DBusConnectionBuilder	forType(DBusConnection.DBusBusType _type, java.lang.String _machineIdFile)	Create a default connection to DBus using the given bus type and machineIdFile.
static byte	getSystemEndianness()	Deprecated, for removal: This API element is subject to removal in a future version. if required, use BaseConnectionBuilder.getSystemEndianness()
private static BusAddress	validateTransportAddress(BusAddress _address)	Checks if the given address can be used with the available transports.
DBusConnectionBuilder	withRegisterSelf(boolean _register)	Register the new connection on DBus using 'hello' message.
DBusConnectionBuilder	withShared(boolean _shared)	Use this connection as shared connection.

Methods inherited from class org.freedesktop.dbus.connections.impl.BaseConnectionBuilder

buildThreadConfig, buildTransportConfig, getDisconnectCallback, getEndianess, isWeakReference, receivingThreadConfig, self, transportConfig, withDisconnectCallback, withEndianess, withErrorHandlerThreadCount, withMethodCallThreadCount, withMethodReturnThreadCount, withSignalThreadCount, withWeakReferences

Methods inherited from class java.lang.Object

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

Field Detail

machineId

private final java.lang.String machineId

registerSelf

private boolean registerSelf

shared

private boolean shared

Constructor Detail

DBusConnectionBuilder

private DBusConnectionBuilder(BusAddress _address,
                              java.lang.String _machineId)

Method Detail

forSessionBus

public static DBusConnectionBuilder forSessionBus(java.lang.String _machineIdFileLocation)

Create a new default connection connecting to DBus session bus but use an alternative input for the machineID.

Parameters:

_machineIdFileLocation - file with machine ID

Returns:

DBusConnectionBuilder

forSystemBus

public static DBusConnectionBuilder forSystemBus()

Create new default connection to the DBus system bus.

Returns:

DBusConnectionBuilder

forSessionBus

public static DBusConnectionBuilder forSessionBus()

Create a new default connection connecting to the DBus session bus.

Returns:

DBusConnectionBuilder

forType

public static DBusConnectionBuilder forType(DBusConnection.DBusBusType _type)

Create a default connection to DBus using the given bus type.

Parameters:

_type - bus type

Returns:

this

forType

public static DBusConnectionBuilder forType(DBusConnection.DBusBusType _type,
                                            java.lang.String _machineIdFile)

Create a default connection to DBus using the given bus type and machineIdFile.

Parameters:

_type - bus type

_machineIdFile - machineId file

Returns:

this

forAddress

public static DBusConnectionBuilder forAddress(java.lang.String _address)

Use the given address to create the connection (e.g. used for remote TCP connected DBus daemons).

Parameters:

_address - address to use

Returns:

this

forAddress

public static DBusConnectionBuilder forAddress(BusAddress _address)

Use the given address to create the connection (e.g. used for remote TCP connected DBus daemons).

Parameters:

_address - address to use

Returns:

this

Since:

4.2.0 - 2022-07-18

validateTransportAddress

private static BusAddress validateTransportAddress(BusAddress _address)

Checks if the given address can be used with the available transports. Will fallback to TCP if no address given and TCP transport is available.

Parameters:

_address - address to check

Returns:

address, maybe fallback address

withRegisterSelf

public DBusConnectionBuilder withRegisterSelf(boolean _register)

Register the new connection on DBus using 'hello' message. Default is true.

Parameters:

_register - boolean

Returns:

this

withShared

public DBusConnectionBuilder withShared(boolean _shared)

Use this connection as shared connection. Shared connection means that the same connection is used multiple times if the connection parameter did not change. Default is true.

Parameters:

_shared - boolean

Returns:

this

build

public DBusConnection build()
                     throws DBusException

Create the new DBusConnection.

Specified by:

build in class BaseConnectionBuilder<DBusConnectionBuilder,DBusConnection>

Returns:

DBusConnection

Throws:

DBusException - when DBusConnection could not be opened

getSystemEndianness

@Deprecated(forRemoval=true,
            since="4.2.0")
public static byte getSystemEndianness()

Deprecated, for removal: This API element is subject to removal in a future version.

if required, use BaseConnectionBuilder.getSystemEndianness()

Get the default system endianness.

Returns:

LITTLE or BIG