dbus-java 5.1.1 · org.freedesktop.dbus.connections.impl.DBusConnection

Modifier and Type	Class and Description
public static enum	DBusConnection.DBusBusType
private class	DBusConnection.SigHandler

Modifier and Type	Field and Description
private final List<String>	busnames
pack-priv final AtomicInteger	concurrentConnections Count how many 'connections' we manage internally.
pack-priv static final ConcurrentMap<String, DBusConnection>	CONNECTIONS
private DBus	dbus
private final Logger	logger Hides org.freedesktop.dbus.connections.base.AbstractConnectionBase.logger.
private final String	machineId
private boolean	registered Whether the connection was registered using 'Hello' message.
private final boolean	shared Whether this connection is used in shared mode.

Access	Constructor and Description
pack-priv	DBusConnection(boolean _shared, String _machineId, ConnectionConfig _conCfg, TransportConfig _tranportCfg, ReceivingServiceConfig _rsCfg)

Method Summary

Modifier and Type	Method and Description
public AutoCloseable	addGenericSigHandler(DBusMatchRule rule to add _rule, DBusSigHandler<DBusSignal> handler to use _handler) Implements abstract org.freedesktop.dbus.connections.AbstractConnection.addGenericSigHandler. Adds a `DBusMatchRule` to with a generic signal handler.
public < class extending `DBusSignal` T extends DBusSignal> AutoCloseable	Returns: closeable that removes signal handler addSigHandler(Class<T> The signal to watch for. _type, String The process which will send the signal. This MUST be a unique bus name and not a well known name. _source, DBusSigHandler<T> The handler to call when a signal is received. _handler) Add a Signal Handler.
public < class extending `DBusSignal` T extends DBusSignal> AutoCloseable	Returns: closeable that removes signal handler addSigHandler(Class<T> The signal to watch for. _type, String The process which will send the signal. This MUST be a unique bus name and not a well known name. _source, DBusInterface The object from which the signal will be emitted _object, DBusSigHandler<T> The handler to call when a signal is received. _handler) Add a Signal Handler.
public <T extends DBusSignal> AutoCloseable	addSigHandler(DBusMatchRule rule to add _rule, DBusSigHandler<T> handler to use _handler) Implements abstract org.freedesktop.dbus.connections.AbstractConnection.addSigHandler. Add a signal handler with the given `DBusMatchRule` to DBus.
public void	close() Overrides org.freedesktop.dbus.connections.base.AbstractConnectionBase.close. Implements java.io.Closeable.close. Same as disconnect.
pack-priv void	connectImpl() Connect to bus and register if asked.
public synchronized void	disconnect() Overrides org.freedesktop.dbus.connections.base.AbstractConnectionBase.disconnect. Disconnect from the Bus.
private void	doWithBusNames(Consumer<List<String>> action to execute _action) Do some action with the currently registered names in a synchronized manor.
private <T> T	Returns: whatever the action returns doWithBusNamesAndReturn(Function<List<String>, T> action to execute _action) Do some action with the currently registered names in a synchronized manor.
public < object type (DBusInterface compatible) T extends DBusInterface> T	Returns: DBusInterface compatible object dynamicProxy(String source _source, String path _path, Class<T> class of object type _type) Tries to resolve a proxy to a remote object.
private AtomicInteger	getConcurrentConnections()
public String	getDBusOwnerName(String bus name _busName) Implements org.freedesktop.dbus.connections.impl.IRemoteObjectGetter.getDBusOwnerName. Returns name of the current owning dbus session.
public <T extends DBusInterface> T	getExportedObject(String source _source, String path _path, Class<T> class of remote object _type) Implements abstract org.freedesktop.dbus.connections.base.AbstractConnectionBase.getExportedObject. Retrieves an remote object using source and path.
public DBusInterface	getExportedObject(String source _source, String path _path) Implements abstract org.freedesktop.dbus.connections.base.AbstractConnectionBase.getExportedObject. Retrieves an remote object using source and path.
public String	getMachineId() Implements abstract org.freedesktop.dbus.connections.base.AbstractConnectionBase.getMachineId. The generated UUID of this machine.
public String[]	Returns: connection names getNames() Returns all the names owned by this connection.
public DBusInterface	getPeerRemoteObject(String The bus name to connect to. Usually a well known bus name in dot-notation (such as "org.freedesktop.local") or may be a DBus address such as ":1-16". _busname, String The path on which the process is exporting the object.$ _objectpath) Implements org.freedesktop.dbus.connections.impl.IRemoteObjectGetter.getPeerRemoteObject. Return a reference to a remote object.
public DBusInterface	getRemoteObject(String The bus name to connect to. Usually a well known bus name name in dot-notation (such as "org.freedesktop.local") or may be a DBus address such as ":1-16". _busname, String The path on which the process is exporting the object. _objectpath) Implements org.freedesktop.dbus.connections.impl.IRemoteObjectGetter.getRemoteObject. Return a reference to a remote object.
public <I extends DBusInterface> I	getRemoteObject(String The bus name to connect to. Usually a well known bus name name in dot-notation (such as "org.freedesktop.local") or may be a DBus address such as ":1-16". _busname, String The path on which the process is exporting the object. _objectpath, Class<I> The interface they are exporting it on. This type must have the same full class name and exposed method signatures as the interface the remote object is exporting. _type, boolean Disable/Enable auto-starting of services in response to calls on this object. Default is enabled; when calling a method with auto-start enabled, if the destination is a well-known name and is not owned the bus will attempt to start a process to take the name. When disabled an error is returned immediately. _autostart) Implements org.freedesktop.dbus.connections.impl.IRemoteObjectGetter.getRemoteObject. Return a reference to a remote object.
public String	Returns: unique name getUniqueName() Returns the unique name of this connection.
public void	register() Register this connection on the bus using 'Hello' message.
public void	releaseBusName(String The name to release. MUST be in dot-notation like "org.freedesktop.local" _busname) Release a bus name.
public void	removeGenericSigHandler(DBusMatchRule rule to remove _rule, DBusSigHandler<DBusSignal> handler to remove _handler) Implements abstract org.freedesktop.dbus.connections.AbstractConnection.removeGenericSigHandler. Remove a generic signal handler with the given `DBusMatchRule`.
public < class extending `DBusSignal` T extends DBusSignal> void	removeSigHandler(Class<T> The signal to watch for. _type, String The source of the signal. _source, DBusSigHandler<T> the handler _handler) Remove a Signal Handler.
public < class extending `DBusSignal` T extends DBusSignal> void	removeSigHandler(Class<T> The signal to watch for. _type, String The source of the signal. _source, DBusInterface The object emitting the signal. _object, DBusSigHandler<T> the handler _handler) Remove a Signal Handler.
protected <T extends DBusSignal> void	removeSigHandler(DBusMatchRule rule to remove _rule, DBusSigHandler<T> handler to remove _handler) Implements abstract org.freedesktop.dbus.connections.AbstractConnection.removeSigHandler. Remove a match rule with the given `DBusSigHandler`.
public void	requestBusName(String The name to respond to. MUST be in dot-notation like "org.freedesktop.local" _busname) Request a bus name.
private < type of class T extends DBusSignal> void	validateSignal(Class<T> class _type, String _source) Checks if given type is a DBusSignal and matches the required rules.

