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

package org.jivesoftware.database;

import org.jivesoftware.util.JiveConstants;
import org.jivesoftware.util.Log;

import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
21
import java.util.Map;
22
import java.util.concurrent.ConcurrentHashMap;
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

/**
 * Manages sequences of unique ID's that get stored in the database. Database support for sequences
 * varies widely; some don't use them at all. Instead, we handle unique ID generation with a
 * combination VM/database solution.<p>
 * <p/>
 * A special table in the database doles out blocks of unique ID's to each
 * virtual machine that interacts with Jive. This has the following consequences:
 * <ul>
 * <li>There is no need to go to the database every time we want a new unique id.
 * <li>Multiple app servers can interact with the same db without id collision.
 * <li>The order of unique id's may not correspond to the creation date of objects.
 * <li>There can be gaps in ID's after server restarts since blocks will get "lost" if the block
 * size is greater than 1.
 * </ul><p>
 * <p/>
 * Each sequence type that this class manages has a different block size value. Objects that aren't
 * created often have a block size of 1, while frequently created objects such as entries and
 * comments have larger block sizes.
 *
 * @author Matt Tucker
 * @author Bruce Ritchie
 */
public class SequenceManager {

48 49 50
    private static final String CREATE_ID =
            "INSERT INTO jiveID (id, idType) VALUES (1, ?)";

Matt Tucker's avatar
Matt Tucker committed
51 52
    private static final String LOAD_ID =
            "SELECT id FROM jiveID WHERE idType=?";
53

Matt Tucker's avatar
Matt Tucker committed
54 55 56 57
    private static final String UPDATE_ID =
            "UPDATE jiveID SET id=? WHERE idType=? AND id=?";

    // Statically startup a sequence manager for each of the sequence counters.
58
    private static Map<Integer, SequenceManager> managers = new ConcurrentHashMap<Integer, SequenceManager>();
Matt Tucker's avatar
Matt Tucker committed
59 60 61 62 63

    static {
        new SequenceManager(JiveConstants.ROSTER, 5);
        new SequenceManager(JiveConstants.OFFLINE, 1);
        new SequenceManager(JiveConstants.MUC_ROOM, 1);
64
    }
Matt Tucker's avatar
Matt Tucker committed
65 66 67 68 69 70 71 72 73

    /**
     * Returns the next ID of the specified type.
     *
     * @param type the type of unique ID.
     * @return the next unique ID of the specified type.
     */
    public static long nextID(int type) {
        if (managers.containsKey(type)) {
74
            return managers.get(type).nextUniqueID();
Matt Tucker's avatar
Matt Tucker committed
75 76
        }
        else {
77 78
            // Verify type is valid from the db, if so create an instance for the type
            // And return the next unique id
79 80
            SequenceManager manager = new SequenceManager(type, 1);
            return manager.nextUniqueID();
Matt Tucker's avatar
Matt Tucker committed
81 82 83
        }
    }

84
    /**
Andrew Wright's avatar
Andrew Wright committed
85 86
     * Returns the next id for an object that has defined the annotation {@link JiveID}.
     * The JiveID annotation value is the synonymous for the type integer.
87
     * <p/>
88 89
     * The annotation JiveID should contain the id type for the object (the same number you would
     * use to call nextID(int type))
90
     * <p/>
91
     * Example class definition:
92
     * <p/>
93 94 95
     * <code>
     * \@JiveID(10)
     * public class MyClass {
96
     * <p/>
97 98 99 100 101
     * }
     * </code>
     *
     * @param o object that has annotation JiveID
     * @return the next int
Andrew Wright's avatar
Andrew Wright committed
102
     * @throws IllegalArgumentException If the object passed in does not defined {@link JiveID}
103 104 105 106
     */
    public static long nextID(Object o) {
        JiveID id = o.getClass().getAnnotation(JiveID.class);

107 108
        if (id == null) {
            Log.error("Annotation JiveID must be defined in the class " + o.getClass());
Andrew Wright's avatar
Andrew Wright committed
109
            throw new IllegalArgumentException(
110
                    "Annotation JiveID must be defined in the class " + o.getClass());
111 112 113 114 115
        }

        return nextID(id.value());
    }

116 117 118 119
    /**
     * Used to set the blocksize of a given SequenceManager. If no SequenceManager has been registered
     * for the type we will verify the type is valid and then create a new sequence manager for it.
     *
120
     * @param type      the type of unique id
Andrew Wright's avatar
Andrew Wright committed
121
     * @param blockSize how many blocks of ids we should
122 123 124 125 126 127
     */
    public static void setBlockSize(int type, int blockSize) {
        if (managers.containsKey(type)) {
            managers.get(type).blockSize = blockSize;
        }
        else {
128
            new SequenceManager(type, blockSize);
129 130 131
        }
    }

Matt Tucker's avatar
Matt Tucker committed
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 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
    private int type;
    private long currentID;
    private long maxID;
    private int blockSize;

