Author: bleny Date: 2014-05-20 11:48:56 +0200 (Tue, 20 May 2014) New Revision: 3114 Url: http://forge.nuiton.org/projects/topia/repository/revisions/3114 Log: fixes #3204 introduce topia-service-liquibase module Added: trunk/topia-service-liquibase/ trunk/topia-service-liquibase/LICENSE.txt trunk/topia-service-liquibase/README.txt trunk/topia-service-liquibase/pom.xml trunk/topia-service-liquibase/src/ trunk/topia-service-liquibase/src/main/ trunk/topia-service-liquibase/src/main/java/ trunk/topia-service-liquibase/src/main/java/org/ trunk/topia-service-liquibase/src/main/java/org/nuiton/ trunk/topia-service-liquibase/src/main/java/org/nuiton/topia/ trunk/topia-service-liquibase/src/main/java/org/nuiton/topia/liquibase/ trunk/topia-service-liquibase/src/main/java/org/nuiton/topia/liquibase/TopiaLiquibaseService.java trunk/topia-service-liquibase/src/main/java/org/nuiton/topia/liquibase/TopiaLiquibaseServiceImpl.java Modified: trunk/pom.xml Modified: trunk/pom.xml =================================================================== --- trunk/pom.xml 2014-05-20 09:09:50 UTC (rev 3113) +++ trunk/pom.xml 2014-05-20 09:48:56 UTC (rev 3114) @@ -208,6 +208,7 @@ <module>topia-service-replication</module> <module>topia-service-migration</module> <module>topia-service-flyway</module> + <module>topia-service-liquibase</module> <module>topia-service-csv</module> </modules> @@ -333,6 +334,12 @@ <version>2.3</version> </dependency> + <dependency> + <groupId>org.liquibase</groupId> + <artifactId>liquibase-core</artifactId> + <version>3.1.1</version> + </dependency> + <!-- hibernate-core only include api, need implementation, binding with log4j will be used --> Property changes on: trunk/topia-service-liquibase ___________________________________________________________________ Added: svn:ignore + *.ipr *.iws .classpath *.iml .project target .settings .idea atlassian-ide-plugin.xml Copied: trunk/topia-service-liquibase/LICENSE.txt (from rev 3112, trunk/topia-service-flyway/LICENSE.txt) =================================================================== --- trunk/topia-service-liquibase/LICENSE.txt (rev 0) +++ trunk/topia-service-liquibase/LICENSE.txt 2014-05-20 09:48:56 UTC (rev 3114) @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. Added: trunk/topia-service-liquibase/README.txt =================================================================== Added: trunk/topia-service-liquibase/pom.xml =================================================================== --- trunk/topia-service-liquibase/pom.xml (rev 0) +++ trunk/topia-service-liquibase/pom.xml 2014-05-20 09:48:56 UTC (rev 3114) @@ -0,0 +1,63 @@ +<?xml version="1.0" encoding="UTF-8"?> +<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> + <modelVersion>4.0.0</modelVersion> + + <parent> + <groupId>org.nuiton</groupId> + <artifactId>topia</artifactId> + <version>3.0-SNAPSHOT</version> + </parent> + + <groupId>org.nuiton.topia</groupId> + <artifactId>topia-service-liquibase</artifactId> + <name>ToPIA :: Liquibase integration service</name> + <description>Integration between topia and Liquibase database migration framework</description> + + <dependencies> + + <!-- Sibling dependencies --> + <dependency> + <groupId>${project.groupId}</groupId> + <artifactId>topia-persistence</artifactId> + <version>${project.version}</version> + <scope>compile</scope> + </dependency> + + <dependency> + <groupId>${project.groupId}</groupId> + <artifactId>topia-junit</artifactId> + <version>${project.version}</version> + <scope>test</scope> + </dependency> + + <dependency> + <groupId>commons-logging</groupId> + <artifactId>commons-logging</artifactId> + </dependency> + + <dependency> + <groupId>org.liquibase</groupId> + <artifactId>liquibase-core</artifactId> + </dependency> + + <!-- Depencies for test--> + <dependency> + <groupId>com.h2database</groupId> + <artifactId>h2</artifactId> + </dependency> + <dependency> + <groupId>org.slf4j</groupId> + <artifactId>slf4j-log4j12</artifactId> + </dependency> + <dependency> + <groupId>junit</groupId> + <artifactId>junit</artifactId> + </dependency> + + </dependencies> + + <build> + </build> + +</project> + Property changes on: trunk/topia-service-liquibase/pom.xml ___________________________________________________________________ Added: svn:mime-type + text/xml Added: trunk/topia-service-liquibase/src/main/java/org/nuiton/topia/liquibase/TopiaLiquibaseService.java =================================================================== --- trunk/topia-service-liquibase/src/main/java/org/nuiton/topia/liquibase/TopiaLiquibaseService.java (rev 0) +++ trunk/topia-service-liquibase/src/main/java/org/nuiton/topia/liquibase/TopiaLiquibaseService.java 2014-05-20 09:48:56 UTC (rev 3114) @@ -0,0 +1,13 @@ +package org.nuiton.topia.liquibase; + +import org.nuiton.topia.persistence.TopiaService; + +/** + * Integration with <a href="http://www.liquibase.org/">Liquibase</a> migration + * framework. + * + * @since 3.0 + */ +public interface TopiaLiquibaseService extends TopiaService { + +} Added: trunk/topia-service-liquibase/src/main/java/org/nuiton/topia/liquibase/TopiaLiquibaseServiceImpl.java =================================================================== --- trunk/topia-service-liquibase/src/main/java/org/nuiton/topia/liquibase/TopiaLiquibaseServiceImpl.java (rev 0) +++ trunk/topia-service-liquibase/src/main/java/org/nuiton/topia/liquibase/TopiaLiquibaseServiceImpl.java 2014-05-20 09:48:56 UTC (rev 3114) @@ -0,0 +1,117 @@ +package org.nuiton.topia.liquibase; + +import liquibase.Liquibase; +import liquibase.database.Database; +import liquibase.database.DatabaseFactory; +import liquibase.exception.DatabaseException; +import liquibase.exception.LiquibaseException; +import liquibase.resource.ClassLoaderResourceAccessor; +import liquibase.resource.CompositeResourceAccessor; +import liquibase.resource.FileSystemResourceAccessor; +import liquibase.resource.ResourceAccessor; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.nuiton.topia.persistence.TopiaApplicationContext; +import org.nuiton.topia.persistence.TopiaConfigurationConstants; +import org.nuiton.topia.persistence.TopiaException; + +import java.util.Map; + +/** + * Integration with <a href="http://www.liquibase.org/">Liquibase</a> migration + * framework. + * + * When {@link org.nuiton.topia.persistence.TopiaApplicationContext} will be started + * all migrations will be run. + * + * @since 3.0 + */ +public class TopiaLiquibaseServiceImpl implements TopiaLiquibaseService { + + private static final Log log = LogFactory.getLog(TopiaLiquibaseServiceImpl.class); + + /** + * Place to find the changelog, default name has been fixed according + * to <a href="http://www.liquibase.org/bestpractices.html">best practices</a>. + */ + protected String changeLogPath = "db/changelog-master.xml"; + + @Override + public void setConfiguration(Map<String, String> serviceConfiguration) { + if ( ! serviceConfiguration.isEmpty()) { + throw new UnsupportedOperationException("no configuratione expected but " + serviceConfiguration + " given"); + } + } + + @Override + public Class<?>[] getPersistenceClasses() { + return new Class<?>[0]; + } + + @Override + public void preInit(TopiaApplicationContext topiaApplicationContext) { + + Database database = null; + try { + + ResourceAccessor resourceAccessor = getResourceAccessor(); + + database = openDatabase(topiaApplicationContext, resourceAccessor); + + Liquibase liquibase = getLiquibase(database, resourceAccessor); + + update(liquibase); + + } catch (LiquibaseException e) { + throw new TopiaException("unable to init liquibase", e); + } finally { + if (database != null) { + try { + database.close(); + } catch (DatabaseException e) { + throw new TopiaException("unable to close database after migration", e); + } + } + } + + } + + protected void update(Liquibase liquibase) throws LiquibaseException { + liquibase.update(""); // "" mean all contexts + } + + protected Liquibase getLiquibase(Database database, ResourceAccessor resourceAccessor) throws LiquibaseException { + Liquibase liquibase = new Liquibase(changeLogPath, resourceAccessor, database); + return liquibase; + } + + /** + * Implementation highly inspired from {@link liquibase.integration.servlet.LiquibaseServletListener}. + */ + protected ResourceAccessor getResourceAccessor() { + Thread currentThread = Thread.currentThread(); + ClassLoader contextClassLoader = currentThread.getContextClassLoader(); + ResourceAccessor threadClFO = new ClassLoaderResourceAccessor(contextClassLoader); + ResourceAccessor clFO = new ClassLoaderResourceAccessor(); + ResourceAccessor fsFO = new FileSystemResourceAccessor(); + return new CompositeResourceAccessor(clFO, fsFO, threadClFO); + } + + protected Database openDatabase(TopiaApplicationContext topiaApplicationContext, ResourceAccessor resourceAccessor) { + Map<String, String> configuration = topiaApplicationContext.getConfiguration(); + String url = configuration.get(TopiaConfigurationConstants.CONFIG_URL); + String user = configuration.get(TopiaConfigurationConstants.CONFIG_USER); + String password = configuration.get(TopiaConfigurationConstants.CONFIG_PASS); + try { + Database database = DatabaseFactory.getInstance().openDatabase(url, user, password, resourceAccessor); + return database; + } catch (DatabaseException e) { + throw new TopiaException("cannot get database for migration connection", e); + } + } + + @Override + public void postInit(TopiaApplicationContext context) { + + } +}