Inherited from org.freedesktop.dbus.connections.AbstractConnection:: addFallback addSigHandler addSigHandler addSigHandlerWithoutMatch callMethodAsync callWithCallback createReaderThread exportObject exportObject findMatchingTypes isFileDescriptorSupported queueCallback removeFallback removeSigHandler removeSigHandler setWeakReferences

busnames	back to summary
private final List<String> busnames

concurrentConnections	back to summary
pack-priv final AtomicInteger concurrentConnections Count how many 'connections' we manage internally. This is required because a `DBusConnection` to the same address will always return the same object and the 'real' disconnection should only occur when there is no second/third/whatever connection is left.

CONNECTIONS	back to summary
pack-priv static final ConcurrentMap<String, DBusConnection> CONNECTIONS

dbus	back to summary
private DBus dbus

logger	back to summary
private final Logger logger Hides org.freedesktop.dbus.connections.base.AbstractConnectionBase.logger.

machineId	back to summary
private final String machineId

registered	back to summary
private boolean registered Whether the connection was registered using 'Hello' message.

shared	back to summary
private final boolean shared Whether this connection is used in shared mode.

DBusConnection	back to summary
pack-priv DBusConnection(boolean _shared, String _machineId, ConnectionConfig _conCfg, TransportConfig _tranportCfg, ReceivingServiceConfig _rsCfg) throws DBusException

Method Detail

addGenericSigHandler back to summary

addGenericSigHandler	back to summary
public AutoCloseable addGenericSigHandler(DBusMatchRule _rule, DBusSigHandler<DBusSignal> _handler) throws DBusException Implements abstract org.freedesktop.dbus.connections.AbstractConnection.addGenericSigHandler. Doc from org.freedesktop.dbus.connections.AbstractConnection.addGenericSigHandler. Adds a `DBusMatchRule` to with a generic signal handler. Generic signal handlers allow receiving different signals with the same handler. If the rule was already added, the signal handler is added to the internal map receiving the same signal as the first (and additional) handlers for this rule. Parameters _rule:DBusMatchRule rule to add _handler:DBusSigHandler<DBusSignal> handler to use Returns:AutoCloseable closeable that removes signal handler Annotations @Override Exceptions DBusException: on error

