Module org.freedesktop.dbus
Package org.freedesktop.dbus.connections.transports

Class TransportBuilder

java.lang.Object
org.freedesktop.dbus.connections.transports.TransportBuilder
public class TransportBuilder extends Object
Builder to create transports of different types.
Since:
v4.0.0 - 2021-09-17
Author:
hypfvieh

  • Method Details

    • create

      public static TransportBuilder create(String _address) throws DBusException
      Creates a new TransportBuilder instance with the given address.
      Parameters:
      _address - address, never null
      Returns:
      new TransportBuilder
      Throws:
      DBusException - if invalid address provided

    • create

      public static TransportBuilder create(BusAddress _address) throws DBusException
      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

    • withTimeout

      public TransportBuilder withTimeout(int _timeout)
      Set the connection timeout (usually only used for TCP based transports).

      default: AbstractConnection.TCP_CONNECT_TIMEOUT

      Parameters:
      _timeout - timeout, if < 0 default timeout of AbstractConnection.TCP_CONNECT_TIMEOUT will be used
      Returns:
      this

    • isListening

      public TransportBuilder isListening(boolean _listen)
      Toggle the created transport to be a listening (server) or initiating (client) connection.

      Default is a client connection.

      Parameters:
      _listen - true to create a listening transport (e.g. for server usage)
      Returns:

    • withAutoConnect

      public TransportBuilder withAutoConnect(boolean _connect)
      Instantly connect to DBus when build() is called.

      default: true

      Parameters:
      _connect - boolean
      Returns:
      this

    • withSaslAuthMode

      public TransportBuilder withSaslAuthMode(TransportBuilder.SaslAuthMode _authMode)
      Set a different SASL authentication mode.

      Usually when a unixsocket based transport is used, TransportBuilder.SaslAuthMode.AUTH_EXTERNAL will be used. For TCP based transport TransportBuilder.SaslAuthMode.AUTH_COOKIE will be used.

      Parameters:
      _authMode - authmode to use, if null is given, default mode will be used
      Returns:
      this

    • withUnixSocketFileOwner

      public TransportBuilder withUnixSocketFileOwner(String _user)
      The owner of the socket file if a unix socket is used and this is a server transport.

      Default is the user of the running JVM process.

      Please note:
      The running process user has to have suitable permissions to change the owner of the file. Otherwise the file owner will not be changed!

      Parameters:
      _user - user to set, if null is given JVM process user is used
      Returns:
      this

    • withUnixSocketFileGroup

      public TransportBuilder withUnixSocketFileGroup(String _group)
      The group of the socket file if a unix socket is used and this is a server transport.

      Default is the group of the running JVM process.

      Please note:
      The running process user has to have suitable permissions to change the group of the file. Otherwise the file group will not be changed!

      Parameters:
      _group - group to set, if null is given JVM process group is used
      Returns:
      this

    • withUnixSocketFilePermissions

      public TransportBuilder withUnixSocketFilePermissions(PosixFilePermission... _permissions)
      The permissions which will be set on socket file if a unix socket is used and this is a server transport.

      This method does nothing when used on windows systems. Please note:
      The running process user has to have suitable permissions to change the permissions of the file. Otherwise the file permissions will not be changed!

      Parameters:
      _permissions - permissions to set, if null is given default permissions will be used
      Returns:
      this

    • build

      public AbstractTransport build() throws DBusException, IOException
      Create the transport with the previously provided configuration.
      Returns:
      AbstractTransport instance
      Throws:
      DBusException - when creating transport fails
      IOException - when autoconnect is true 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