RoutingTableImpl.java 9.25 KB
Newer Older
Matt Tucker's avatar
Matt Tucker committed
1 2 3 4 5
/**
 * $RCSfile$
 * $Revision$
 * $Date$
 *
Matt Tucker's avatar
Matt Tucker committed
6
 * Copyright (C) 2004 Jive Software. All rights reserved.
Matt Tucker's avatar
Matt Tucker committed
7
 *
Matt Tucker's avatar
Matt Tucker committed
8 9
 * This software is published under the terms of the GNU Public License (GPL),
 * a copy of which is included in this distribution.
Matt Tucker's avatar
Matt Tucker committed
10
 */
Matt Tucker's avatar
Matt Tucker committed
11

Matt Tucker's avatar
Matt Tucker committed
12 13 14
package org.jivesoftware.messenger.spi;

import org.jivesoftware.messenger.*;
15
import org.jivesoftware.messenger.container.BasicModule;
16
import org.jivesoftware.util.Log;
17
import org.xmpp.packet.JID;
Matt Tucker's avatar
Matt Tucker committed
18

19 20 21 22
import java.util.Collections;
import java.util.Hashtable;
import java.util.Iterator;
import java.util.LinkedList;
Matt Tucker's avatar
Matt Tucker committed
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
import java.util.concurrent.locks.ReadWriteLock;
import java.util.concurrent.locks.ReentrantReadWriteLock;

/**
 * <p>Uses simple hashtables for table storage.</p>
 * <p>Leaves in the tree are indicated by a PacketHandler, while branches are stored in hashtables.
 * Traverse the tree according to an XMPPAddress' fields (host -> name -> resource) and when you
 * hit a PacketHandler, you have found the handler for that node and all sub-nodes. </p>
 *
 * @author Iain Shigeoka
 */
public class RoutingTableImpl extends BasicModule implements RoutingTable {

    /**
     * We need a three level tree built of hashtables: host -> name -> resource
     */
    private Hashtable routes = new Hashtable();

    /**
     * locks access to the routing tale
     */
    private ReadWriteLock routeLock = new ReentrantReadWriteLock();

    public RoutingTableImpl() {
        super("Routing table");
    }

50
    public void addRoute(JID node, RoutableChannelHandler destination) {
Matt Tucker's avatar
Matt Tucker committed
51

52 53
        String nodeJID = node.getNode() == null ? "" : node.getNode();
        String resourceJID = node.getResource() == null ? "" : node.getResource();
Matt Tucker's avatar
Matt Tucker committed
54 55 56

        routeLock.writeLock().lock();
        try {
57
            if (destination instanceof ClientSession) {
58
                Object nameRoutes = routes.get(node.getDomain());
59
                if (nameRoutes == null) {
60 61
                    nameRoutes = new Hashtable();
                    routes.put(node.getDomain(), nameRoutes);
Matt Tucker's avatar
Matt Tucker committed
62
                }
63 64 65 66
                Object resourceRoutes = ((Hashtable)nameRoutes).get(nodeJID);
                if (resourceRoutes == null) {
                    resourceRoutes = new Hashtable();
                    ((Hashtable)nameRoutes).put(nodeJID, resourceRoutes);
Matt Tucker's avatar
Matt Tucker committed
67
                }
68 69 70 71
                ((Hashtable)resourceRoutes).put(resourceJID, destination);
            }
            else {
                routes.put(node.getDomain(), destination);
Matt Tucker's avatar
Matt Tucker committed
72 73 74 75 76 77 78
            }
        }
        finally {
            routeLock.writeLock().unlock();
        }
    }

79
    public RoutableChannelHandler getRoute(JID node) throws NoSuchRouteException {
Matt Tucker's avatar
Matt Tucker committed
80
        RoutableChannelHandler route = null;
81 82 83
        String nodeJID = node.getNode() == null ? "" : node.getNode();
        String resourceJID = node.getResource() == null ? "" : node.getResource();

Matt Tucker's avatar
Matt Tucker committed
84 85
        routeLock.readLock().lock();
        try {
86
            Object nameRoutes = routes.get(node.getDomain());
Matt Tucker's avatar
Matt Tucker committed
87 88 89 90
            if (nameRoutes instanceof ChannelHandler) {
                route = (RoutableChannelHandler)nameRoutes;
            }
            else {
91
                Object resourceRoutes = ((Hashtable)nameRoutes).get(nodeJID);
Matt Tucker's avatar
Matt Tucker committed
92 93 94 95
                if (resourceRoutes instanceof ChannelHandler) {
                    route = (RoutableChannelHandler)resourceRoutes;
                }
                else if (resourceRoutes != null) {
96
                    route = (RoutableChannelHandler) ((Hashtable)resourceRoutes).get(resourceJID);
Matt Tucker's avatar
Matt Tucker committed
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
                }
                else {
                    throw new NoSuchRouteException(node.toString());
                }
            }
        }
        catch (Exception e) {
            throw new NoSuchRouteException(node == null ? "No node" : node.toString(), e);
        }
        finally {
            routeLock.readLock().unlock();
        }

        if (route == null) {
            throw new NoSuchRouteException(node == null ? "No node" : node.toString());
        }
        return route;
    }

116
    public Iterator getRoutes(JID node) {
Matt Tucker's avatar
Matt Tucker committed
117 118 119
        LinkedList list = null;
        routeLock.readLock().lock();
        try {
120
            if (node == null || node.getDomain() == null) {
Matt Tucker's avatar
Matt Tucker committed
121 122 123 124
                list = new LinkedList();
                getRoutes(list, routes);
            }
            else {
125
                Object nameRoutes = routes.get(node.getDomain());
Matt Tucker's avatar
Matt Tucker committed
126 127 128 129 130
                if (nameRoutes != null) {
                    if (nameRoutes instanceof ChannelHandler) {
                        list = new LinkedList();
                        list.add(nameRoutes);
                    }
131
                    else if (node.getNode() == null) {
Matt Tucker's avatar
Matt Tucker committed
132 133 134 135 136
                        list = new LinkedList();
                        getRoutes(list, (Hashtable)nameRoutes);
                    }
                    else {
                        Object resourceRoutes =
137
                                ((Hashtable)nameRoutes).get(node.getNode());
Matt Tucker's avatar
Matt Tucker committed
138 139 140 141 142 143 144 145 146 147 148
                        if (resourceRoutes != null) {
                            if (resourceRoutes instanceof ChannelHandler) {
                                list = new LinkedList();
                                list.add(resourceRoutes);
                            }
                            else if (node.getResource() == null || node.getResource().length() == 0) {
                                list = new LinkedList();
                                getRoutes(list, (Hashtable)resourceRoutes);
                            }
                            else {
                                Object entry =
149
                                        ((Hashtable)resourceRoutes).get(node.getResource());
Matt Tucker's avatar
Matt Tucker committed
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
                                if (entry != null) {
                                    list = new LinkedList();
                                    list.add(entry);
                                }
                            }
                        }
                    }
                }
            }
        }
        finally {
            routeLock.readLock().unlock();
        }
        if (list == null) {
            return Collections.EMPTY_LIST.iterator();
        }
        else {
            return list.iterator();
        }
    }