public AutoCloseable addGenericSigHandler(DBusMatchRule _rule, DBusSigHandler<DBusSignal> _handler) throws DBusException

Implements abstract org.freedesktop.dbus.connections.AbstractConnection.addGenericSigHandler.

Doc from org.freedesktop.dbus.connections.AbstractConnection.addGenericSigHandler.

Adds a DBusMatchRule to with a generic signal handler. Generic signal handlers allow receiving different signals with the same handler. If the rule was already added, the signal handler is added to the internal map receiving the same signal as the first (and additional) handlers for this rule.

Parameters

_rule:DBusMatchRule: rule to add
_handler:DBusSigHandler<DBusSignal>: handler to use

Returns:AutoCloseable

closeable that removes signal handler

Annotations

@Override

Exceptions

DBusException:: on error

addSigHandler back to summary

addSigHandler	back to summary
public <T extends DBusSignal> AutoCloseable addSigHandler(Class<T> _type, String _source, DBusSigHandler<T> _handler) throws DBusException Add a Signal Handler. Adds a signal handler to call when a signal is received which matches the specified type, name and source. Parameters <T> class extending `DBusSignal` _type:Class<T> The signal to watch for. _source:String The process which will send the signal. This MUST be a unique bus name and not a well known name. _handler:DBusSigHandler<T> The handler to call when a signal is received. Returns:AutoCloseable closeable that removes signal handler Exceptions DBusException: If listening for the signal on the bus failed. ClassCastException: If type is not a sub-type of DBusSignal.

public <T extends DBusSignal> AutoCloseable addSigHandler(Class<T> _type, String _source, DBusSigHandler<T> _handler) throws DBusException

Add a Signal Handler. Adds a signal handler to call when a signal is received which matches the specified type, name and source.

Parameters

<T>: class extending DBusSignal
_type:Class<T>: The signal to watch for.
_source:String: The process which will send the signal. This MUST be a unique bus name and not a well known name.
_handler:DBusSigHandler<T>: The handler to call when a signal is received.

Returns:AutoCloseable

closeable that removes signal handler

Exceptions

DBusException:: If listening for the signal on the bus failed.
ClassCastException:: If type is not a sub-type of DBusSignal.

addSigHandler back to summary

addSigHandler	back to summary
public <T extends DBusSignal> AutoCloseable addSigHandler(Class<T> _type, String _source, DBusInterface _object, DBusSigHandler<T> _handler) throws DBusException Add a Signal Handler. Adds a signal handler to call when a signal is received which matches the specified type, name, source and object. Parameters <T> class extending `DBusSignal` _type:Class<T> The signal to watch for. _source:String The process which will send the signal. This MUST be a unique bus name and not a well known name. _object:DBusInterface The object from which the signal will be emitted _handler:DBusSigHandler<T> The handler to call when a signal is received. Returns:AutoCloseable closeable that removes signal handler Exceptions DBusException: If listening for the signal on the bus failed. ClassCastException: If type is not a sub-type of DBusSignal.

public <T extends DBusSignal> AutoCloseable addSigHandler(Class<T> _type, String _source, DBusInterface _object, DBusSigHandler<T> _handler) throws DBusException

Add a Signal Handler. Adds a signal handler to call when a signal is received which matches the specified type, name, source and object.

Parameters

<T>: class extending DBusSignal
_type:Class<T>: The signal to watch for.
_source:String: The process which will send the signal. This MUST be a unique bus name and not a well known name.
_object:DBusInterface: The object from which the signal will be emitted
_handler:DBusSigHandler<T>: The handler to call when a signal is received.

Returns:AutoCloseable

closeable that removes signal handler

Exceptions

DBusException:: If listening for the signal on the bus failed.
ClassCastException:: If type is not a sub-type of DBusSignal.

addSigHandler back to summary

addSigHandler	back to summary
public <T extends DBusSignal> AutoCloseable addSigHandler(DBusMatchRule _rule, DBusSigHandler<T> _handler) throws DBusException Implements abstract org.freedesktop.dbus.connections.AbstractConnection.addSigHandler. Doc from org.freedesktop.dbus.connections.AbstractConnection.addSigHandler. Add a signal handler with the given `DBusMatchRule` to DBus. The rule will be added to DBus if it was not added before. If the rule was already added, the signal handler is added to the internal map receiving the same signal as the first (and additional) handlers for this rule. Parameters <T> signal type _rule:DBusMatchRule rule to add _handler:DBusSigHandler<T> handler to use Returns:AutoCloseable closeable that removes signal handler Annotations @Override Exceptions DBusException: on error

public <T extends DBusSignal> AutoCloseable addSigHandler(DBusMatchRule _rule, DBusSigHandler<T> _handler) throws DBusException

Implements abstract org.freedesktop.dbus.connections.AbstractConnection.addSigHandler.

