org.freedesktop.dbus

Class DBusConnection

public class DBusConnection extends AbstractConnection

Handles a connection to DBus.

This is a Singleton class, only 1 connection to the SYSTEM or SESSION busses can be made. Repeated calls to getConnection will return the same reference.

Signal Handlers and method calls from remote objects are run in their own threads, you MUST handle the concurrency issues.

Field Summary
static StringDEFAULT_SYSTEM_BUS_ADDRESS
static intSESSION
Session Bus
static intSYSTEM
System Bus
Method Summary
<T extends DBusSignal> voidaddSigHandler(Class<T> type, String source, DBusSigHandler<T> handler)
Add a Signal Handler.
<T extends DBusSignal> voidaddSigHandler(Class<T> type, String source, DBusInterface object, DBusSigHandler<T> handler)
Add a Signal Handler.
protected <T extends DBusSignal> voidaddSigHandler(DBusMatchRule rule, DBusSigHandler<T> handler)
voiddisconnect()
Disconnect from the Bus.
static DBusConnectiongetConnection(String address)
Connect to the BUS.
static DBusConnectiongetConnection(int bustype)
Connect to the BUS.
String[]getNames()
Returns all the names owned by this connection.
<I extends DBusInterface> IgetPeerRemoteObject(String busname, String objectpath, Class<I> type)
DBusInterfacegetPeerRemoteObject(String busname, String objectpath)
Return a reference to a remote object.
<I extends DBusInterface> IgetPeerRemoteObject(String busname, String objectpath, Class<I> type, boolean autostart)
Return a reference to a remote object.
DBusInterfacegetRemoteObject(String busname, String objectpath)
Return a reference to a remote object.
<I extends DBusInterface> IgetRemoteObject(String busname, String objectpath, Class<I> type)
Return a reference to a remote object.
StringgetUniqueName()
Returns the unique name of this connection.
<T extends DBusSignal> voidremoveSigHandler(Class<T> type, String source, DBusSigHandler<T> handler)
Remove a Signal Handler.
<T extends DBusSignal> voidremoveSigHandler(Class<T> type, String source, DBusInterface object, DBusSigHandler<T> handler)
Remove a Signal Handler.
protected <T extends DBusSignal> voidremoveSigHandler(DBusMatchRule rule, DBusSigHandler<T> handler)
voidrequestBusName(String busname)
Request a bus name.

Field Detail

DEFAULT_SYSTEM_BUS_ADDRESS

public static final String DEFAULT_SYSTEM_BUS_ADDRESS

SESSION

public static final int SESSION
Session Bus

SYSTEM

public static final int SYSTEM
System Bus

Method Detail

addSigHandler

public <T extends DBusSignal> void addSigHandler(Class<T> type, String source, DBusSigHandler<T> handler)
Add a Signal Handler. Adds a signal handler to call when a signal is received which matches the specified type, name and source.

Parameters: type The signal to watch for. source The process which will send the signal. This MUST be a unique bus name and not a well known name. handler The handler to call when a signal is received.

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

addSigHandler

public <T extends DBusSignal> void addSigHandler(Class<T> type, String source, DBusInterface object, DBusSigHandler<T> handler)
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: type The signal to watch for. source The process which will send the signal. This MUST be a unique bus name and not a well known name. object The object from which the signal will be emitted handler The handler to call when a signal is received.

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

addSigHandler

protected <T extends DBusSignal> void addSigHandler(DBusMatchRule rule, DBusSigHandler<T> handler)

disconnect

public void disconnect()
Disconnect from the Bus. This only disconnects when the last reference to the bus has disconnect called on it or has been destroyed.

getConnection

public static DBusConnection getConnection(String address)
Connect to the BUS. If a connection already exists to the specified Bus, a reference to it is returned.

Parameters: address The address of the bus to connect to

Throws: DBusException If there is a problem connecting to the Bus.

getConnection

public static DBusConnection getConnection(int bustype)
Connect to the BUS. If a connection already exists to the specified Bus, a reference to it is returned.

Parameters: bustype The Bus to connect to.

Throws: DBusException If there is a problem connecting to the Bus.

See Also: SYSTEM SESSION

getNames

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

getPeerRemoteObject

public <I extends DBusInterface> I getPeerRemoteObject(String busname, String objectpath, Class<I> type)

getPeerRemoteObject

public DBusInterface getPeerRemoteObject(String busname, String objectpath)
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 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 The path on which the process is exporting the object.$

Returns: A reference to a remote object.

Throws: ClassCastException If type is not a sub-type of DBusInterface DBusException If busname or objectpath are incorrectly formatted.

getPeerRemoteObject

public <I extends DBusInterface> I getPeerRemoteObject(String busname, String objectpath, Class<I> type, boolean autostart)
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.

Parameters: busname 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 The path on which the process is exporting the object.$ type 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 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: A reference to a remote object.

Throws: ClassCastException If type is not a sub-type of DBusInterface DBusException If busname or objectpath are incorrectly formatted or type is not in a package.

getRemoteObject

public DBusInterface getRemoteObject(String busname, String objectpath)
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 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 The path on which the process is exporting the object.

Returns: A reference to a remote object.

Throws: ClassCastException If type is not a sub-type of DBusInterface DBusException If busname or objectpath are incorrectly formatted.

getRemoteObject

public <I extends DBusInterface> I getRemoteObject(String busname, String objectpath, Class<I> type)
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.

Parameters: busname 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 The path on which the process is exporting the object. type 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.

Returns: A reference to a remote object.

Throws: ClassCastException If type is not a sub-type of DBusInterface DBusException If busname or objectpath are incorrectly formatted or type is not in a package.

getUniqueName

public String getUniqueName()
Returns the unique name of this connection.

removeSigHandler

public <T extends DBusSignal> void removeSigHandler(Class<T> type, String source, DBusSigHandler<T> handler)
Remove a Signal Handler. Stops listening for this signal.

Parameters: type The signal to watch for. source The source of the signal.

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

removeSigHandler

public <T extends DBusSignal> void removeSigHandler(Class<T> type, String source, DBusInterface object, DBusSigHandler<T> handler)
Remove a Signal Handler. Stops listening for this signal.

Parameters: type The signal to watch for. source The source of the signal. object The object emitting the signal.

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

removeSigHandler

protected <T extends DBusSignal> void removeSigHandler(DBusMatchRule rule, DBusSigHandler<T> handler)

requestBusName

public void requestBusName(String busname)
Request a bus name. Request the well known name that this should respond to on the Bus.

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

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