DbConnectionManager.java 28.3 KB
Newer Older
Matt Tucker's avatar
Matt Tucker committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/**
 * $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.ClassUtils;
15
import org.jivesoftware.util.JiveGlobals;
16
import org.jivesoftware.util.Log;
Matt Tucker's avatar
Matt Tucker committed
17

18
import java.io.*;
19
import java.sql.*;
Matt Tucker's avatar
Matt Tucker committed
20 21 22 23

/**
 * Central manager of database connections. All methods are static so that they
 * can be easily accessed throughout the classes in the database package.<p>
24
 *
Matt Tucker's avatar
Matt Tucker committed
25 26 27 28 29
 * This class also provides a set of utility methods that abstract out
 * operations that may not work on all databases such as setting the max number
 * or rows that a query should return.
 *
 * @author Jive Software
30
 * @see ConnectionProvider
Matt Tucker's avatar
Matt Tucker committed
31 32 33 34
 */
public class DbConnectionManager {

    private static ConnectionProvider connectionProvider;
35
    private static final Object providerLock = new Object();
Matt Tucker's avatar
Matt Tucker committed
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53

    // True if connection profiling is turned on. Always false by default.
    private static boolean profilingEnabled = false;

    // True if the database support transactions.
    private static boolean transactionsSupported;
    // True if the database requires large text fields to be streamed.
    private static boolean streamTextRequired;
    // True if the database supports the Statement.setMaxRows() method.
    private static boolean maxRowsSupported;
    // True if the database supports the Statement.setFetchSize() method.
    private static boolean fetchSizeSupported;
    // True if the database supports correlated subqueries.
    private static boolean subqueriesSupported;
    // True if the database supports scroll-insensitive results.
    private static boolean scrollResultsSupported;
    // True if the database supports batch updates.
    private static boolean batchUpdatesSupported;
54 55 56 57
    // True if the database supports the dual table.
    private static boolean dualTableSupported;
    // True if the database does not support select without from.
    private static boolean selectRequiresFrom;
Matt Tucker's avatar
Matt Tucker committed
58

59
    private static DatabaseType databaseType = DatabaseType.unknown;
Matt Tucker's avatar
Matt Tucker committed
60

61 62
    private static SchemaManager schemaManager = new SchemaManager();

Matt Tucker's avatar
Matt Tucker committed
63 64 65
    /**
     * Returns a database connection from the currently active connection
     * provider. (auto commit is set to true).
66 67 68
     *
     * @return a connection.
     * @throws SQLException if a SQL exception occurs.
Matt Tucker's avatar
Matt Tucker committed
69 70 71 72 73 74 75
     */
    public static Connection getConnection() throws SQLException {
        if (connectionProvider == null) {
            synchronized (providerLock) {
                if (connectionProvider == null) {
                    // Attempt to load the connection provider classname as
                    // a Jive property.
76
                    String className = JiveGlobals.getXMLProperty("connectionProvider.className");
Matt Tucker's avatar
Matt Tucker committed
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
                    if (className != null) {
                        // Attempt to load the class.
                        try {
                            Class conClass = ClassUtils.forName(className);
                            setConnectionProvider((ConnectionProvider)conClass.newInstance());
                        }
                        catch (Exception e) {
                            Log.error("Warning: failed to create the " +
                                    "connection provider specified by connection" +
                                    "Provider.className. Using the default pool.", e);
                            setConnectionProvider(new DefaultConnectionProvider());
                        }
                    }
                    else {
                        setConnectionProvider(new DefaultConnectionProvider());
                    }
                }
            }
        }
        Connection con = connectionProvider.getConnection();

        if (con == null) {
            Log.error("WARNING: ConnectionManager.getConnection() " +
                    "failed to obtain a connection.");
        }
        // See if profiling is enabled. If yes, wrap the connection with a
        // profiled connection.
        if (profilingEnabled) {
105
            return new ProfiledConnection(con);
Matt Tucker's avatar
Matt Tucker committed
106 107 108 109 110 111 112 113 114
        }
        else {
            return con;
        }
    }