Doc from org.freedesktop.dbus.connections.AbstractConnection.addSigHandler.

Add a signal handler with the given DBusMatchRule to DBus. The rule will be added to DBus if it was not added before. If the rule was already added, the signal handler is added to the internal map receiving the same signal as the first (and additional) handlers for this rule.

Parameters

<T>: signal type
_rule:DBusMatchRule: rule to add
_handler:DBusSigHandler<T>: handler to use

Returns:AutoCloseable

closeable that removes signal handler

Annotations

@Override

Exceptions

DBusException:: on error

close	back to summary
public void close() throws IOException Overrides org.freedesktop.dbus.connections.base.AbstractConnectionBase.close. Implements java.io.Closeable.close. Same as disconnect. Annotations @Override Exceptions IOException: Doc from java.io.Closeable.close. if an I/O error occurs

back to summary

public void close() throws IOException

Overrides org.freedesktop.dbus.connections.base.AbstractConnectionBase.close.

Implements java.io.Closeable.close.

Same as disconnect.

Annotations

@Override

Exceptions

IOException:

Doc from java.io.Closeable.close.

if an I/O error occurs

connectImpl	back to summary
pack-priv void connectImpl() throws DBusException Connect to bus and register if asked. Should only be called by Builder. Exceptions DBusException: if registering or connection fails

connectImpl

back to summary

pack-priv void connectImpl() throws DBusException

Connect to bus and register if asked. Should only be called by Builder.

Exceptions

DBusException:: if registering or connection fails

disconnect	back to summary
public synchronized void disconnect() Overrides org.freedesktop.dbus.connections.base.AbstractConnectionBase.disconnect. Disconnect from the Bus. If this is a shared connection, it only disconnects when the last reference to the bus has called disconnect. If this is not a shared connection, disconnect will close the connection instantly. Annotations @Override

disconnect

back to summary

public synchronized void disconnect()

Overrides org.freedesktop.dbus.connections.base.AbstractConnectionBase.disconnect.

Disconnect from the Bus. If this is a shared connection, it only disconnects when the last reference to the bus has called disconnect. If this is not a shared connection, disconnect will close the connection instantly.

Annotations

@Override

doWithBusNames back to summary

doWithBusNames	back to summary
private void doWithBusNames(Consumer<List<String>> _action) Do some action with the currently registered names in a synchronized manor. Parameters _action:Consumer<List<String>> action to execute Exceptions `X`: thrown when action throws

private void doWithBusNames(Consumer<List<String>> _action)

Do some action with the currently registered names in a synchronized manor.

Parameters

_action:Consumer<List<String>>: action to execute

Exceptions

X:: thrown when action throws

doWithBusNamesAndReturn back to summary

doWithBusNamesAndReturn	back to summary
private <T> T doWithBusNamesAndReturn(Function<List<String>, T> _action) Do some action with the currently registered names in a synchronized manor. Parameters _action:Function<List<String>, T> action to execute Returns:T whatever the action returns Exceptions `X`: thrown when action throws

private <T> T doWithBusNamesAndReturn(Function<List<String>, T> _action)

Do some action with the currently registered names in a synchronized manor.

Parameters

_action:Function<List<String>, T>: action to execute

Returns:T

whatever the action returns

Exceptions

X:: thrown when action throws

dynamicProxy	back to summary
public <T extends DBusInterface> T dynamicProxy(String _source, String _path, Class<T> _type) throws DBusException Tries to resolve a proxy to a remote object. If a type class is given, it tries to convert the object using that class. If null is given as type, it tries to find a proper interface for this object. API Note This method is only intended for internal use. Visibility may change in future release Parameters <T> object type (DBusInterface compatible) _source:String source _path:String path _type:Class<T> class of object type Returns:T DBusInterface compatible object Annotations @SuppressWarnings:unchecked Exceptions DBusException: when something goes wrong

dynamicProxy

back to summary

public <T extends DBusInterface> T dynamicProxy(String _source, String _path, Class<T> _type) throws DBusException

Tries to resolve a proxy to a remote object. If a type class is given, it tries to convert the object using that class. If null is given as type, it tries to find a proper interface for this object.

API Note

This method is only intended for internal use. Visibility may change in future release

Parameters

<T>: object type (DBusInterface compatible)
_source:String: source
_path:String: path
_type:Class<T>: class of object type

Returns:T

DBusInterface compatible object

Annotations

@SuppressWarnings:unchecked

Exceptions

DBusException:: when something goes wrong

getConcurrentConnections	back to summary
private AtomicInteger getConcurrentConnections()

getDBusOwnerName	back to summary
public String getDBusOwnerName(String _busName) Implements org.freedesktop.dbus.connections.impl.IRemoteObjectGetter.getDBusOwnerName. Doc from org.freedesktop.dbus.connections.impl.IRemoteObjectGetter.getDBusOwnerName. Returns name of the current owning dbus session. Parameters _busName:String bus name Returns:String String or null Annotations @Override

