Top Description Methods
org.freedesktop.dbus.spi.transport

public Interface ITransportProvider

Imports
org.freedesktop.dbus.connections.BusAddress, org.freedesktop.dbus.connections.config.TransportConfig, org.freedesktop.dbus.connections.transports.AbstractTransport, org.freedesktop.dbus.exceptions.TransportConfigurationException, javax.xml.transform.TransformerConfigurationException

Interface used by ServiceLoader to provide a transport used by DBus.
Author
hypfvieh
Since
v4.0.0 - 2021-09-05

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

String containing bus address
createDynamicSessionAddress
(boolean
true when listening address should be created
_listeningSocket
)

Creates a new (dynamic) session for this transport.

public AbstractTransport

Returns:

transport instance or null
createTransport
(BusAddress
bus address
_address
,
TransportConfig
configuration for this transport
_config
)

Creates a new instance of this transport service using the given bus address.

public String

Returns:

String, never null
getSupportedBusType
()

Type of transport.

public String

Returns:

String, should not be null or empty
getTransportName
()

Name of the transport implementation.

Method Detail

createDynamicSessionAddressback to summary
public String createDynamicSessionAddress(boolean _listeningSocket)

Creates a new (dynamic) session for this transport.

Parameters
_listeningSocket:boolean

true when listening address should be created

Returns:String

String containing bus address

createTransportback to summary
public AbstractTransport createTransport(BusAddress _address, TransportConfig _config) throws TransportConfigurationException

Creates a new instance of this transport service using the given bus address.

If transport cannot be created because bus address type is not supported, null should be returned. If initialization fails because of any other error, throw a TransportConfigurationException.

Parameters
_address:BusAddress

bus address

_config:TransportConfig

configuration for this transport

Returns:AbstractTransport

transport instance or null

Exceptions
TransformerConfigurationException:
when configuring transport fails
getSupportedBusTypeback to summary
public String getSupportedBusType()

Type of transport. Should return an identifier for the supported socket type (e.g. UNIX for unix socket, TCP for tcp sockets).

Returns:String

String, never null

getTransportNameback to summary
public String getTransportName()

Name of the transport implementation.

Returns:String

String, should not be null or empty