    /**
     * Returns a Connection from the currently active connection provider that
     * is ready to participate in transactions (auto commit is set to false).
115 116 117
     *
     * @return a connection with transactions enabled.
     * @throws SQLException if a SQL exception occurs.
Matt Tucker's avatar
Matt Tucker committed
118 119 120 121 122 123 124 125 126
     */
    public static Connection getTransactionConnection() throws SQLException {
        Connection con = getConnection();
        if (isTransactionsSupported()) {
            con.setAutoCommit(false);
        }
        return con;
    }

127 128 129
    /**
     * Closes a PreparedStatement and Connection. However, it first rolls back the transaction or
     * commits it depending on the value of <code>abortTransaction</code>.
130 131 132 133
     *
     * @param pstmt the prepared statement to close.
     * @param con the connection to close.
     * @param abortTransaction true if the transaction should be rolled back.
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
     */
    public static void closeTransactionConnection(PreparedStatement pstmt, Connection con,
            boolean abortTransaction)
    {
        try {
            if (pstmt != null) {
                pstmt.close();
            }
        }
        catch (Exception e) {
            Log.error(e);
        }
        closeTransactionConnection(con, abortTransaction);
    }

Matt Tucker's avatar
Matt Tucker committed
149 150 151
    /**
     * Closes a Connection. However, it first rolls back the transaction or
     * commits it depending on the value of <code>abortTransaction</code>.
152 153 154
     *
     * @param con the connection to close.
     * @param abortTransaction true if the transaction should be rolled back.
Matt Tucker's avatar
Matt Tucker committed
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
     */
    public static void closeTransactionConnection(Connection con, boolean abortTransaction) {
        // test to see if the connection passed in is null
        if (con == null) {
            return;
        }

        // Rollback or commit the transaction
        if (isTransactionsSupported()) {
            try {
                if (abortTransaction) {
                    con.rollback();
                }
                else {
                    con.commit();
                }
            }
            catch (Exception e) {
                Log.error(e);
            }
        }
        try {
            // Reset the connection to auto-commit mode.
            if (isTransactionsSupported()) {
                con.setAutoCommit(true);
            }
        }
        catch (Exception e) {
            Log.error(e);
        }
        try {
            // Close the db connection.
            con.close();
        }
        catch (Exception e) {
            Log.error(e);
        }
    }

194 195
    /**
     * Closes a result set. This method should be called within the finally section of
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
     * your database logic, as in the following example:
     *
     * <pre>
     *  public void doSomething(Connection con) {
     *      ResultSet rs = null;
     *      PreparedStatement pstmt = null;
     *      try {
     *          pstmt = con.prepareStatement("select * from blah");
     *          rs = pstmt.executeQuery();
     *          ....
     *      }
     *      catch (SQLException sqle) {
     *          Log.error(sqle);
     *      }
     *      finally {
     *          ConnectionManager.closeResultSet(rs);
     *          ConnectionManager.closePreparedStatement(pstmt);
     *      }
     * } </pre>
215 216
     *
     * @param rs the result set to close.
217 218 219 220 221 222 223 224 225 226 227 228 229
     */
    public static void closeResultSet(ResultSet rs) {
        try {
            if (rs != null) {
                rs.close();
            }
        }
        catch (SQLException e) {
            Log.error(e);
        }
    }

    /**
230
     * Closes a statement. This method should be called within the finally section of
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
     * your database logic, as in the following example:
     *
     * <pre>
     *  public void doSomething(Connection con) {
     *      PreparedStatement pstmt = null;
     *      try {
     *          pstmt = con.prepareStatement("select * from blah");
     *          ....
     *      }
     *      catch (SQLException sqle) {
     *          Log.error(sqle);
     *      }
     *      finally {
     *          ConnectionManager.closePreparedStatement(pstmt);
     *      }
     * } </pre>
     *
248
     * @param stmt the statement.
249
     */
250
    public static void closeStatement(Statement stmt) {
251
        try {
252 253
            if (stmt != null) {
                stmt.close();
254 255 256 257 258 259 260 261
            }
        }
        catch (Exception e) {
            Log.error(e);
        }
    }