getDBusOwnerName

back to summary

public String getDBusOwnerName(String _busName)

Implements org.freedesktop.dbus.connections.impl.IRemoteObjectGetter.getDBusOwnerName.

Doc from org.freedesktop.dbus.connections.impl.IRemoteObjectGetter.getDBusOwnerName.

Returns name of the current owning dbus session.

Parameters

_busName:String: bus name

Returns:String

String or null

Annotations

@Override

getExportedObject back to summary

getExportedObject	back to summary
public <T extends DBusInterface> T getExportedObject(String _source, String _path, Class<T> _type) throws DBusException Implements abstract org.freedesktop.dbus.connections.base.AbstractConnectionBase.getExportedObject. Doc from org.freedesktop.dbus.connections.base.AbstractConnectionBase.getExportedObject. Retrieves an remote object using source and path. Will use the given type as object class. Parameters _source:String source _path:String path _type:Class<T> class of remote object Returns:T `DBusInterface` compatible object Annotations @SuppressWarnings:unchecked @Override

public <T extends DBusInterface> T getExportedObject(String _source, String _path, Class<T> _type) throws DBusException

Implements abstract org.freedesktop.dbus.connections.base.AbstractConnectionBase.getExportedObject.

Doc from org.freedesktop.dbus.connections.base.AbstractConnectionBase.getExportedObject.

Retrieves an remote object using source and path. Will use the given type as object class.

Parameters

_source:String: source
_path:String: path
_type:Class<T>: class of remote object

Returns:T

DBusInterface compatible object

Annotations

@SuppressWarnings:unchecked
@Override

getExportedObject back to summary

getExportedObject	back to summary
public DBusInterface getExportedObject(String _source, String _path) throws DBusException Implements abstract org.freedesktop.dbus.connections.base.AbstractConnectionBase.getExportedObject. Doc from org.freedesktop.dbus.connections.base.AbstractConnectionBase.getExportedObject. Retrieves an remote object using source and path. Will try to find suitable exported DBusInterface automatically. Parameters _source:String source _path:String path Returns:DBusInterface `DBusInterface` compatible object Annotations @Override

public DBusInterface getExportedObject(String _source, String _path) throws DBusException

Implements abstract org.freedesktop.dbus.connections.base.AbstractConnectionBase.getExportedObject.

Doc from org.freedesktop.dbus.connections.base.AbstractConnectionBase.getExportedObject.

Retrieves an remote object using source and path. Will try to find suitable exported DBusInterface automatically.

Parameters

_source:String: source
_path:String: path

Returns:DBusInterface

DBusInterface compatible object

Annotations

@Override

getMachineId	back to summary
public String getMachineId() Implements abstract org.freedesktop.dbus.connections.base.AbstractConnectionBase.getMachineId. Doc from org.freedesktop.dbus.connections.base.AbstractConnectionBase.getMachineId. The generated UUID of this machine. Returns:String String Annotations @Override

getMachineId

back to summary

public String getMachineId()

Implements abstract org.freedesktop.dbus.connections.base.AbstractConnectionBase.getMachineId.

Doc from org.freedesktop.dbus.connections.base.AbstractConnectionBase.getMachineId.

The generated UUID of this machine.

Returns:String

String

Annotations

@Override

getNames	back to summary
public String[] getNames() Returns all the names owned by this connection. Returns:String[] connection names

getNames

back to summary

public String[] getNames()

Returns all the names owned by this connection.

Returns:String[]: connection names

getPeerRemoteObject	back to summary
public DBusInterface getPeerRemoteObject(String _busname, String _objectpath) throws InvalidBusNameException, DBusException Implements org.freedesktop.dbus.connections.impl.IRemoteObjectGetter.getPeerRemoteObject. Doc from org.freedesktop.dbus.connections.impl.IRemoteObjectGetter.getPeerRemoteObject. Return a reference to a remote object. This method will resolve the well known name (if given) to a unique bus name when you call it. This means that if a well known name is released by one process and acquired by another calls to objects gained from this method will continue to operate on the original process. This method will use bus introspection to determine the interfaces on a remote object and so may block and may fail. The resulting proxy object will, however, be castable to any interface it implements. It will also autostart the process if applicable. Also note that the resulting proxy may fail to execute the correct method with overloaded methods and that complex types may fail in interesting ways. Basically, if something odd happens, try specifying the interface explicitly. Parameters _busname:String The bus name to connect to. Usually a well known bus name in dot-notation (such as "org.freedesktop.local") or may be a DBus address such as ":1-16". _objectpath:String The path on which the process is exporting the object.$ Returns:DBusInterface A reference to a remote object. Annotations @Override Exceptions DBusException: on any other errors

