org.wso2.carbon.is.migration.VersionMigration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.wso2.carbon.is.migration Show documentation
There is a newer version: 5.9.0
Show newest version
/*
* Copyright (c) 2017, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
*
* 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.wso2.carbon.is.migration;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.wso2.carbon.identity.core.migrate.MigrationClientException;
import org.wso2.carbon.is.migration.config.Config;
import org.wso2.carbon.is.migration.config.MigratorConfig;
import org.wso2.carbon.is.migration.config.Version;
import org.wso2.carbon.is.migration.service.Migrator;
import org.wso2.carbon.is.migration.service.SchemaMigrator;
import org.wso2.carbon.is.migration.util.Constant;

import java.util.ArrayList;
import java.util.List;

/**
 * Abstract class for version migration.
 */
public abstract class VersionMigration {
    private static final Log log = LogFactory.getLog(VersionMigration.class);
    public void migrate() throws MigrationClientException {
        List migrators = getMigrators();
        for (Migrator migrator : migrators) {
            log.info(Constant.MIGRATION_LOG + "Version : " + getCurrentVersion() +", Migration Step : " +
                     migrator.getClass().getSimpleName() + " " + "starting........................... ");
            migrator.migrate();
        }
    }

    public List getMigrators() throws MigrationClientException {

        List migrators = new ArrayList<>();
        Version version = getMigrationConfig();
        List migratorConfigs = version.getMigratorConfigs();
        for (MigratorConfig migratorConfig : migratorConfigs) {
            String migratorName = migratorConfig.getName();
            Migrator migrator = null ;
            if(migratorName.equals(Constant.SCHEMA_MIGRATOR_NAME)){
                migrator = new SchemaMigrator() ;
            }else{
                migrator = getMigrator(migratorName) ;
            }
            migrator.setMigratorConfig(migratorConfig);
            migrator.setVersionConfig(version);
            migrators.add(migrator);
        }
        return migrators;
    }

    public abstract String getPreviousVersion();
    public abstract String getCurrentVersion();

    public Migrator getMigrator(String migratorName) {
        Package aPackage = this.getClass().getPackage();
        String basePackage = aPackage.getName() + ".migrator";
        try {
            Class migratorClass = Class.forName(basePackage + "." + migratorName);
            Migrator migrator = (Migrator)migratorClass.newInstance();
            return migrator ;
        } catch (ClassNotFoundException | InstantiationException | IllegalAccessException e) {
            log.error("Error while creating migration instance", e);
        }
        return null;
    }
    public Version getMigrationConfig() throws MigrationClientException {
        Config config = Config.getInstance();
        Version version = config.getMigrateVersion(getCurrentVersion());
        return version;
    }

}