com.marvelution.maven.components.migration.manager.phases.CheckPreparationCompletionPhase Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of maven-migration-manager Show documentation

Maven 2.x Plexus Migration Manager Component used by the maven-migrator-plugin

The newest version!

/*
 * Licensed to Marvelution under one or more contributor license 
 * agreements.  See the NOTICE file distributed with this work 
 * for additional information regarding copyright ownership.
 * Marvelution licenses this file to you 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.marvelution.maven.components.migration.manager.phases;

import com.marvelution.maven.components.migration.manager.MigrationResult;
import com.marvelution.maven.components.migration.manager.configuration.MigrationDescriptor;
import com.marvelution.maven.components.migration.manager.environment.MigrationEnvironment;
import com.marvelution.maven.components.migration.manager.exception.MigrationExecutionException;
import com.marvelution.maven.components.migration.manager.exception.MigrationFailureException;
import com.marvelution.utils.StringUtils;

/**
 * {@link MigrationPhase} to check that preparation is completed
 * 
 * @author Mark Rekveld
 */
public class CheckPreparationCompletionPhase extends AbstractMigrationPhase {

	/**
	 * The end-migration phase role name
	 */
	private String endPreparationPhase;

	/**
	 * Gets the migration phase name that ends the preparation goal
	 * 
	 * @return the name of the last preparation goal phase
	 */
	public String getEndPreparationPhase() {
		return endPreparationPhase;
	}

	/**
	 * Sets the migration phase name that ends the preparation goal
	 * 
	 * @param endPreparationPhase the name of the last preparation goal phase
	 */
	public void setEndPreparationPhase(String endPreparationPhase) {
		this.endPreparationPhase = endPreparationPhase;
	}

	/**
	 * {@inheritDoc}
	 */
	public MigrationResult execute(final MigrationDescriptor descriptor, final MigrationEnvironment environment)
					throws MigrationExecutionException, MigrationFailureException {
		final MigrationResult result = new MigrationResult();
		if (StringUtils.isEmpty(descriptor.getCompletedPhase())
			&& !endPreparationPhase.equals(descriptor.getCompletedPhase())) {
			final StringBuffer stringBuffer = new StringBuffer();
			StringUtils.append(stringBuffer, "Cannot perform migration - the preparation steps where not completed.",
				0);
			StringUtils.append(stringBuffer, "Please re-run migrator:prepare", 1);
			getLogger().error(stringBuffer.toString());
			throw new MigrationFailureException(stringBuffer.toString());
		}
		result.setResultCode(MigrationResult.SUCCESS);
		return result;
	}

}