expense_tally.expense_manager.persistence.database.sqlite.SqLiteConnection Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of expense-tally-expense-manager Show documentation
The newest version!
package expense_tally.expense_manager.persistence.database.sqlite;

import expense_tally.exception.StringResolver;
import org.apache.commons.lang3.StringUtils;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.sqlite.JDBC;
import org.sqlite.SQLiteDataSource;

import javax.sql.DataSource;
import java.sql.SQLException;

/**
 * Manages the database connection to SQLite embedded database engine.
 * All the database configuration and related information is stored inside this class
 * As quoted in the title Wikipedia page
 * , SQLite library is linked and form part of the application. Hence there isn't a database server. The entire
 * database (definitions, tables, indices, and the data itself) is stored inside a single cross-platform file.
 */
public final class SqLiteConnection {
  private static final Logger LOGGER = LogManager.getLogger(SqLiteConnection.class);

  /**
   * Private constructor
   * Utility classes, which are collections of static members, are not meant to be instantiated
   */
  private SqLiteConnection() {
  }

  /**
   * Create a new data source based on the given parameters.
   * @param databaseFilePath URL of the database connection. Does not need to include database scheme.
   * @param loginTimeout maximum time in milliseconds that this data source can wait while attempting to connect to a
   *                     database.
   * @return a newly created instance of data source if creation succeeds.
   * @throws IllegalArgumentException if databaseFilePath is blank, or if loginTimeout is negative.
   */
  public static DataSource createDataSource(String databaseFilePath, int loginTimeout) throws SQLException {
    if (StringUtils.isBlank(databaseFilePath)) {
      LOGGER.atWarn()
          .log("databaseFilePath is blank. databaseFilePath:{}",
              StringResolver.resolveNullableString(databaseFilePath));
      throw new IllegalArgumentException("database file path cannot be blank.");
    }
    SQLiteDataSource sqLiteDataSource = new SQLiteDataSource();
    String connectionUrl = constructConnectionUrl(databaseFilePath);
    sqLiteDataSource.setUrl(connectionUrl);
    if (loginTimeout < 0) {
      LOGGER.atError().log("loginTimeout is negative: {}", loginTimeout);
      throw new IllegalArgumentException("Login time out value cannot be negative.");
    }
    int loginTimeoutSec = loginTimeout / 1000;
    sqLiteDataSource.setLoginTimeout(loginTimeoutSec);
    LOGGER.atDebug().log("Creating new sqLiteDataSource. connectionUrl:{}", connectionUrl);
    return sqLiteDataSource;
  }

  /**
   * Return connection URL of the database server based on the file path given in databaseFile
   * @param databaseFile file path given in databaseFile
   * @return connection URL of the database server based on the file path given in databaseFile
   */
  private static String constructConnectionUrl(String databaseFile) {
    return JDBC.PREFIX + databaseFile;
  }
}