com.foreach.across.modules.hibernate.installers.AuditableSchemaInstaller Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of across-hibernate-module Show documentation
Across Hibernate Module
There is a newer version: 6.0.0
Show newest version
/*
 * Copyright 2014 the original author or authors
 *
 * 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 com.foreach.across.modules.hibernate.installers;

import com.foreach.across.core.AcrossContext;
import com.foreach.across.core.annotations.InstallerGroup;
import com.foreach.across.core.annotations.InstallerMethod;
import com.foreach.across.core.context.AcrossContextUtils;
import com.foreach.across.core.context.info.AcrossContextInfo;
import com.foreach.across.core.database.SchemaConfiguration;
import com.foreach.across.core.installers.AcrossLiquibaseInstaller;
import liquibase.integration.spring.SpringLiquibase;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.beans.factory.config.AutowireCapableBeanFactory;

import javax.sql.DataSource;
import java.util.Collection;
import java.util.Collections;

/**
 * 
 * Convenience installer that creates the necessary columns for the default implementation
 * of the {@link com.foreach.across.modules.hibernate.business.Auditable} interface.
 * Supports multiple table names and will add the auditable columns to each of those tables.
 * 
 *
 * @author Andy Somers, Arne Vandamme
 * @see AcrossLiquibaseInstaller
 * @see com.foreach.across.modules.hibernate.business.AuditableEntity
 */
@InstallerGroup(InstallerGroup.SCHEMA)
public abstract class AuditableSchemaInstaller
{
	private static final String CHANGELOG =
			"classpath:com/foreach/across/modules/hibernate/installers/AuditableSchemaInstaller.xml";

	private static final Logger LOG = LoggerFactory.getLogger( AuditableSchemaInstaller.class );

	@Autowired
	private AcrossContextInfo acrossContext;

	@Autowired
	@Qualifier(AcrossContext.INSTALLER_DATASOURCE)
	private DataSource dataSource;

	private SchemaConfiguration schemaConfiguration;

	public AuditableSchemaInstaller() {
	}

	protected AuditableSchemaInstaller( SchemaConfiguration schemaConfiguration ) {
		this.schemaConfiguration = schemaConfiguration;
	}

	protected abstract Collection getTableNames();

	protected SchemaConfiguration getSchemaConfiguration() {
		return schemaConfiguration;
	}

	protected void setSchemaConfiguration( SchemaConfiguration schemaConfiguration ) {
		this.schemaConfiguration = schemaConfiguration;
	}

	protected DataSource getDataSource() {
		return dataSource;
	}

	/**
	 * Override the dataSource this installer should use (defaults to the installer datasource otherwise).
	 *
	 * @param dataSource instance
	 */
	protected void setDataSource( DataSource dataSource ) {
		this.dataSource = dataSource;
	}

	@InstallerMethod
	public void install() {
		AutowireCapableBeanFactory beanFactory = AcrossContextUtils.getBeanFactory( acrossContext.getContext() );

		for ( String tableName : getTableNames() ) {
			String tableNameToUse = schemaConfiguration != null
					? schemaConfiguration.getCurrentTableName( tableName ) : tableName;

			SpringLiquibase liquibase = new SpringLiquibase();
			liquibase.setChangeLog( CHANGELOG );
			liquibase.setDataSource( dataSource );
			liquibase.setChangeLogParameters( Collections.singletonMap( "table.auditable_table", tableNameToUse ) );

			LOG.debug( "Installing auditable columns for table {}", tableNameToUse );

			beanFactory.autowireBeanProperties( liquibase, AutowireCapableBeanFactory.AUTOWIRE_NO, false );
			beanFactory.initializeBean( liquibase, "" );
		}
	}
}