DBusConnection.java

795 lines | 36.713 kB Blame History Raw Download
/*
   D-Bus Java Implementation
   Copyright (c) 2005-2006 Matthew Johnson

   This program is free software; you can redistribute it and/or modify it
   under the terms of either the GNU Lesser General Public License Version 2 or the
   Academic Free Licence Version 2.1.

   Full licence texts are included in the COPYING file with this program.
*/
package org.freedesktop.dbus;

import cx.ath.matthew.debug.Debug;
import org.freedesktop.DBus;
import org.freedesktop.dbus.exceptions.DBusException;
import org.freedesktop.dbus.exceptions.DBusExecutionException;
import org.freedesktop.dbus.exceptions.NotConnected;

import java.io.BufferedReader;
import java.io.File;
import java.io.FileReader;
import java.io.IOException;
import java.lang.reflect.Proxy;
import java.text.MessageFormat;
import java.text.ParseException;
import java.util.Collection;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.TreeSet;
import java.util.Vector;

import static org.freedesktop.dbus.Gettext.getString;

/**
 * Handles a connection to DBus.
 * <p>
 * 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.
 * </p>
 * <p>
 * Signal Handlers and method calls from remote objects are run in their own threads, you MUST handle the concurrency issues.
 * </p>
 */
public class DBusConnection extends AbstractConnection {
    /**
     * Add addresses of peers to a set which will watch for them to
     * disappear and automatically remove them from the set.
     */
    public class PeerSet implements Set<String>, DBusSigHandler<DBus.NameOwnerChanged> {
        private Set<String> addresses;

        public PeerSet() {
            addresses = new TreeSet<String>();
            try {
                addSigHandler(new DBusMatchRule(DBus.NameOwnerChanged.class, null, null), this);
            } catch (DBusException DBe) {
                if (EXCEPTION_DEBUG && Debug.debug) Debug.print(Debug.ERR, DBe);
            }
        }

        public void handle(DBus.NameOwnerChanged noc) {
            if (Debug.debug)
                Debug.print(Debug.DEBUG, "Received NameOwnerChanged(" + noc.name + "," + noc.old_owner + "," + noc.new_owner + ")");
            if ("".equals(noc.new_owner) && addresses.contains(noc.name))
                remove(noc.name);
        }

        public boolean add(String address) {
            if (Debug.debug)
                Debug.print(Debug.DEBUG, "Adding " + address);
            synchronized (addresses) {
                return addresses.add(address);
            }
        }

        public boolean addAll(Collection<? extends String> addresses) {
            synchronized (this.addresses) {
                return this.addresses.addAll(addresses);
            }
        }

        public void clear() {
            synchronized (addresses) {
                addresses.clear();
            }
        }

        public boolean contains(Object o) {
            return addresses.contains(o);
        }

        public boolean containsAll(Collection<?> os) {
            return addresses.containsAll(os);
        }

        public boolean equals(Object o) {
            if (o instanceof PeerSet)
                return ((PeerSet) o).addresses.equals(addresses);
            else return false;
        }

        public int hashCode() {
            return addresses.hashCode();
        }

        public boolean isEmpty() {
            return addresses.isEmpty();
        }

        public Iterator<String> iterator() {
            return addresses.iterator();
        }

        public boolean remove(Object o) {
            if (Debug.debug)
                Debug.print(Debug.DEBUG, "Removing " + o);
            synchronized (addresses) {
                return addresses.remove(o);
            }
        }

        public boolean removeAll(Collection<?> os) {
            synchronized (addresses) {
                return addresses.removeAll(os);
            }
        }

        public boolean retainAll(Collection<?> os) {
            synchronized (addresses) {
                return addresses.retainAll(os);
            }
        }

        public int size() {
            return addresses.size();
        }

        public Object[] toArray() {
            synchronized (addresses) {
                return addresses.toArray();
            }
        }

        public <T> T[] toArray(T[] a) {
            synchronized (addresses) {
                return addresses.toArray(a);
            }
        }
    }