    /**
     * <p>Recursive method to iterate through the given table (and any embedded tables)
     * and stuff non-Hashtable values into the given list.</p>
     * <p>There should be no recursion problems since
     * the routing table is at most 3 levels deep.</p>
     *
     * @param list  The list to stuff entries into
     * @param table The hashtable who's values should be entered into the list
     */
    private void getRoutes(LinkedList list, Hashtable table) {
        Iterator entryIter = table.values().iterator();
        while (entryIter.hasNext()) {
            Object entry = entryIter.next();
            if (entry instanceof Hashtable) {
                getRoutes(list, (Hashtable)entry);
            }
            else {
                // Do not include the same entry many times. This could be the case when the same 
                // session is associated with the bareJID and with a given resource
                if (!list.contains(entry)) {
                    list.add(entry);
                }
            }
        }
    }

197
    public ChannelHandler getBestRoute(JID node) throws NoSuchRouteException {
Matt Tucker's avatar
Matt Tucker committed
198 199 200 201 202 203

        ChannelHandler route = null;
        try {
            route = getRoute(node);
        }
        catch (NoSuchRouteException e) {
204
            JID defaultNode = new JID(node.getNode(), node.getDomain(), "");
Matt Tucker's avatar
Matt Tucker committed
205 206 207 208 209 210 211 212
            route = getRoute(defaultNode);
        }
        if (route == null) {
            throw new NoSuchRouteException();
        }
        return route;
    }

213
    public ChannelHandler removeRoute(JID node) {
Matt Tucker's avatar
Matt Tucker committed
214 215

        ChannelHandler route = null;
216 217
        String nodeJID = node.getNode() == null ? "" : node.getNode();
        String resourceJID = node.getResource() == null ? "" : node.getResource();
Matt Tucker's avatar
Matt Tucker committed
218 219 220

        routeLock.writeLock().lock();
        try {
221 222 223 224 225 226 227 228 229 230
            Object nameRoutes = routes.get(node.getDomain());
            if (nameRoutes instanceof Hashtable) {
                Object resourceRoutes = ((Hashtable)nameRoutes).get(nodeJID);
                if (resourceRoutes instanceof Hashtable) {
                    // Remove the requested resource for this user
                    route = (ChannelHandler) ((Hashtable)resourceRoutes).remove(resourceJID);
                    if (((Hashtable)resourceRoutes).isEmpty()) {
                        ((Hashtable)nameRoutes).remove(nodeJID);
                        if (((Hashtable)nameRoutes).isEmpty()) {
                            routes.remove(node.getDomain());
Matt Tucker's avatar
Matt Tucker committed
231 232 233 234

                        }
                    }
                }
235 236 237 238 239
                else {
                    // Remove the unique route to this node
                    ((Hashtable)nameRoutes).remove(nodeJID);
                }
            }
Gaston Dombiak's avatar
Gaston Dombiak committed
240
            else if (nameRoutes != null) {
241 242 243 244 245
                // The retrieved route points to a RoutableChannelHandler
                if (((RoutableChannelHandler)nameRoutes).getAddress().equals(node)) {
                    // Remove the route to this domain
                    routes.remove(node.getDomain());
                }
Matt Tucker's avatar
Matt Tucker committed
246 247 248
            }
        }
        catch (Exception e) {
249
            Log.error("Error removing route", e);
Matt Tucker's avatar
Matt Tucker committed
250 251 252 253 254 255 256
        }
        finally {
            routeLock.writeLock().unlock();
        }
        return route;
    }
}