-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Auto-verify pgcrypto installed and up-to-date. Provide tips/hints via…
… 'database info' command.
- Loading branch information
Showing
3 changed files
with
323 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
147 changes: 147 additions & 0 deletions
147
dspace-api/src/main/java/org/dspace/storage/rdbms/PostgreSQLCryptoChecker.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,147 @@ | ||
| /** | ||
| * The contents of this file are subject to the license and copyright | ||
| * detailed in the LICENSE and NOTICE files at the root of the source | ||
| * tree and available online at | ||
| * | ||
| * http://www.dspace.org/license/ | ||
| */ | ||
| package org.dspace.storage.rdbms; | ||
|
|
||
| import java.sql.Connection; | ||
| import java.sql.SQLException; | ||
| import org.apache.log4j.Logger; | ||
| import org.flywaydb.core.api.FlywayException; | ||
| import org.flywaydb.core.api.MigrationInfo; | ||
| import org.flywaydb.core.api.callback.FlywayCallback; | ||
|
|
||
| /** | ||
| * This is a FlywayCallback class which automatically verifies that "pgcrypto" | ||
| * is at the proper version before running any database migrations. | ||
| * <P> | ||
| * When running PostgreSQL, pgcrypto is REQUIRED by DSpace as it allows UUIDs | ||
| * to be generated. | ||
| * <P> | ||
| * During a database "clean", this also de-registers "pgcrypto" proir to the | ||
| * full database clean. | ||
| * | ||
| * @author Tim Donohue | ||
| */ | ||
| public class PostgreSQLCryptoChecker implements FlywayCallback | ||
| { | ||
| private Logger log = Logger.getLogger(PostgreSQLCryptoChecker.class); | ||
|
|
||
| /** | ||
| * Check for pgcrypto (if needed). Throws an exception if pgcrypto is | ||
| * not installed or needs an upgrade. | ||
| * @param connection database connection | ||
| */ | ||
| public void checkPgCrypto(Connection connection) | ||
| { | ||
| String dbType; | ||
| try | ||
| { | ||
| dbType = DatabaseUtils.getDbType(connection); | ||
| } | ||
| catch(SQLException se) | ||
| { | ||
| throw new FlywayException("Unable to determine database type.", se); | ||
| } | ||
|
|
||
| // ONLY Check if this is a PostgreSQL database | ||
| if(dbType!=null && dbType.equals(DatabaseUtils.DBMS_POSTGRES)) | ||
| { | ||
| // If this is a PostgreSQL database, then a supported version | ||
| // of the 'pgcrypto' extension MUST be installed to continue. | ||
|
|
||
| // Check if pgcrypto is both installed & a supported version | ||
| if(!DatabaseUtils.isPgcryptoUpToDate()) | ||
| { | ||
| throw new FlywayException("This PostgreSQL Database is INCOMPATIBLE with DSpace. The upgrade will NOT proceed. " + | ||
| "A supported version (>=" + DatabaseUtils.PGCRYPTO_VERSION + ") of the '" + DatabaseUtils.PGCRYPTO + "' extension must be installed! " + | ||
| "Please run 'dspace database info' for additional info/tips."); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public void beforeClean(Connection connection) { | ||
|
|
||
| } | ||
|
|
||
| @Override | ||
| public void afterClean(Connection connection) { | ||
|
|
||
| } | ||
|
|
||
| @Override | ||
| public void beforeMigrate(Connection connection) { | ||
| // Before migrating database, check for pgcrypto | ||
| checkPgCrypto(connection); | ||
| } | ||
|
|
||
| @Override | ||
| public void afterMigrate(Connection connection) { | ||
|
|
||
| } | ||
|
|
||
| @Override | ||
| public void beforeEachMigrate(Connection connection, MigrationInfo migrationInfo) { | ||
|
|
||
| } | ||
|
|
||
| @Override | ||
| public void afterEachMigrate(Connection connection, MigrationInfo migrationInfo) { | ||
|
|
||
| } | ||
|
|
||
| @Override | ||
| public void beforeValidate(Connection connection) { | ||
|
|
||
| } | ||
|
|
||
| @Override | ||
| public void afterValidate(Connection connection) { | ||
|
|
||
| } | ||
|
|
||
| @Override | ||
| public void beforeInit(Connection connection) { | ||
|
|
||
| } | ||
|
|
||
| @Override | ||
| public void afterInit(Connection connection) { | ||
|
|
||
| } | ||
|
|
||
| @Override | ||
| public void beforeBaseline(Connection connection) { | ||
| // Before initializing database, check for pgcrypto | ||
| checkPgCrypto(connection); | ||
| } | ||
|
|
||
| @Override | ||
| public void afterBaseline(Connection connection) { | ||
|
|
||
| } | ||
|
|
||
| @Override | ||
| public void beforeRepair(Connection connection) { | ||
|
|
||
| } | ||
|
|
||
| @Override | ||
| public void afterRepair(Connection connection) { | ||
|
|
||
| } | ||
|
|
||
| @Override | ||
| public void beforeInfo(Connection connection) { | ||
|
|
||
| } | ||
|
|
||
| @Override | ||
| public void afterInfo(Connection connection) { | ||
|
|
||
| } | ||
| } |
Oops, something went wrong.