    private class _sighandler implements DBusSigHandler<DBusSignal> {
        public void handle(DBusSignal s) {
            if (s instanceof org.freedesktop.DBus.Local.Disconnected) {
                if (Debug.debug) Debug.print(Debug.WARN, "Handling disconnected signal from bus");
                try {
                    Error err = new Error(
                            "org.freedesktop.DBus.Local", "org.freedesktop.DBus.Local.disconnected", 0, "s", new Object[]{getString("disconnected")});
                    if (null != pendingCalls) synchronized (pendingCalls) {
                        long[] set = pendingCalls.getKeys();
                        for (long l : set)
                            if (-1 != l) {
                                MethodCall m = pendingCalls.remove(l);
                                if (null != m)
                                    m.setReply(err);
                            }
                    }
                    synchronized (pendingErrors) {
                        pendingErrors.add(err);
                    }
                } catch (DBusException DBe) {
                }
            } else if (s instanceof org.freedesktop.DBus.NameAcquired) {
                busnames.add(((org.freedesktop.DBus.NameAcquired) s).name);
            }
        }
    }

    /**
     * System Bus
     */
    public static final int SYSTEM = 0;
    /**
     * Session Bus
     */
    public static final int SESSION = 1;

    public static final String DEFAULT_SYSTEM_BUS_ADDRESS = "unix:path=/var/run/dbus/system_bus_socket";

    private List<String> busnames;

    private static final Map<Object, DBusConnection> conn = new HashMap<Object, DBusConnection>();
    private int _refcount = 0;
    private Object _reflock = new Object();
    private DBus _dbus;

    /**
     * Connect to the BUS. If a connection already exists to the specified Bus, a reference to it is returned.
     *
     * @param address The address of the bus to connect to
     * @throws DBusException If there is a problem connecting to the Bus.
     */
    public static DBusConnection getConnection(String address) throws DBusException {
        synchronized (conn) {
            DBusConnection c = conn.get(address);
            if (null != c) {
                synchronized (c._reflock) {
                    c._refcount++;
                }
                return c;
            } else {
                c = new DBusConnection(address);
                conn.put(address, c);
                return c;
            }
        }
    }

    /**
     * Connect to the BUS. If a connection already exists to the specified Bus, a reference to it is returned.
     *
     * @param bustype The Bus to connect to.
     * @throws DBusException If there is a problem connecting to the Bus.
     * @see #SYSTEM
     * @see #SESSION
     */
    public static DBusConnection getConnection(int bustype) throws DBusException {
        synchronized (conn) {
            String s = null;
            switch (bustype) {
                case SYSTEM:
                    s = System.getenv("DBUS_SYSTEM_BUS_ADDRESS");
                    if (null == s) s = DEFAULT_SYSTEM_BUS_ADDRESS;
                    break;
                case SESSION:
                    s = System.getenv("DBUS_SESSION_BUS_ADDRESS");
                    if (null == s) {
                        // address gets stashed in $HOME/.dbus/session-bus/`dbus-uuidgen --get`-`sed 's/:\(.\)\..*/\1/' <<< $DISPLAY`
                        String display = System.getenv("DISPLAY");
                        if (null == display) throw new DBusException(getString("cannotResolveSessionBusAddress"));
                        File uuidfile = new File("/var/lib/dbus/machine-id");
                        if (!uuidfile.exists()) throw new DBusException(getString("cannotResolveSessionBusAddress"));
                        try {
                            BufferedReader r = new BufferedReader(new FileReader(uuidfile));
                            String uuid = r.readLine();
                            String homedir = System.getProperty("user.home");
                            File addressfile = new File(homedir + "/.dbus/session-bus",
                                    uuid + "-" + display.replaceAll(":([0-9]*)\\..*", "$1"));
                            if (!addressfile.exists())
                                throw new DBusException(getString("cannotResolveSessionBusAddress"));
                            r = new BufferedReader(new FileReader(addressfile));
                            String l;
                            while (null != (l = r.readLine())) {
                                if (Debug.debug) Debug.print(Debug.VERBOSE, "Reading D-Bus session data: " + l);
                                if (l.matches("DBUS_SESSION_BUS_ADDRESS.*")) {
                                    s = l.replaceAll("^[^=]*=", "");
                                    if (Debug.debug) Debug.print(Debug.VERBOSE, "Parsing " + l + " to " + s);
                                }
                            }
                            if (null == s || "".equals(s))
                                throw new DBusException(getString("cannotResolveSessionBusAddress"));
                            if (Debug.debug)
                                Debug.print(Debug.INFO, "Read bus address " + s + " from file " + addressfile.toString());
                        } catch (Exception e) {
                            if (EXCEPTION_DEBUG && Debug.debug) Debug.print(Debug.ERR, e);
                            throw new DBusException(getString("cannotResolveSessionBusAddress"));
                        }
                    }
                    break;
                default:
                    throw new DBusException(getString("invalidBusType") + bustype);
            }
            DBusConnection c = conn.get(s);
            if (Debug.debug) Debug.print(Debug.VERBOSE, "Getting bus connection for " + s + ": " + c);
            if (null != c) {
                synchronized (c._reflock) {
                    c._refcount++;
                }
                return c;
            } else {
                if (Debug.debug) Debug.print(Debug.DEBUG, "Creating new bus connection to: " + s);
                c = new DBusConnection(s);
                conn.put(s, c);
                return c;
            }
        }
    }