    /**
262
     * Closes a result set, statement and database connection (returning the connection to
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
     * the connection pool). This method should be called within the finally section of
     * your database logic, as in the following example:
     *
     * <pre>
     * Connection con = null;
     * PrepatedStatment pstmt = null;
     * ResultSet rs = null;
     * try {
     *     con = ConnectionManager.getConnection();
     *     pstmt = con.prepareStatement("select * from blah");
     *     rs = psmt.executeQuery();
     *     ....
     * }
     * catch (SQLException sqle) {
     *     Log.error(sqle);
     * }
     * finally {
     *     ConnectionManager.closeConnection(rs, pstmt, con);
     * }</pre>
     *
283
     * @param rs the result set.
284
     * @param stmt the statement.
285 286
     * @param con the connection.
     */
287
    public static void closeConnection(ResultSet rs, Statement stmt, Connection con) {
288
        closeResultSet(rs);
289
        closeStatement(stmt);
290 291 292
        closeConnection(con);
    }

293
    /**
294
     * Closes a statement and database connection (returning the connection to
295 296
     * the connection pool). This method should be called within the finally section of
     * your database logic, as in the following example:
297
     * <p/>
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
     * <pre>
     * Connection con = null;
     * PrepatedStatment pstmt = null;
     * try {
     *     con = ConnectionManager.getConnection();
     *     pstmt = con.prepareStatement("select * from blah");
     *     ....
     * }
     * catch (SQLException sqle) {
     *     Log.error(sqle);
     * }
     * finally {
     *     DbConnectionManager.closeConnection(pstmt, con);
     * }</pre>
     *
313 314
     * @param stmt the statement.
     * @param con the connection.
315
     */
316
    public static void closeConnection(Statement stmt, Connection con) {
317
        try {
318 319
            if (stmt != null) {
                stmt.close();
320 321 322 323 324 325 326 327 328 329 330 331 332
            }
        }
        catch (Exception e) {
            Log.error(e);
        }
        closeConnection(con);
    }

    /**
     * Closes a database connection (returning the connection to the connection pool). Any
     * statements associated with the connection should be closed before calling this method.
     * This method should be called within the finally section of your database logic, as
     * in the following example:
333
     * <p/>
334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359
     * <pre>
     * Connection con = null;
     * try {
     *     con = ConnectionManager.getConnection();
     *     ....
     * }
     * catch (SQLException sqle) {
     *     Log.error(sqle);
     * }
     * finally {
     *     DbConnectionManager.closeConnection(con);
     * }</pre>
     *
     * @param con the connection.
     */
    public static void closeConnection(Connection con) {
        try {
            if (con != null) {
                con.close();
            }
        }
        catch (Exception e) {
            Log.error(e);
        }
    }

Matt Tucker's avatar
Matt Tucker committed
360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
    /**
     * Creates a scroll insensitive Statement if the JDBC driver supports it, or a normal
     * Statement otherwise.
     *
     * @param con the database connection.
     * @return a Statement
     * @throws SQLException if an error occurs.
     */
    public static Statement createScrollableStatement(Connection con) throws SQLException {
        if (isScrollResultsSupported()) {
            return con.createStatement(ResultSet.TYPE_SCROLL_INSENSITIVE,
                    ResultSet.CONCUR_READ_ONLY);
        }
        else {
            return con.createStatement();
        }
    }

    /**
     * Creates a scroll insensitive PreparedStatement if the JDBC driver supports it, or a normal
     * PreparedStatement otherwise.
     *
     * @param con the database connection.
     * @param sql the SQL to create the PreparedStatement with.
     * @return a PreparedStatement
     * @throws java.sql.SQLException if an error occurs.
     */
    public static PreparedStatement createScrollablePreparedStatement(Connection con, String sql)
            throws SQLException {
        if (isScrollResultsSupported()) {
            return con.prepareStatement(sql, ResultSet.TYPE_SCROLL_INSENSITIVE,
                    ResultSet.CONCUR_READ_ONLY);
        }
        else {
            return con.prepareStatement(sql);
        }
    }