    /**
     * Creates a new DbSequenceManager.
     *
     * @param seqType the type of sequence.
     * @param size    the number of id's to "checkout" at a time.
     */
    public SequenceManager(int seqType, int size) {
        managers.put(seqType, this);
        this.type = seqType;
        this.blockSize = size;
        currentID = 0l;
        maxID = 0l;
    }

    /**
     * Returns the next available unique ID. Essentially this provides for the functionality of an
     * auto-increment database field.
     */
    public synchronized long nextUniqueID() {
        if (!(currentID < maxID)) {
            // Get next block -- make 5 attempts at maximum.
            getNextBlock(5);
        }
        long id = currentID;
        currentID++;
        return id;
    }

    /**
     * Performs a lookup to get the next available ID block. The algorithm is as follows:
     * <ol>
     * <li> Select currentID from appropriate db row.
     * <li> Increment id returned from db.
     * <li> Update db row with new id where id=old_id.
     * <li> If update fails another process checked out the block first; go back to step 1.
     * Otherwise, done.
     * </ol>
     */
    private void getNextBlock(int count) {
        if (count == 0) {
            Log.error("Failed at last attempt to obtain an ID, aborting...");
            return;
        }

        Connection con = null;
        PreparedStatement pstmt = null;
        boolean abortTransaction = false;
        boolean success = false;

        try {
            con = DbConnectionManager.getTransactionConnection();
            // Get the current ID from the database.
            pstmt = con.prepareStatement(LOAD_ID);
            pstmt.setInt(1, type);
            ResultSet rs = pstmt.executeQuery();
192 193

            long currentID = 1;
Matt Tucker's avatar
Matt Tucker committed
194
            if (!rs.next()) {
195 196 197 198 199 200 201 202 203
                rs.close();
                pstmt.close();

                createNewID(con, type);
            }
            else {
                currentID = rs.getLong(1);
                rs.close();
                pstmt.close();
Matt Tucker's avatar
Matt Tucker committed
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
            }

            // Increment the id to define our block.
            long newID = currentID + blockSize;
            // The WHERE clause includes the last value of the id. This ensures
            // that an update will occur only if nobody else has performed an
            // update first.
            pstmt = con.prepareStatement(UPDATE_ID);
            pstmt.setLong(1, newID);
            pstmt.setInt(2, type);
            pstmt.setLong(3, currentID);
            // Check to see if the row was affected. If not, some other process
            // already changed the original id that we read. Therefore, this
            // round failed and we'll have to try again.
            success = pstmt.executeUpdate() == 1;
            if (success) {
                this.currentID = currentID;
                this.maxID = newID;
            }
        }
        catch (SQLException e) {
            Log.error(e);
            abortTransaction = true;
        }
        finally {
229 230 231 232 233 234 235 236
            try {
                if (pstmt != null) {
                    pstmt.close();
                }
            }
            catch (Exception e) {
                Log.error(e);
            }
Matt Tucker's avatar
Matt Tucker committed
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
            DbConnectionManager.closeTransactionConnection(con, abortTransaction);
        }

        if (!success) {
            Log.error("WARNING: failed to obtain next ID block due to " +
                    "thread contention. Trying again...");
            // Call this method again, but sleep briefly to try to avoid thread contention.
            try {
                Thread.sleep(75);
            }
            catch (InterruptedException ie) {
            }
            getNextBlock(count - 1);
        }
    }
252

253 254
    private void createNewID(Connection con, int type) throws SQLException {
        Log.warn("Autocreating jiveID row for type '" + type + "'");
255

256
        // create new ID row
257
        PreparedStatement pstmt = null;
258

259
        try {
260
            pstmt = con.prepareStatement(CREATE_ID);
261
            pstmt.setInt(1, type);
262
            pstmt.execute();
263 264
        }
        finally {
265
            DbConnectionManager.closeConnection(pstmt, null);
266 267 268
        }
    }

Matt Tucker's avatar
Matt Tucker committed
269
}