    @SuppressWarnings("unchecked")
    private DBusConnection(String address) throws DBusException {
        super(address);
        busnames = new Vector<String>();

        synchronized (_reflock) {
            _refcount = 1;
        }

        try {
            transport = new Transport(addr, AbstractConnection.TIMEOUT);
            connected = true;
        } catch (IOException IOe) {
            if (EXCEPTION_DEBUG && Debug.debug) Debug.print(Debug.ERR, IOe);
            disconnect();
            throw new DBusException(getString("connectionFailure") + IOe.getMessage());
        } catch (ParseException Pe) {
            if (EXCEPTION_DEBUG && Debug.debug) Debug.print(Debug.ERR, Pe);
            disconnect();
            throw new DBusException(getString("connectionFailure") + Pe.getMessage());
        }

        // start listening for calls
        listen();

        // register disconnect handlers
        DBusSigHandler h = new _sighandler();
        addSigHandlerWithoutMatch(org.freedesktop.DBus.Local.Disconnected.class, h);
        addSigHandlerWithoutMatch(org.freedesktop.DBus.NameAcquired.class, h);

        // register ourselves
        _dbus = getRemoteObject("org.freedesktop.DBus", "/org/freedesktop/DBus", DBus.class);
        try {
            busnames.add(_dbus.Hello());
        } catch (DBusExecutionException DBEe) {
            if (EXCEPTION_DEBUG && Debug.debug) Debug.print(Debug.ERR, DBEe);
            throw new DBusException(DBEe.getMessage());
        }
    }

    @SuppressWarnings("unchecked")
    DBusInterface dynamicProxy(String source, String path) throws DBusException {
        if (Debug.debug)
            Debug.print(Debug.INFO, "Introspecting " + path + " on " + source + " for dynamic proxy creation");
        try {
            DBus.Introspectable intro = getRemoteObject(source, path, DBus.Introspectable.class);
            String data = intro.Introspect();
            if (Debug.debug) Debug.print(Debug.VERBOSE, "Got introspection data: " + data);
            String[] tags = data.split("[<>]");
            Vector<String> ifaces = new Vector<String>();
            for (String tag : tags) {
                if (tag.startsWith("interface")) {
                    ifaces.add(tag.replaceAll("^interface *name *= *['\"]([^'\"]*)['\"].*$", "$1"));
                }
            }
            Vector<Class<? extends Object>> ifcs = new Vector<Class<? extends Object>>();
            for (String iface : ifaces) {
                if (Debug.debug) Debug.print(Debug.DEBUG, "Trying interface " + iface);
                int j = 0;
                while (j >= 0) {
                    try {
                        Class ifclass = Class.forName(iface);
                        if (!ifcs.contains(ifclass))
                            ifcs.add(ifclass);
                        break;
                    } catch (Exception e) {
                    }
                    j = iface.lastIndexOf(".");
                    char[] cs = iface.toCharArray();
                    if (j >= 0) {
                        cs[j] = '$';
                        iface = String.valueOf(cs);
                    }
                }
            }

            if (ifcs.size() == 0) throw new DBusException(getString("interfaceToCastNotFound"));

            RemoteObject ro = new RemoteObject(source, path, null, false);
            DBusInterface newi = (DBusInterface)
                    Proxy.newProxyInstance(ifcs.get(0).getClassLoader(),
                            ifcs.toArray(new Class[0]),
                            new RemoteInvocationHandler(this, ro));
            importedObjects.put(newi, ro);
            return newi;
        } catch (Exception e) {
            if (EXCEPTION_DEBUG && Debug.debug) Debug.print(Debug.ERR, e);
            throw new DBusException(MessageFormat.format(getString("createProxyExportFailure"), new Object[]{path, source, e.getMessage()}));
        }
    }