    /**
399 400 401
     * Scrolls forward in a result set the specified number of rows. If the JDBC driver
     * supports the feature, the cursor will be moved directly. Otherwise, we scroll
     * through results one by one manually by calling <tt>rs.next()</tt>.
Matt Tucker's avatar
Matt Tucker committed
402
     *
403
     * @param rs the ResultSet object to scroll.
Matt Tucker's avatar
Matt Tucker committed
404 405 406 407 408 409 410
     * @param rowNumber the row number to scroll forward to.
     * @throws SQLException if an error occurs.
     */
    public static void scrollResultSet(ResultSet rs, int rowNumber) throws SQLException {
        // If the driver supports scrollable result sets, use that feature.
        if (isScrollResultsSupported()) {
            if (rowNumber > 0) {
411
                rs.setFetchDirection(ResultSet.FETCH_FORWARD);
412 413 414 415 416 417 418 419 420 421 422 423 424

                // We will attempt to do a relative fetch. This may fail in SQL Server if
                // <resultset-navigation-strategy> is set to absolute. It would need to be
                // set to looping to work correctly.
                // If so, manually scroll to the correct row.
                try {
                    rs.relative(rowNumber);
                }
                catch (SQLException e) {
                    for (int i = 0; i < rowNumber; i++) {
                        rs.next();
                    }
                }
Matt Tucker's avatar
Matt Tucker committed
425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
            }
        }
        // Otherwise, manually scroll to the correct row.
        else {
            for (int i = 0; i < rowNumber; i++) {
                rs.next();
            }
        }
    }

    /**
     * Returns the current connection provider. The only case in which this
     * method should be called is if more information about the current
     * connection provider is needed. Database connections should always be
     * obtained by calling the getConnection method of this class.
440 441
     *
     * @return the connection provider.
Matt Tucker's avatar
Matt Tucker committed
442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468
     */
    public static ConnectionProvider getConnectionProvider() {
        return connectionProvider;
    }

    /**
     * Sets the connection provider. The old provider (if it exists) is shut
     * down before the new one is started. A connection provider <b>should
     * not</b> be started before being passed to the connection manager
     * because the manager will call the start() method automatically.
     *
     * @param provider the ConnectionProvider that the manager should obtain
     *                 connections from.
     */
    public static void setConnectionProvider(ConnectionProvider provider) {
        synchronized (providerLock) {
            if (connectionProvider != null) {
                connectionProvider.destroy();
                connectionProvider = null;
            }
            connectionProvider = provider;
            connectionProvider.start();
            // Now, get a connection to determine meta data.
            Connection con = null;
            try {
                con = connectionProvider.getConnection();
                setMetaData(con);
469 470

                // Check to see if the database schema needs to be upgraded.
471
                schemaManager.checkOpenfireSchema(con);
Matt Tucker's avatar
Matt Tucker committed
472 473 474 475 476
            }
            catch (Exception e) {
                Log.error(e);
            }
            finally {
477 478 479 480 481 482 483 484
                try {
                    if (con != null) {
                        con.close();
                    }
                }
                catch (Exception e) {
                    Log.error(e);
                }
Matt Tucker's avatar
Matt Tucker committed
485 486 487
            }
        }
        // Remember what connection provider we want to use for restarts.
488
        JiveGlobals.setXMLProperty("connectionProvider.className", provider.getClass().getName());
Matt Tucker's avatar
Matt Tucker committed
489 490
    }

491 492 493 494 495 496 497 498 499 500 501 502 503 504 505
    /**
     * Destroys the currennt connection provider. Future calls to
     * {@link #getConnectionProvider()} will return <tt>null</tt> until a new
     * ConnectionProvider is set, or one is automatically loaded by a call to
     * {@link #getConnection()}.
     */
    public static void destroyConnectionProvider() {
        synchronized (providerLock) {
            if (connectionProvider != null) {
                connectionProvider.destroy();
                connectionProvider = null;
            }
        }
    }

Matt Tucker's avatar
Matt Tucker committed
506 507 508 509 510 511
    /**
     * Retrives a large text column from a result set, automatically performing
     * streaming if the JDBC driver requires it. This is necessary because
     * different JDBC drivers have different capabilities and methods for
     * retrieving large text values.
     *
512
     * @param rs the ResultSet to retrieve the text field from.
Matt Tucker's avatar
Matt Tucker committed
513 514
     * @param columnIndex the column in the ResultSet of the text field.
     * @return the String value of the text field.
515
     * @throws SQLException if an SQL exception occurs.
Matt Tucker's avatar
Matt Tucker committed
516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
     */
    public static String getLargeTextField(ResultSet rs, int columnIndex) throws SQLException {
        if (isStreamTextRequired()) {
            Reader bodyReader = null;
            String value = null;
            try {
                bodyReader = rs.getCharacterStream(columnIndex);
                if (bodyReader == null) {
                    return null;
                }
                char[] buf = new char[256];
                int len;
                StringWriter out = new StringWriter(256);
                while ((len = bodyReader.read(buf)) >= 0) {
                    out.write(buf, 0, len);
                }
                value = out.toString();
                out.close();
            }
            catch (Exception e) {
                Log.error(e);
                throw new SQLException("Failed to load text field");
            }
            finally {
                try {
541 542 543
                    if (bodyReader != null) {
                        bodyReader.close();
                    }
Matt Tucker's avatar
Matt Tucker committed
544 545
                }
                catch (Exception e) {
546
                    // Ignore.
Matt Tucker's avatar
Matt Tucker committed
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561
                }
            }
            return value;
        }
        else {
            return rs.getString(columnIndex);
        }
    }