getPeerRemoteObject

back to summary

public DBusInterface getPeerRemoteObject(String _busname, String _objectpath) throws InvalidBusNameException, DBusException

Implements org.freedesktop.dbus.connections.impl.IRemoteObjectGetter.getPeerRemoteObject.

Doc from org.freedesktop.dbus.connections.impl.IRemoteObjectGetter.getPeerRemoteObject.

Return a reference to a remote object. This method will resolve the well known name (if given) to a unique bus name when you call it. This means that if a well known name is released by one process and acquired by another calls to objects gained from this method will continue to operate on the original process. This method will use bus introspection to determine the interfaces on a remote object and so may block and may fail. The resulting proxy object will, however, be castable to any interface it implements. It will also autostart the process if applicable. Also note that the resulting proxy may fail to execute the correct method with overloaded methods and that complex types may fail in interesting ways. Basically, if something odd happens, try specifying the interface explicitly.

Parameters

_busname:String: The bus name to connect to. Usually a well known bus name in dot-notation (such as "org.freedesktop.local") or may be a DBus address such as ":1-16".
_objectpath:String: The path on which the process is exporting the object.$

Returns:DBusInterface

A reference to a remote object.

Annotations

@Override

Exceptions

DBusException:: on any other errors

getRemoteObject	back to summary
public DBusInterface getRemoteObject(String _busname, String _objectpath) throws DBusException, InvalidBusNameException, InvalidObjectPathException Implements org.freedesktop.dbus.connections.impl.IRemoteObjectGetter.getRemoteObject. Doc from org.freedesktop.dbus.connections.impl.IRemoteObjectGetter.getRemoteObject. Return a reference to a remote object. This method will always refer to the well known name (if given) rather than resolving it to a unique bus name. In particular this means that if a process providing the well known name disappears and is taken over by another process proxy objects gained by this method will make calls on the new proccess. This method will use bus introspection to determine the interfaces on a remote object and so may block and may fail. The resulting proxy object will, however, be castable to any interface it implements. It will also autostart the process if applicable. Also note that the resulting proxy may fail to execute the correct method with overloaded methods and that complex types may fail in interesting ways. Basically, if something odd happens, try specifying the interface explicitly. Parameters _busname:String The bus name to connect to. Usually a well known bus name name in dot-notation (such as "org.freedesktop.local") or may be a DBus address such as ":1-16". _objectpath:String The path on which the process is exporting the object. Returns:DBusInterface A reference to a remote object. Annotations @Override Exceptions DBusException: If remote object cannot be retrieved InvalidBusNameException: If busname is incorrectly formatted InvalidObjectPathException: If objectpath is incorrectly formatted

getRemoteObject

back to summary

public DBusInterface getRemoteObject(String _busname, String _objectpath) throws DBusException, InvalidBusNameException, InvalidObjectPathException

Implements org.freedesktop.dbus.connections.impl.IRemoteObjectGetter.getRemoteObject.

Doc from org.freedesktop.dbus.connections.impl.IRemoteObjectGetter.getRemoteObject.

Return a reference to a remote object. This method will always refer to the well known name (if given) rather than resolving it to a unique bus name. In particular this means that if a process providing the well known name disappears and is taken over by another process proxy objects gained by this method will make calls on the new proccess. This method will use bus introspection to determine the interfaces on a remote object and so may block and may fail. The resulting proxy object will, however, be castable to any interface it implements. It will also autostart the process if applicable. Also note that the resulting proxy may fail to execute the correct method with overloaded methods and that complex types may fail in interesting ways. Basically, if something odd happens, try specifying the interface explicitly.

Parameters

_busname:String: The bus name to connect to. Usually a well known bus name name in dot-notation (such as "org.freedesktop.local") or may be a DBus address such as ":1-16".
_objectpath:String: The path on which the process is exporting the object.

Returns:DBusInterface

A reference to a remote object.

Annotations

@Override

Exceptions

DBusException:: If remote object cannot be retrieved
InvalidBusNameException:: If busname is incorrectly formatted
InvalidObjectPathException:: If objectpath is incorrectly formatted

getRemoteObject back to summary