    DBusInterface getExportedObject(String source, String path) throws DBusException {
        ExportedObject o = null;
        synchronized (exportedObjects) {
            o = exportedObjects.get(path);
        }
        if (null != o && null == o.object.get()) {
            unExportObject(path);
            o = null;
        }
        if (null != o) return o.object.get();
        if (null == source) throw new DBusException(getString("objectNotExportedNoRemoteSpecified"));
        return dynamicProxy(source, path);
    }

    /**
     * Release a bus name.
     * Releases the name so that other people can use it
     *
     * @param busname The name to release. MUST be in dot-notation like "org.freedesktop.local"
     * @throws DBusException If the busname is incorrectly formatted.
     */
    public void releaseBusName(String busname) throws DBusException {
        if (!busname.matches(BUSNAME_REGEX) || busname.length() > MAX_NAME_LENGTH)
            throw new DBusException(getString("invalidBusName"));
        synchronized (this.busnames) {
            UInt32 rv;
            try {
                rv = _dbus.ReleaseName(busname);
            } catch (DBusExecutionException DBEe) {
                if (EXCEPTION_DEBUG && Debug.debug) Debug.print(Debug.ERR, DBEe);
                throw new DBusException(DBEe.getMessage());
            }
            this.busnames.remove(busname);
        }
    }

    /**
     * Request a bus name.
     * Request the well known name that this should respond to on the Bus.
     *
     * @param 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.
     */
    public void requestBusName(String busname) throws DBusException {
        if (!busname.matches(BUSNAME_REGEX) || busname.length() > MAX_NAME_LENGTH)
            throw new DBusException(getString("invalidBusName"));
        synchronized (this.busnames) {
            UInt32 rv;
            try {
                rv = _dbus.RequestName(busname,
                        new UInt32(DBus.DBUS_NAME_FLAG_REPLACE_EXISTING |
                                DBus.DBUS_NAME_FLAG_DO_NOT_QUEUE));
            } catch (DBusExecutionException DBEe) {
                if (EXCEPTION_DEBUG && Debug.debug) Debug.print(Debug.ERR, DBEe);
                throw new DBusException(DBEe.getMessage());
            }
            switch (rv.intValue()) {
                case DBus.DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER:
                    break;
                case DBus.DBUS_REQUEST_NAME_REPLY_IN_QUEUE:
                    throw new DBusException(getString("dbusRegistrationFailure"));
                case DBus.DBUS_REQUEST_NAME_REPLY_EXISTS:
                    throw new DBusException(getString("dbusRegistrationFailure"));
                case DBus.DBUS_REQUEST_NAME_REPLY_ALREADY_OWNER:
                    break;
                default:
                    break;
            }
            this.busnames.add(busname);
        }
    }

    /**
     * Returns the unique name of this connection.
     */
    public String getUniqueName() {
        return busnames.get(0);
    }

    /**
     * Returns all the names owned by this connection.
     */
    public String[] getNames() {
        Set<String> names = new TreeSet<String>();
        names.addAll(busnames);
        return names.toArray(new String[0]);
    }

    public <I extends DBusInterface> I getPeerRemoteObject(String busname, String objectpath, Class<I> type) throws DBusException {
        return getPeerRemoteObject(busname, objectpath, type, true);
    }

