Class TransportBuilder

java.lang.Object

org.freedesktop.dbus.connections.transports.TransportBuilder

public final class TransportBuilder
extends Object

Builder to create transports of different types.

Since:

v4.0.0 - 2021-09-17

Author:

hypfvieh

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TransportBuilder.SaslAuthMode	Represents supported SASL authentication modes.

Method Summary

Modifier and Type	Method	Description
AbstractTransport	build()	Create the transport with the previously provided configuration.
TransportConfigBuilder<TransportConfigBuilder<?, TransportBuilder>, TransportBuilder>	configure()	Returns the configuration builder to configure the transport.
static TransportBuilder	create()	Creates a new TransportBuilder instance using a empty transport configuration.
static TransportBuilder	create(String _address)	Creates a new TransportBuilder instance with the given address.
static TransportBuilder	create(BusAddress _address)	Creates a new TransportBuilder instance with the given address.
static TransportBuilder	create(TransportConfig _config)	Creates a new TransportBuilder instance using the given configuration.
static String	createDynamicSession(String _busType, boolean _listeningAddress)	Creates a new dynamic bus address for the given bus type.
static TransportBuilder	createWithDynamicSession(String _transportType)	Creates a new TransportBuilder with a dynamically created address.
BusAddress	getAddress()	The currently configured BusAddress.
static List<String>	getRegisteredBusTypes()	Returns a List of all bustypes supported in the current runtime.

Methods inherited from class Object

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

Method Details

create

public static TransportBuilder create(String _address)
                               throws InvalidBusAddressException

Creates a new TransportBuilder instance with the given address.

Parameters:

_address - address, never null

Returns:

new TransportBuilder

Throws:

InvalidBusAddressException - if invalid address provided

create

public static TransportBuilder create(TransportConfig _config)
                               throws InvalidBusAddressException

Creates a new TransportBuilder instance using the given configuration.

Parameters:

_config - config, never null

Returns:

new TransportBuilder

Throws:

InvalidBusAddressException - if invalid address provided

create

public static TransportBuilder create()

Creates a new TransportBuilder instance using a empty transport configuration.

Returns:

new TransportBuilder

create

public static TransportBuilder create(BusAddress _address)

Creates a new TransportBuilder instance with the given address.

Parameters:

_address - address, never null

Returns:

new TransportBuilder

Throws:

DBusException - if invalid address provided

createWithDynamicSession

public static TransportBuilder createWithDynamicSession(String _transportType)
                                                 throws DBusException

Creates a new TransportBuilder with a dynamically created address.

Parameters:

_transportType - type of session (e.g. UNIX or TCP)

Returns:

TransportBuilder

Throws:

DBusException - when invalid/unknown/unsupported transport type given

configure

public TransportConfigBuilder<TransportConfigBuilder<?, TransportBuilder>, TransportBuilder> configure()

Returns the configuration builder to configure the transport.

Returns:

TransportConfigBuilder

build

public AbstractTransport build()
                        throws DBusException,
IOException

Create the transport with the previously provided configuration.

If autoconnect is enabled and this is a client connection, the connection will be established automatically. Establishing the connection will be retried several times to allow connection in concurrent setups. The max retry attempts are calculated by using the configured connection timeout (default: 10000 millis) divided by 500. The minimum of retries is 1.

Without autoconnect, the connection will not be started and has to be started by calling connect() on the connection instance. In that case there are no automatic reconnection attempts.

Returns:

AbstractTransport instance

Throws:

DBusException - when creating transport fails

IOException - when autoconnect is true, connection is not a listening connection and connection to DBus failed

getAddress

public BusAddress getAddress()

The currently configured BusAddress.

Returns:

BusAddress

getRegisteredBusTypes

public static List<String> getRegisteredBusTypes()

Returns a List of all bustypes supported in the current runtime.

Returns:

List, maybe empty

createDynamicSession

public static String createDynamicSession(String _busType,
 boolean _listeningAddress)

Creates a new dynamic bus address for the given bus type.

Parameters:

_busType - bus type (e.g. UNIX or TCP), never null

_listeningAddress - true if a listening (server) address should be created, false otherwise

Returns:

String containing BusAddress or null