    /**
     * Sets a large text column in a result set, automatically performing
     * streaming if the JDBC driver requires it. This is necessary because
     * different JDBC drivers have different capabilities and methods for
     * setting large text values.
     *
562
     * @param pstmt the PreparedStatement to set the text field in.
Matt Tucker's avatar
Matt Tucker committed
563
     * @param parameterIndex the index corresponding to the text field.
564
     * @param value the String to set.
565
     * @throws SQLException if an SQL exception occurs.
Matt Tucker's avatar
Matt Tucker committed
566
     */
567
    public static void setLargeTextField(PreparedStatement pstmt, int parameterIndex,
568
                                         String value) throws SQLException {
Matt Tucker's avatar
Matt Tucker committed
569
        if (isStreamTextRequired()) {
570
            Reader bodyReader;
Matt Tucker's avatar
Matt Tucker committed
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591
            try {
                bodyReader = new StringReader(value);
                pstmt.setCharacterStream(parameterIndex, bodyReader, value.length());
            }
            catch (Exception e) {
                Log.error(e);
                throw new SQLException("Failed to set text field.");
            }
            // Leave bodyReader open so that the db can read from it. It *should*
            // be garbage collected after it's done without needing to call close.
        }
        else {
            pstmt.setString(parameterIndex, value);
        }
    }

    /**
     * Sets the max number of rows that should be returned from executing a
     * statement. The operation is automatically bypassed if Jive knows that the
     * the JDBC driver or database doesn't support it.
     *
592
     * @param stmt    the Statement to set the max number of rows for.
Matt Tucker's avatar
Matt Tucker committed
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615
     * @param maxRows the max number of rows to return.
     */
    public static void setMaxRows(Statement stmt, int maxRows) {
        if (isMaxRowsSupported()) {
            try {
                stmt.setMaxRows(maxRows);
            }
            catch (Throwable t) {
                // Ignore. Exception may happen if the driver doesn't support
                // this operation and we didn't set meta-data correctly.
                // However, it is a good idea to update the meta-data so that
                // we don't have to incur the cost of catching an exception
                // each time.
                maxRowsSupported = false;
            }
        }
    }