    /**
     * 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.
     * <p>
     * This method will use bus introspection to determine the interfaces on a remote object and so
     * <b>may block</b> and <b>may fail</b>. 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.
     *
     * @param 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".
     * @param objectpath The path on which the process is exporting the object.$
     * @return A reference to a remote object.
     * @throws ClassCastException If type is not a sub-type of DBusInterface
     * @throws DBusException      If busname or objectpath are incorrectly formatted.
     */
    public DBusInterface getPeerRemoteObject(String busname, String objectpath) throws DBusException {
        if (null == busname) throw new DBusException(getString("nullBusName"));

        if ((!busname.matches(BUSNAME_REGEX) && !busname.matches(CONNID_REGEX))
                || busname.length() > MAX_NAME_LENGTH)
            throw new DBusException(getString("invalidBusName") + busname);

        String unique = _dbus.GetNameOwner(busname);

        return dynamicProxy(unique, 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.
     * <p>
     * This method will use bus introspection to determine the interfaces on a remote object and so
     * <b>may block</b> and <b>may fail</b>. 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.
     *
     * @param 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".
     * @param objectpath The path on which the process is exporting the object.
     * @return A reference to a remote object.
     * @throws ClassCastException If type is not a sub-type of DBusInterface
     * @throws DBusException      If busname or objectpath are incorrectly formatted.
     */
    public DBusInterface getRemoteObject(String busname, String objectpath) throws DBusException {
        if (null == busname) throw new DBusException(getString("nullBusName"));
        if (null == objectpath) throw new DBusException(getString("nullObjectPath"));

        if ((!busname.matches(BUSNAME_REGEX) && !busname.matches(CONNID_REGEX))
                || busname.length() > MAX_NAME_LENGTH)
            throw new DBusException(getString("invalidBusName") + busname);

        if (!objectpath.matches(OBJECT_REGEX) || objectpath.length() > MAX_NAME_LENGTH)
            throw new DBusException(getString("invalidObjectPath") + objectpath);

        return dynamicProxy(busname, 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.
     *
     * @param 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".
     * @param objectpath The path on which the process is exporting the object.$
     * @param 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.
     * @param 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.
     * @return A reference to a remote object.
     * @throws ClassCastException If type is not a sub-type of DBusInterface
     * @throws DBusException      If busname or objectpath are incorrectly formatted or type is not in a package.
     */
    public <I extends DBusInterface> I getPeerRemoteObject(String busname, String objectpath, Class<I> type, boolean autostart) throws DBusException {
        if (null == busname) throw new DBusException(getString("nullBusName"));

        if ((!busname.matches(BUSNAME_REGEX) && !busname.matches(CONNID_REGEX))
                || busname.length() > MAX_NAME_LENGTH)
            throw new DBusException(getString("invalidBusName") + busname);

        String unique = _dbus.GetNameOwner(busname);

        return getRemoteObject(unique, objectpath, type, autostart);
    }

    /**
     * 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.
     *
     * @param 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".
     * @param objectpath The path on which the process is exporting the object.
     * @param 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.
     * @return A reference to a remote object.
     * @throws ClassCastException If type is not a sub-type of DBusInterface
     * @throws DBusException      If busname or objectpath are incorrectly formatted or type is not in a package.
     */
    public <I extends DBusInterface> I getRemoteObject(String busname, String objectpath, Class<I> type) throws DBusException {
        return getRemoteObject(busname, objectpath, type, true);
    }

    /**
     * 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.
     *
     * @param 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".
     * @param objectpath The path on which the process is exporting the object.
     * @param 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.
     * @param 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.
     * @return A reference to a remote object.
     * @throws ClassCastException If type is not a sub-type of DBusInterface
     * @throws DBusException      If busname or objectpath are incorrectly formatted or type is not in a package.
     */
    @SuppressWarnings("unchecked")
    public <I extends DBusInterface> I getRemoteObject(String busname, String objectpath, Class<I> type, boolean autostart) throws DBusException {
        if (null == busname) throw new DBusException(getString("nullBusName"));
        if (null == objectpath) throw new DBusException(getString("nullObjectPath"));
        if (null == type) throw new ClassCastException(getString("notDBusInterface"));

        if ((!busname.matches(BUSNAME_REGEX) && !busname.matches(CONNID_REGEX))
                || busname.length() > MAX_NAME_LENGTH)
            throw new DBusException(getString("invalidBusName") + busname);

        if (!objectpath.matches(OBJECT_REGEX) || objectpath.length() > MAX_NAME_LENGTH)
            throw new DBusException(getString("invalidObjectPath") + objectpath);

        if (!DBusInterface.class.isAssignableFrom(type)) throw new ClassCastException(getString("notDBusInterface"));

        // don't let people import things which don't have a
        // valid D-Bus interface name
        if (type.getName().equals(type.getSimpleName()))
            throw new DBusException(getString("interfaceNotAllowedOutsidePackage"));

        RemoteObject ro = new RemoteObject(busname, objectpath, type, autostart);
        I i = (I) Proxy.newProxyInstance(type.getClassLoader(),
                new Class[]{type}, new RemoteInvocationHandler(this, ro));
        importedObjects.put(i, ro);
        return i;
    }

    /**
     * Remove a Signal Handler.
     * Stops listening for this signal.
     *
     * @param type   The signal to watch for.
     * @param source The source of the signal.
     * @throws DBusException      If listening for the signal on the bus failed.
     * @throws 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 {
        if (!DBusSignal.class.isAssignableFrom(type)) throw new ClassCastException(getString("notDBusSignal"));
        if (source.matches(BUSNAME_REGEX)) throw new DBusException(getString("cannotWatchSignalsWellKnownBussName"));
        if (!source.matches(CONNID_REGEX) || source.length() > MAX_NAME_LENGTH)
            throw new DBusException(getString("invalidBusName") + source);
        removeSigHandler(new DBusMatchRule(type, source, null), handler);
    }

    /**
     * Remove a Signal Handler.
     * Stops listening for this signal.
     *
     * @param type   The signal to watch for.
     * @param source The source of the signal.
     * @param object The object emitting the signal.
     * @throws DBusException      If listening for the signal on the bus failed.
     * @throws 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 {
        if (!DBusSignal.class.isAssignableFrom(type)) throw new ClassCastException(getString("notDBusSignal"));
        if (source.matches(BUSNAME_REGEX)) throw new DBusException(getString("cannotWatchSignalsWellKnownBussName"));
        if (!source.matches(CONNID_REGEX) || source.length() > MAX_NAME_LENGTH)
            throw new DBusException(getString("invalidBusName") + source);
        String objectpath = importedObjects.get(object).objectpath;
        if (!objectpath.matches(OBJECT_REGEX) || objectpath.length() > MAX_NAME_LENGTH)
            throw new DBusException(getString("invalidObjectPath") + objectpath);
        removeSigHandler(new DBusMatchRule(type, source, objectpath), handler);
    }

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

        SignalTuple key = new SignalTuple(rule.getInterface(), rule.getMember(), rule.getObject(), rule.getSource());
        synchronized (handledSignals) {
            Vector<DBusSigHandler<? extends DBusSignal>> v = handledSignals.get(key);
            if (null != v) {
                v.remove(handler);
                if (0 == v.size()) {
                    handledSignals.remove(key);
                    try {
                        _dbus.RemoveMatch(rule.toString());
                    } catch (NotConnected NC) {
                        if (EXCEPTION_DEBUG && Debug.debug) Debug.print(Debug.ERR, NC);
                    } catch (DBusExecutionException DBEe) {
                        if (EXCEPTION_DEBUG && Debug.debug) Debug.print(Debug.ERR, DBEe);
                        throw new DBusException(DBEe.getMessage());
                    }
                }
            }
        }
    }

    /**
     * Add a Signal Handler.
     * Adds a signal handler to call when a signal is received which matches the specified type, name and source.
     *
     * @param type    The signal to watch for.
     * @param source  The process which will send the signal. This <b>MUST</b> be a unique bus name and not a well known name.
     * @param handler The handler to call when a signal is received.
     * @throws DBusException      If listening for the signal on the bus failed.
     * @throws ClassCastException If type is not a sub-type of DBusSignal.
     */
    @SuppressWarnings("unchecked")
    public <T extends DBusSignal> void addSigHandler(Class<T> type, String source, DBusSigHandler<T> handler) throws DBusException {
        if (!DBusSignal.class.isAssignableFrom(type)) throw new ClassCastException(getString("notDBusSignal"));
        if (source.matches(BUSNAME_REGEX)) throw new DBusException(getString("cannotWatchSignalsWellKnownBussName"));
        if (!source.matches(CONNID_REGEX) || source.length() > MAX_NAME_LENGTH)
            throw new DBusException(getString("invalidBusName") + source);
        addSigHandler(new DBusMatchRule(type, source, null), (DBusSigHandler<? extends DBusSignal>) 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.
     *
     * @param type    The signal to watch for.
     * @param source  The process which will send the signal. This <b>MUST</b> be a unique bus name and not a well known name.
     * @param object  The object from which the signal will be emitted
     * @param handler The handler to call when a signal is received.
     * @throws DBusException      If listening for the signal on the bus failed.
     * @throws ClassCastException If type is not a sub-type of DBusSignal.
     */
    @SuppressWarnings("unchecked")
    public <T extends DBusSignal> void addSigHandler(Class<T> type, String source, DBusInterface object, DBusSigHandler<T> handler) throws DBusException {
        if (!DBusSignal.class.isAssignableFrom(type)) throw new ClassCastException(getString("notDBusSignal"));
        if (source.matches(BUSNAME_REGEX)) throw new DBusException(getString("cannotWatchSignalsWellKnownBussName"));
        if (!source.matches(CONNID_REGEX) || source.length() > MAX_NAME_LENGTH)
            throw new DBusException(getString("invalidBusName") + source);
        String objectpath = importedObjects.get(object).objectpath;
        if (!objectpath.matches(OBJECT_REGEX) || objectpath.length() > MAX_NAME_LENGTH)
            throw new DBusException(getString("invalidObjectPath") + objectpath);
        addSigHandler(new DBusMatchRule(type, source, objectpath), (DBusSigHandler<? extends DBusSignal>) handler);
    }

    protected <T extends DBusSignal> void addSigHandler(DBusMatchRule rule, DBusSigHandler<T> handler) throws DBusException {
        try {
            _dbus.AddMatch(rule.toString());
        } catch (DBusExecutionException DBEe) {
            if (EXCEPTION_DEBUG && Debug.debug) Debug.print(Debug.ERR, DBEe);
            throw new DBusException(DBEe.getMessage());
        }
        SignalTuple key = new SignalTuple(rule.getInterface(), rule.getMember(), rule.getObject(), rule.getSource());
        synchronized (handledSignals) {
            Vector<DBusSigHandler<? extends DBusSignal>> v = handledSignals.get(key);
            if (null == v) {
                v = new Vector<DBusSigHandler<? extends DBusSignal>>();
                v.add(handler);
                handledSignals.put(key, v);
            } else
                v.add(handler);
        }
    }

    /**
     * Disconnect from the Bus.
     * This only disconnects when the last reference to the bus has disconnect called on it
     * or has been destroyed.
     */
    public void disconnect() {
        synchronized (conn) {
            synchronized (_reflock) {
                if (0 == --_refcount) {
                    if (Debug.debug) Debug.print(Debug.INFO, "Disconnecting DBusConnection");
                    // Set all pending messages to have an error.
                    try {
                        Error err = new Error(
                                "org.freedesktop.DBus.Local", "org.freedesktop.DBus.Local.disconnected", 0, "s", new Object[]{getString("disconnected")});
                        synchronized (pendingCalls) {
                            long[] set = pendingCalls.getKeys();
                            for (long l : set)
                                if (-1 != l) {
                                    MethodCall m = pendingCalls.remove(l);
                                    if (null != m)
                                        m.setReply(err);
                                }
                            pendingCalls = null;
                        }
                        synchronized (pendingErrors) {
                            pendingErrors.add(err);
                        }
                    } catch (DBusException DBe) {
                    }

                    conn.remove(addr);
                    super.disconnect();
                }
            }
        }
    }
}