Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/**
* Copyright (C) 2008-2012 Matt Gumbley, DevZendo.org
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.devzendo.commondb
import dao.{SchemaVersion, CodeVersion}
import impl.JdbcTemplateDatabaseAccessFactory
import java.io.File
import org.slf4j.LoggerFactory
import util.RepresentationType
object DatabaseAccessFactory {
def apply[U <: UserDatabaseAccess]() = new JdbcTemplateDatabaseAccessFactory[U]
val LOGGER = LoggerFactory.getLogger(classOf[DatabaseAccessFactory[_]])
}
/**
* A representation type for type-safe password strings.
* @param password the password.
*/
case class Password(password: String) extends RepresentationType[String](password)
/**
* The DatabaseAccessFactory allows user code to create new databases, or open
* existing ones.
*
* @tparam U the subtype that provides user database access, DAOs, etc.
*/
trait DatabaseAccessFactory[U <: UserDatabaseAccess] {
/**
* Check whether a database exists, so you can tell whether to call open or
* create.
*
* @param databasePath the directory in which the database's file set are to be
* stored.
* @param databaseName the common prefix name used by the database's file set.
* @return true iff the database exists, according to H2
*
*/
def exists(databasePath: File, databaseName: String): Boolean
/**
* Create a new database.
*
* @param databasePath the directory in which the database's file set are to be
* stored.
* @param databaseName the common prefix name used by the database's file set.
* @param password an optional password with which to encrypt the database
* contents. If None, the database is not encrypted. It is
* not possible to encrypt a database after it has been
* created.
* @param codeVersion the current version of the application code. This
* will be stored in the Versions table and is accessible
* via the VersionsDao. See the documentation of
* VersionTypes for details of the allowed formats.
* @param schemaVersion the current version of the database schema. This
* will be stored in the Versions table and is accessible
* via the VersionsDao. See the documentation of
* VersionTypes for details of the allowed formats.
* @param workflowAdapter an optional CreateWorkflowAdapter that will be
* called back to notify you of the progress of
* creation
* @param userDatabaseCreator an optional UserDatabaseCreator that can
* provide the means by which you create and
* populate your application's tables.
* @param userDatabaseAccessFactory an optional function that will
* instantiate your UserDatabaseAccess,
* for setting into the returned
* DatabaseAccess instance.
* @return an optional DatabaseAccess; if None, then the database cannot be
* created; if Some, the contained DatabaseAccess gives access to
* the now open database.
*/
def create(
databasePath: File,
databaseName: String,
password: Option[Password],
codeVersion: CodeVersion,
schemaVersion: SchemaVersion,
workflowAdapter: Option[CreateWorkflowAdapter],
userDatabaseCreator: Option[UserDatabaseCreator],
userDatabaseAccessFactory: Option[Function1[DatabaseAccess[U], U]]): Option[DatabaseAccess[U]]
/**
* Open a database that should already exist.
*
* @param databasePath the directory in which the database's file set are to be
* stored.
* @param databaseName the common prefix name used by the database's file set.
* @param password an optional password with which to attempt the opening of
* an encrypted database. If the database is known to be
* unencrypted, use None here. If Some[Password] is used,
* an attempt is made to open the database. If this fails,
* the OpenWorkflowAdapter will be called back to prompt for
* another password; this repeats until the database opens
* succesfully, or the user notifies the OpenWorkflowAdapter
* that the open should be cancelled.
* @param codeVersion the current version of the application code. This
* will be stored in the Versions table and is accessible
* via the VersionsDao. See the documentation of
* VersionTypes for details of the allowed formats.
* @param schemaVersion the current version of the database schema. This
* will be stored in the Versions table and is accessible
* via the VersionsDao. See the documentation of
* VersionTypes for details of the allowed formats and
* the version ordering logic. If the schemaVersion
* stored in the database is older than the current
* schemaVersion supplied here, the OpenWorkflowAdapter
* will be called back for you to supply upgrade
* or migration logic. The version you supply here will
* be stored in the Versions table after migration.
* @param workflowAdapter an optional OpenWorkflowAdapter that will be
* called back to notify you of the progress of
* opening, and to provide the means by which you
* can provide further attempts at passwords.
* @param userDatabaseMigrator an optional UserDatabaseMigrator that will
* be called back to migrate your application's
* tables/contents to the latest schemaVersion.
* @param userDatabaseAccessFactory an optional function that will
* instantiate your UserDatabaseAccess,
* for setting into the returned
* DatabaseAccess instance.
* @return an optional DatabaseAccess; if None, then the database cannot be
* opened; if Some, the contained DatabaseAccess gives access to
* the now open database.
*/
def open(
databasePath: File,
databaseName: String,
password: Option[Password],
codeVersion: CodeVersion,
schemaVersion: SchemaVersion,
workflowAdapter: Option[OpenWorkflowAdapter],
userDatabaseMigrator: Option[UserDatabaseMigrator],
userDatabaseAccessFactory: Option[Function1[DatabaseAccess[U], U]]): Option[DatabaseAccess[U]]
}