    /**
     * Sets the number of rows that the JDBC driver should buffer at a time.
     * The operation is automatically bypassed if Jive knows that the
     * the JDBC driver or database doesn't support it.
     *
616
     * @param rs the ResultSet to set the fetch size for.
Matt Tucker's avatar
Matt Tucker committed
617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634
     * @param fetchSize the fetchSize.
     */
    public static void setFetchSize(ResultSet rs, int fetchSize) {
        if (isFetchSizeSupported()) {
            try {
                rs.setFetchSize(fetchSize);
            }
            catch (Throwable t) {
                // Ignore. Exception may happen if the driver doesn't support
                // this operation and we didn't set meta-data correctly.
                // However, it is a good idea to update the meta-data so that
                // we don't have to incur the cost of catching an exception
                // each time.
                fetchSizeSupported = false;
            }
        }
    }

635 636
    /**
     * Returns a SchemaManager instance, which can be used to manage the database
637
     * schema information for Openfire and plugins.
638 639 640 641 642 643 644
     *
     * @return a SchemaManager instance.
     */
    public static SchemaManager getSchemaManager() {
        return schemaManager;
    }

Matt Tucker's avatar
Matt Tucker committed
645 646 647
    /**
     * Uses a connection from the database to set meta data information about
     * what different JDBC drivers and databases support.
648 649 650
     *
     * @param con the connection.
     * @throws SQLException if an SQL exception occurs.
Matt Tucker's avatar
Matt Tucker committed
651 652 653 654 655 656 657
     */
    private static void setMetaData(Connection con) throws SQLException {
        DatabaseMetaData metaData = con.getMetaData();
        // Supports transactions?
        transactionsSupported = metaData.supportsTransactions();
        // Supports subqueries?
        subqueriesSupported = metaData.supportsCorrelatedSubqueries();
658 659 660 661 662 663 664 665 666 667
        // Supports scroll insensitive result sets? Try/catch block is a
        // workaround for DB2 JDBC driver, which throws an exception on
        // the method call.
        try {
            scrollResultsSupported = metaData.supportsResultSetType(
                    ResultSet.TYPE_SCROLL_INSENSITIVE);
        }
        catch (Exception e) {
            scrollResultsSupported = false;
        }
Matt Tucker's avatar
Matt Tucker committed
668 669 670 671 672 673 674
        // Supports batch updates
        batchUpdatesSupported = metaData.supportsBatchUpdates();

        // Set defaults for other meta properties
        streamTextRequired = false;
        maxRowsSupported = true;
        fetchSizeSupported = true;
675 676
        dualTableSupported = false;
        selectRequiresFrom = false;
Matt Tucker's avatar
Matt Tucker committed
677 678 679 680 681 682 683

        // Get the database name so that we can perform meta data settings.
        String dbName = metaData.getDatabaseProductName().toLowerCase();
        String driverName = metaData.getDriverName().toLowerCase();

        // Oracle properties.
        if (dbName.indexOf("oracle") != -1) {
684
            databaseType = DatabaseType.oracle;
Matt Tucker's avatar
Matt Tucker committed
685
            streamTextRequired = true;
686
            scrollResultsSupported = false;
687 688
            dualTableSupported = true;
            selectRequiresFrom = true;
Matt Tucker's avatar
Matt Tucker committed
689 690 691 692 693 694 695 696 697
            // The i-net AUGURO JDBC driver
            if (driverName.indexOf("auguro") != -1) {
                streamTextRequired = false;
                fetchSizeSupported = true;
                maxRowsSupported = false;
            }
        }
        // Postgres properties
        else if (dbName.indexOf("postgres") != -1) {
698
            databaseType = DatabaseType.postgresql;
Matt Tucker's avatar
Matt Tucker committed
699 700 701 702 703 704
            // Postgres blows, so disable scrolling result sets.
            scrollResultsSupported = false;
            fetchSizeSupported = false;
        }
        // Interbase properties
        else if (dbName.indexOf("interbase") != -1) {
705
            databaseType = DatabaseType.interbase;
Matt Tucker's avatar
Matt Tucker committed
706 707 708
            fetchSizeSupported = false;
            maxRowsSupported = false;
        }
709 710
        // SQLServer
        else if (dbName.indexOf("sql server") != -1) {
711
            databaseType = DatabaseType.sqlserver;
712 713 714 715 716
            // JDBC driver i-net UNA properties
            if (driverName.indexOf("una") != -1) {
                fetchSizeSupported = true;
                maxRowsSupported = false;
            }
Matt Tucker's avatar
Matt Tucker committed
717 718 719
        }
        // MySQL properties
        else if (dbName.indexOf("mysql") != -1) {
720
            databaseType = DatabaseType.mysql;
Matt Tucker's avatar
Matt Tucker committed
721
            transactionsSupported = false;
722
            dualTableSupported = true;
Matt Tucker's avatar
Matt Tucker committed
723
        }
724 725
        // HSQL properties
        else if (dbName.indexOf("hsql") != -1) {
726
            databaseType = DatabaseType.hsqldb;
727 728
            scrollResultsSupported = false;
        }
729 730 731 732
        // DB2 properties.
        else if (dbName.indexOf("db2") != 1) {
            databaseType = DatabaseType.db2;
        }
Matt Tucker's avatar
Matt Tucker committed
733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803
    }