getRemoteObject	back to summary
public <I extends DBusInterface> I getRemoteObject(String _busname, String _objectpath, Class<I> _type, boolean _autostart) throws DBusException Implements org.freedesktop.dbus.connections.impl.IRemoteObjectGetter.getRemoteObject. Doc from org.freedesktop.dbus.connections.impl.IRemoteObjectGetter.getRemoteObject. Return a reference to a remote object. This method will always refer to the well known name (if given) rather than resolving it to a unique bus name. In particular this means that if a process providing the well known name disappears and is taken over by another process proxy objects gained by this method will make calls on the new process. Parameters <I> class extending `DBusInterface` _busname:String The bus name to connect to. Usually a well known bus name name in dot-notation (such as "org.freedesktop.local") or may be a DBus address such as ":1-16". _objectpath:String The path on which the process is exporting the object. _type:Class<I> The interface they are exporting it on. This type must have the same full class name and exposed method signatures as the interface the remote object is exporting. _autostart:boolean Disable/Enable auto-starting of services in response to calls on this object. Default is enabled; when calling a method with auto-start enabled, if the destination is a well-known name and is not owned the bus will attempt to start a process to take the name. When disabled an error is returned immediately. Returns:I A reference to a remote object. Annotations @Override @SuppressWarnings:unchecked Exceptions DBusException: on any other errors

public <I extends DBusInterface> I getRemoteObject(String _busname, String _objectpath, Class<I> _type, boolean _autostart) throws DBusException

Implements org.freedesktop.dbus.connections.impl.IRemoteObjectGetter.getRemoteObject.

Doc from org.freedesktop.dbus.connections.impl.IRemoteObjectGetter.getRemoteObject.

Parameters

<I>: class extending DBusInterface
_busname:String: The bus name to connect to. Usually a well known bus name name in dot-notation (such as "org.freedesktop.local") or may be a DBus address such as ":1-16".
_objectpath:String: The path on which the process is exporting the object.
_type:Class<I>: The interface they are exporting it on. This type must have the same full class name and exposed method signatures as the interface the remote object is exporting.
_autostart:boolean: Disable/Enable auto-starting of services in response to calls on this object. Default is enabled; when calling a method with auto-start enabled, if the destination is a well-known name and is not owned the bus will attempt to start a process to take the name. When disabled an error is returned immediately.

Returns:I

A reference to a remote object.

Annotations

@Override
@SuppressWarnings:unchecked

Exceptions

DBusException:: on any other errors

getUniqueName	back to summary
public String getUniqueName() Returns the unique name of this connection. Returns:String unique name

getUniqueName

back to summary

public String getUniqueName()

Returns the unique name of this connection.

Returns:String: unique name

register	back to summary
public void register() throws DBusException Register this connection on the bus using 'Hello' message. Will do nothing if session was already registered. Exceptions DBusException: when sending message fails Since 5.0.0 - 2023-10-11

back to summary

public void register() throws DBusException

Exceptions

DBusException:: when sending message fails

Since

5.0.0 - 2023-10-11

releaseBusName	back to summary
public void releaseBusName(String _busname) throws DBusException Release a bus name. Releases the name so that other people can use it Parameters _busname:String The name to release. MUST be in dot-notation like "org.freedesktop.local" Exceptions DBusException: If the busname is incorrectly formatted.

releaseBusName

back to summary

public void releaseBusName(String _busname) throws DBusException

Release a bus name. Releases the name so that other people can use it

Parameters

_busname:String: The name to release. MUST be in dot-notation like "org.freedesktop.local"

Exceptions

DBusException:: If the busname is incorrectly formatted.

removeGenericSigHandler back to summary

removeGenericSigHandler	back to summary
public void removeGenericSigHandler(DBusMatchRule _rule, DBusSigHandler<DBusSignal> _handler) throws DBusException Implements abstract org.freedesktop.dbus.connections.AbstractConnection.removeGenericSigHandler. Doc from org.freedesktop.dbus.connections.AbstractConnection.removeGenericSigHandler. Remove a generic signal handler with the given `DBusMatchRule`. The rule will only be removed from DBus if no other additional handlers are registered to the same rule. Parameters _rule:DBusMatchRule rule to remove _handler:DBusSigHandler<DBusSignal> handler to remove Annotations @Override Exceptions DBusException: on error

public void removeGenericSigHandler(DBusMatchRule _rule, DBusSigHandler<DBusSignal> _handler) throws DBusException

Implements abstract org.freedesktop.dbus.connections.AbstractConnection.removeGenericSigHandler.

Doc from org.freedesktop.dbus.connections.AbstractConnection.removeGenericSigHandler.

Remove a generic signal handler with the given DBusMatchRule. The rule will only be removed from DBus if no other additional handlers are registered to the same rule.

Parameters

_rule:DBusMatchRule: rule to remove
_handler:DBusSigHandler<DBusSignal>: handler to remove

Annotations

@Override

Exceptions

DBusException:: on error

removeSigHandler back to summary

removeSigHandler	back to summary
public <T extends DBusSignal> void removeSigHandler(Class<T> _type, String _source, DBusSigHandler<T> _handler) throws DBusException Remove a Signal Handler. Stops listening for this signal. Parameters <T> class extending `DBusSignal` _type:Class<T> The signal to watch for. _source:String The source of the signal. _handler:DBusSigHandler<T> the handler Exceptions DBusException: If listening for the signal on the bus failed. ClassCastException: If type is not a sub-type of DBusSignal.

