org.freedesktop.dbus.connections.impl

Class DirectConnection

java.lang.Object

org.freedesktop.dbus.connections.AbstractConnection

org.freedesktop.dbus.connections.impl.DirectConnection

All Implemented Interfaces:

Closeable, AutoCloseable

public class DirectConnection
extends AbstractConnection

Handles a peer to peer connection between two applications withou a bus daemon.

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

Field Summary

Fields inherited from class org.freedesktop.dbus.connections.AbstractConnection

BUSNAME_REGEX, CONNID_REGEX, DOLLAR_PATTERN, FLOAT_SUPPORT, MAX_ARRAY_LENGTH, MAX_NAME_LENGTH, OBJECT_REGEX, TCP_CONNECT_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
DirectConnection(String address) Create a direct connection to another application.
DirectConnection(String address, int timeout) Create a direct connection to another application.

Method Summary

Modifier and Type	Method and Description
protected void	addGenericSigHandler(DBusMatchRule rule, DBusSigHandler<DBusSignal> handler) Adds a DBusMatchRule to with a generic signal handler.
protected <T extends DBusSignal> void	addSigHandler(DBusMatchRule rule, DBusSigHandler<T> handler) Add a signal handler with the given DBusMatchRule to DBus.
static String	createDynamicSession() Creates a bus address for a randomly generated abstract unix socket.
static String	createDynamicTCPSession() Creates a bus address for a randomly generated tcp port.
DBusInterface	getExportedObject(String source, String path)
String	getMachineId() The generated UUID of this machine.
DBusInterface	getRemoteObject(String objectpath) Return a reference to a remote object.
<T extends DBusInterface> T	getRemoteObject(String objectpath, Class<T> type) Return a reference to a remote object.
void	listen() Use this method when running on server side.
protected void	removeGenericSigHandler(DBusMatchRule rule, DBusSigHandler<DBusSignal> handler) Remove a generic signal handler with the given DBusMatchRule.
protected <T extends DBusSignal> void	removeSigHandler(DBusMatchRule rule, DBusSigHandler<T> handler) Remove a match rule with the given DBusSigHandler.

Methods inherited from class org.freedesktop.dbus.connections.AbstractConnection

addFallback, addSigHandler, addSigHandler, addSigHandlerWithoutMatch, callMethodAsync, callWithCallback, changeThreadCount, close, disconnect, disconnect, exportObject, getAddress, getCallInfo, getEndianness, getError, getExportedObject, getExportedObjects, getGenericHandledSignals, getHandledSignals, getImportedObjects, getObjectTree, getPendingCalls, getPendingErrorQueue, getSystemEndianness, handleException, isConnected, queueCallback, removeFallback, removeSigHandler, removeSigHandler, sendMessage, setEndianness, setWeakReferences, unExportObject

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectConnection

public DirectConnection(String address)
                 throws DBusException

Create a direct connection to another application.

Parameters:

address - The address to connect to. This is a standard D-Bus address, except that the additional parameter 'listen=true' should be added in the application which is creating the socket.

Throws:

DBusException - on error

DirectConnection

public DirectConnection(String address,
                        int timeout)
                 throws DBusException

Create a direct connection to another application.

Parameters:

address - The address to connect to. This is a standard D-Bus address, except that the additional parameter 'listen=true' should be added in the application which is creating the socket.

timeout - the timeout set for the underlying socket. 0 will block forever on the underlying socket.

Throws:

DBusException - on error

Method Detail

listen

public void listen()

Use this method when running on server side. Call will block.

Overrides:

listen in class AbstractConnection

createDynamicTCPSession

public static String createDynamicTCPSession()

Creates a bus address for a randomly generated tcp port.

Returns:

a random bus address.

createDynamicSession

public static String createDynamicSession()

Creates a bus address for a randomly generated abstract unix socket.

Returns:

a random bus address.

getRemoteObject

public DBusInterface getRemoteObject(String objectpath)
                              throws DBusException

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:

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 <T extends DBusInterface> T getRemoteObject(String objectpath,
                                                   Class<T> type)
                                            throws DBusException

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.

Type Parameters:

T - class which extends DBusInterface

Parameters:

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.

removeSigHandler

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

Description copied from class: AbstractConnection

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.

Specified by:

removeSigHandler in class AbstractConnection

Parameters:

rule - rule to remove

handler - handler to remove

Throws:

DBusException - on error

addSigHandler

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

Description copied from class: AbstractConnection

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.

Specified by:

addSigHandler in class AbstractConnection

Parameters:

rule - rule to add

handler - handler to use

Throws:

DBusException - on error

removeGenericSigHandler

protected void removeGenericSigHandler(DBusMatchRule rule,
                                       DBusSigHandler<DBusSignal> handler)
                                throws DBusException

Description copied from class: AbstractConnection

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.

Specified by:

removeGenericSigHandler in class AbstractConnection

Parameters:

rule - rule to remove

handler - handler to remove

Throws:

DBusException - on error

addGenericSigHandler

protected void addGenericSigHandler(DBusMatchRule rule,
                                    DBusSigHandler<DBusSignal> handler)
                             throws DBusException

Description copied from class: AbstractConnection

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.

Specified by:

addGenericSigHandler in class AbstractConnection

Parameters:

rule - rule to add

handler - handler to use

Throws:

DBusException - on error

getExportedObject

public DBusInterface getExportedObject(String source,
                                       String path)
                                throws DBusException

Specified by:

getExportedObject in class AbstractConnection

Throws:

DBusException

getMachineId

public String getMachineId()

Description copied from class: AbstractConnection

The generated UUID of this machine.

Specified by:

getMachineId in class AbstractConnection

Returns:

String