    /**
     * Returns the database type. The possible types are constants of the
     * DatabaseType class. Any database that doesn't have its own constant
     * falls into the "Other" category.
     *
     * @return the database type.
     */
    public static DatabaseType getDatabaseType() {
        return databaseType;
    }

    /**
     * Returns true if connection profiling is turned on. You can collect
     * profiling statistics by using the static methods of the ProfiledConnection
     * class.
     *
     * @return true if connection profiling is enabled.
     */
    public static boolean isProfilingEnabled() {
        return profilingEnabled;
    }

    /**
     * Turns connection profiling on or off. You can collect profiling
     * statistics by using the static methods of the ProfiledConnection
     * class.
     *
     * @param enable true to enable profiling; false to disable.
     */
    public static void setProfilingEnabled(boolean enable) {
        // If enabling profiling, call the start method on ProfiledConnection
        if (!profilingEnabled && enable) {
            ProfiledConnection.start();
        }
        // Otherwise, if turning off, call stop method.
        else if (profilingEnabled && !enable) {
            ProfiledConnection.stop();
        }
        profilingEnabled = enable;
    }

    public static boolean isTransactionsSupported() {
        return transactionsSupported;
    }

    public static boolean isStreamTextRequired() {
        return streamTextRequired;
    }

    public static boolean isMaxRowsSupported() {
        return maxRowsSupported;
    }

    public static boolean isFetchSizeSupported() {
        return fetchSizeSupported;
    }

    public static boolean isSubqueriesSupported() {
        return subqueriesSupported;
    }

    public static boolean isScrollResultsSupported() {
        return scrollResultsSupported;
    }

    public static boolean isBatchUpdatesSupported() {
        return batchUpdatesSupported;
    }

804 805 806 807 808 809 810 811
    public static boolean isDualTableSupported() {
        return dualTableSupported;
    }

    public static boolean doesSelectRequireFrom() {
        return selectRequiresFrom;
    }

812 813 814 815
    public static boolean isEmbeddedDB() {
        return connectionProvider != null && connectionProvider instanceof EmbeddedConnectionProvider;
    }

Matt Tucker's avatar
Matt Tucker committed
816 817 818 819 820 821 822
    /**
     * A class that identifies the type of the database that Jive is connected
     * to. In most cases, we don't want to make any database specific calls
     * and have no need to know the type of database we're using. However,
     * there are certain cases where it's critical to know the database for
     * performance reasons.
     */
823
    @SuppressWarnings({"UnnecessarySemicolon"}) // Support for QDox parsing
824 825 826
    public static enum DatabaseType {

        oracle,
Matt Tucker's avatar
Matt Tucker committed
827

828
        postgresql,
Matt Tucker's avatar
Matt Tucker committed
829

830 831 832 833 834 835 836 837 838 839
        mysql,

        hsqldb,

        db2,

        sqlserver,

        interbase,

840
        unknown;
841 842 843 844
    }

    private DbConnectionManager() {
        // Not instantiable.
Matt Tucker's avatar
Matt Tucker committed
845
    }
846
}