net.officefloor.maven.RunWoofGoal Maven / Gradle / Ivy

Go to download
/*
 * OfficeFloor - http://www.officefloor.net
 * Copyright (C) 2005-2013 Daniel Sagenschneider
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package net.officefloor.maven;

import java.io.File;
import java.util.List;

import net.officefloor.autowire.impl.AutoWirePropertiesImpl;
import net.officefloor.building.manager.OfficeBuildingManager;
import net.officefloor.frame.api.manage.OfficeFloor;
import net.officefloor.plugin.war.WarOfficeFloorDecorator;
import net.officefloor.plugin.woof.WoofOfficeFloorSource;

import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.repository.ArtifactRepository;
import org.apache.maven.model.Build;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;
import org.apache.maven.project.MavenProject;
import org.codehaus.plexus.PlexusContainer;
import org.eclipse.aether.RepositorySystem;

/**
 * Maven goal to run the {@link WoofOfficeFloorSource}.
 * 
 * @author Daniel Sagenschneider
 */
@Mojo(name = "run", requiresDependencyResolution = ResolutionScope.COMPILE)
public class RunWoofGoal extends AbstractMojo {

	/**
	 * {@link MavenProject}.
	 */
	@Parameter(defaultValue = "${project}", required = true)
	private MavenProject project;

	/**
	 * {@link PlexusContainer}.
	 */
	@Component
	private PlexusContainer plexusContainer;

	/**
	 * {@link RepositorySystem}.
	 */
	@Component
	private RepositorySystem repositorySystem;

	/**
	 * Plug-in dependencies.
	 */
	@Parameter(defaultValue = "${plugin.artifacts}", required = true)
	private List pluginDependencies;

	/**
	 * Local repository.
	 */
	@Parameter(defaultValue = "${localRepository}", required = true)
	private ArtifactRepository localRepository;

	/**
	 * Path to the {@link OfficeFloor} configuration.
	 */
	@Parameter(property = "officeFloorLocation")
	private String officeFloorLocation = "WoOF";

	/**
	 * Flag indicating whether to include GWT functionality. By default it is
	 * included, however ability to turn off for faster load time.
	 */
	@Parameter(property = "includeGWT")
	private String includeGWT = String.valueOf(Boolean.TRUE);

	/**
	 * Path to directory containing the environment properties files.
	 */
	@Parameter(property = "envDir")
	private String envDir;

	/*
	 * ======================= Mojo =========================
	 */

	@Override
	public void execute() throws MojoExecutionException, MojoFailureException {

		// Determine if OfficeBuilding is running
		if (OfficeBuildingManager
				.isOfficeBuildingAvailable(null,
						StartOfficeBuildingGoal.DEFAULT_OFFICE_BUILDING_PORT
								.intValue(), StartOfficeBuildingGoal
								.getKeyStoreFile(),
						StartOfficeBuildingGoal.KEY_STORE_PASSWORD,
						StartOfficeBuildingGoal.USER_NAME,
						StartOfficeBuildingGoal.PASSWORD)) {

			// OfficeBuilding running, so shutdown (allow clean start)
			StopOfficeBuildingGoal.createStopOfficeBuildingGoal(
					StartOfficeBuildingGoal.DEFAULT_OFFICE_BUILDING_PORT, null,
					this.getLog()).execute();
		}

		// Create goal to start the OfficeBuilding
		StartOfficeBuildingGoal startGoal = StartOfficeBuildingGoal
				.createStartOfficeBuildingGoal(this.project,
						this.pluginDependencies, this.localRepository,
						this.repositorySystem, this.plexusContainer,
						this.getLog());

		// Include officeplugin_war on class path (handle WoOF resources)
		startGoal.includePluginDependencyToOfficeBuildingClassPath(
				WarOfficeFloorDecorator.PLUGIN_WAR_GROUP_ID,
				WarOfficeFloorDecorator.PLUGIN_WAR_ARTIFACT_ID, "jar", null);

		// Start the OfficeBuilding
		startGoal.execute();

		// Create the open goal and configure for WoOF
		OpenOfficeFloorGoal openGoal = OpenOfficeFloorGoal
				.createOfficeFloorGoal("woof-maven-plugin", this.project,
						this.pluginDependencies, this.officeFloorLocation,
						this.getLog());
		openGoal.setOfficeFloorSource(WoofOfficeFloorSource.class.getName());

		/*
		 * Include the web app directory as class path entry so that may run
		 * without requiring packaging.
		 */
		File baseDir = this.project.getBasedir();
		File webAppDir = new File(baseDir, "src/main/webapp");
		openGoal.addClassPathEntry(webAppDir.getAbsolutePath());

		/*
		 * Include resulting pre-WAR directory. This allows inclusion of GWT
		 * generated content.
		 */
		if (Boolean.parseBoolean(this.includeGWT)) {
			Build build = this.project.getBuild();
			String assemblePath = build.getDirectory() + "/"
					+ build.getFinalName();
			File assembleDir = new File(assemblePath);
			if (!(assembleDir.exists())) {
				this.getLog()
						.warn("No GWT functionality will be available.  Please package project to create content in "
								+ assembleDir.getAbsolutePath());
			}
			try {
				File assembleContent = WarOfficeFloorDecorator
						.generateJarMinusMetaAndWebInf(assembleDir);
				if (assembleContent == null) {
					this.getLog()
							.warn("No GWT functionality will be available.  Packaged content is not in a WAR structure");

				} else {
					// Include the assemble content (GWT content)
					openGoal.addClassPathEntry(assembleContent
							.getAbsolutePath());
				}
			} catch (Exception ex) {
				this.getLog()
						.warn("No GWT functionality will be available.  Failed to generate package JAR content",
								ex);
			}
		}

		// Provide the environment properties directory (if provided)
		if (this.envDir != null) {
			openGoal.setJvmOptions("-D"
					+ AutoWirePropertiesImpl.ENVIRONMENT_PROPERTIES_DIRECTORY
					+ "=" + this.envDir);
		}

		// Indicate WoOF application running
		this.getLog().info("Starting WoOF application");

		// Open the WoOF
		openGoal.execute();

		// Indicate WoOF application running
		this.getLog().info("WoOF application running");
	}

}