public <T extends DBusSignal> void removeSigHandler(Class<T> _type, String _source, DBusSigHandler<T> _handler) throws DBusException

Remove a Signal Handler. Stops listening for this signal.

Parameters

<T>: class extending DBusSignal
_type:Class<T>: The signal to watch for.
_source:String: The source of the signal.
_handler:DBusSigHandler<T>: the handler

Exceptions

DBusException:: If listening for the signal on the bus failed.
ClassCastException:: If type is not a sub-type of DBusSignal.

removeSigHandler back to summary

removeSigHandler	back to summary
public <T extends DBusSignal> void removeSigHandler(Class<T> _type, String _source, DBusInterface _object, DBusSigHandler<T> _handler) throws DBusException Remove a Signal Handler. Stops listening for this signal. Parameters <T> class extending `DBusSignal` _type:Class<T> The signal to watch for. _source:String The source of the signal. _object:DBusInterface The object emitting the signal. _handler:DBusSigHandler<T> the handler Exceptions DBusException: If listening for the signal on the bus failed. ClassCastException: If type is not a sub-type of DBusSignal.

public <T extends DBusSignal> void removeSigHandler(Class<T> _type, String _source, DBusInterface _object, DBusSigHandler<T> _handler) throws DBusException

Remove a Signal Handler. Stops listening for this signal.

Parameters

<T>: class extending DBusSignal
_type:Class<T>: The signal to watch for.
_source:String: The source of the signal.
_object:DBusInterface: The object emitting the signal.
_handler:DBusSigHandler<T>: the handler

Exceptions

DBusException:: If listening for the signal on the bus failed.
ClassCastException:: If type is not a sub-type of DBusSignal.

removeSigHandler back to summary

removeSigHandler	back to summary
protected <T extends DBusSignal> void removeSigHandler(DBusMatchRule _rule, DBusSigHandler<T> _handler) throws DBusException Implements abstract org.freedesktop.dbus.connections.AbstractConnection.removeSigHandler. Doc from org.freedesktop.dbus.connections.AbstractConnection.removeSigHandler. Remove a match rule with the given `DBusSigHandler`. The rule will only be removed from DBus if no other additional handlers are registered to the same rule. Parameters <T> signal type _rule:DBusMatchRule rule to remove _handler:DBusSigHandler<T> handler to remove Annotations @Override Exceptions DBusException: on error

protected <T extends DBusSignal> void removeSigHandler(DBusMatchRule _rule, DBusSigHandler<T> _handler) throws DBusException

Implements abstract org.freedesktop.dbus.connections.AbstractConnection.removeSigHandler.

Doc from org.freedesktop.dbus.connections.AbstractConnection.removeSigHandler.

Remove a match rule with the given DBusSigHandler. The rule will only be removed from DBus if no other additional handlers are registered to the same rule.

Parameters

<T>: signal type
_rule:DBusMatchRule: rule to remove
_handler:DBusSigHandler<T>: handler to remove

Annotations

@Override

Exceptions

DBusException:: on error

requestBusName	back to summary
public void requestBusName(String _busname) throws DBusException Request a bus name. Request the well known name that this should respond to on the Bus. Parameters _busname:String The name to respond to. MUST be in dot-notation like "org.freedesktop.local" Exceptions DBusException: If the register name failed, or our name already exists on the bus. or if busname is incorrectly formatted.

requestBusName

back to summary

public void requestBusName(String _busname) throws DBusException

Request a bus name. Request the well known name that this should respond to on the Bus.

Parameters

_busname:String: The name to respond to. MUST be in dot-notation like "org.freedesktop.local"

Exceptions

DBusException:: If the register name failed, or our name already exists on the bus. or if busname is incorrectly formatted.

validateSignal	back to summary
private <T extends DBusSignal> void validateSignal(Class<T> _type, String _source) throws DBusException Checks if given type is a DBusSignal and matches the required rules. Parameters <T> type of class _type:Class<T> class Exceptions DBusException: when validation fails

validateSignal

back to summary

private <T extends DBusSignal> void validateSignal(Class<T> _type, String _source) throws DBusException

Checks if given type is a DBusSignal and matches the required rules.

Parameters

<T>: type of class
_type:Class<T>: class

Exceptions

DBusException:: when validation fails

Modifier and Type	Field and Description
public static final DBusConnection.DBusBusType	SESSION Session Bus
public static final DBusConnection.DBusBusType	SYSTEM System Bus

Modifier and Type	Method and Description
public static DBusConnection.DBusBusType	valueOf(String name)
public static DBusConnection.DBusBusType[]	values()

public final Class DBusConnection

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum DBusConnection.DBusBusType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class DBusConnection.SigHandler

Constructor Summary

Method Summary

Constructor Detail

Method Detail