org.kuali.maven.plugins.spring.LoadMojo Maven / Gradle / Ivy

Go to download
/**
 * Copyright 2011-2012 The Kuali Foundation
 *
 * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
 *
 * 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.kuali.maven.plugins.spring;

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

import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.project.MavenProject;
import org.kuali.common.util.CollectionUtils;
import org.kuali.common.util.PropertyUtils;
import org.kuali.common.util.property.Constants;
import org.kuali.common.util.property.GlobalPropertiesMode;
import org.kuali.common.util.service.SpringService;
import org.kuali.common.util.spring.SpringContext;
import org.springframework.util.PropertyPlaceholderHelper;

/**
 * Load a Spring context XML file optionally filtering it using Maven properties before doing so. If {@code exportProperties} is true, Maven
 * properties are exported to the file system prior to loading and filtering the Spring context. The path to the exported properties file is
 * automatically added to the Maven properties under the key {@code maven.spring.properties}. This combination allows the injection of Maven
 * properties into a Spring context by setting {@code filterContext=true} in the Maven pom and adding one line to the Spring XML
 * configuration file:

 *
 *  * <context:property-placeholder location="${maven.spring.properties}" />
 * OR
 * <util:properties id="mavenProperties" location="${maven.spring.properties}" />
 * 
 *
 * @goal load
 */
public class LoadMojo extends AbstractMojo implements SpringContext {

	/**
	 * Maven project
	 *
	 * @parameter default-value="${project}"
	 * @required
	 * @readonly
	 */
	private MavenProject project;

	/**
	 * Character encoding for the context XML file
	 *
	 * @parameter expression="${spring.encoding}" default-value="${project.build.sourceEncoding}"
	 */
	private String encoding;

	/**
	 * Location of a Spring context XML file. This can be any URL Spring's Resource loading framework understands eg
	 * {@code classpath:mycontext.xml}
	 *
	 * @parameter expression="${spring.contextLocation}" default-value="classpath:${project.artifactId}-context.xml"
	 * @required
	 */
	private String contextLocation;

	/**
	 * Working directory for the plugin.
	 *
	 * @parameter expression="${spring.workingDir}" default-value="${project.build.directory}/spring"
	 */
	private File workingDir;

	/**
	 * If true {@code contextLocation} is filtered before being loaded
	 *
	 * @parameter expression="${spring.filterContext}" default-value="false"
	 */
	private boolean filterContext;

	/**
	 * List of properties to include. All properties are included by default.
	 *
	 * @parameter
	 */
	private List exportIncludes;

	/**
	 * List of properties to exclude. No properties are excluded by default.
	 *
	 * @parameter
	 */
	private List exportExcludes;

	/**
	 * Comma separated list of properties to include in the export
	 *
	 * @parameter expression="${spring.exportInclude}"
	 */
	private String exportInclude;

	/**
	 * Comma separated list of properties to exclude from the export
	 *
	 * @parameter expression="${spring.exportExclude}"
	 */
	private String exportExclude;

	/**
	 * Comma separated list of properties to include when filtering the context
	 *
	 * @parameter expression="${spring.filterInclude}"
	 */
	private String filterInclude;

	/**
	 * Comma separated list of properties to exclude when filtering the context
	 *
	 * @parameter expression="${spring.filterExclude}"
	 */
	private String filterExclude;

	/**
	 * List of properties to include. All properties are included by default.
	 *
	 * @parameter
	 */
	private List filterIncludes;

	/**
	 * List of properties to exclude. No properties are excluded by default.
	 *
	 * @parameter
	 */
	private List filterExcludes;

	/**
	 * Additional properties supplied directly to the mojo
	 *
	 * @parameter
	 */
	private Properties properties;

	/**
	 * If true, Maven properties are exported to the file system prior to filtering and loading the Spring context.
	 *
	 * @parameter expression="${spring.exportProperties}" default-value="false"
	 */
	private boolean exportProperties;

	/**
	 * The file to export properties to when {@code exportProperties} is {@code true}
	 *
	 * @parameter expression="${spring.exportPropertiesFile}" default-value="${project.build.directory}/spring/maven.properties"
	 */
	private File exportPropertiesFile;

	/**
	 * If {@code exportProperties} is true, the path to the exported properties file will be included as a property under this key
	 *
	 * @parameter expression="${spring.exportPropertiesFileProperty}" default-value="maven.spring.properties"
	 */
	private String exportPropertiesFileProperty;

	/**
	 * The implementation of {@code org.kuali.common.util.service.SpringService} to use
	 *
	 * @parameter expression="${spring.serviceClassname}" default-value="org.kuali.common.util.service.DefaultSpringService"
	 * @required
	 */
	private String serviceClassname;

	// The Maven convention is for system properties and environment variables to override properties provided elsewhere
	// This default setting follows that convention
	GlobalPropertiesMode globalPropertiesMode = Constants.DEFAULT_GLOBAL_PROPERTIES_MODE;
	PropertyPlaceholderHelper helper = Constants.DEFAULT_PROPERTY_PLACEHOLDER_HELPER;

	@Override
	public void execute() throws MojoExecutionException {

		// The ordering here is significant.
		// Properties supplied directly to the mojo override properties from project.getProperties()
		// But, internal Maven properties need to always win.
		// We don't want to allow the overriding of properties Maven uses internally
		// ${project.artifactId} needs to always faithfully represent the correct artifactId
		this.properties = PropertyUtils.combine(project.getProperties(), properties, MavenUtils.getInternalProperties(project));

		// Merge CSV values with explicitly provided lists
		this.filterIncludes = CollectionUtils.sortedMerge(filterIncludes, filterInclude);
		this.filterExcludes = CollectionUtils.sortedMerge(filterExcludes, filterExclude);
		this.exportIncludes = CollectionUtils.sortedMerge(exportIncludes, exportInclude);
		this.exportExcludes = CollectionUtils.sortedMerge(exportExcludes, exportExclude);

		try {
			Class serviceClass = Class.forName(serviceClassname);
			SpringService service = (SpringService) serviceClass.newInstance();
			service.load(this);
		} catch (Exception e) {
			throw new MojoExecutionException("Unexpected error", e);
		}
	}

	@Override
	public String getEncoding() {
		return encoding;
	}

	public void setEncoding(String encoding) {
		this.encoding = encoding;
	}

	@Override
	public String getContextLocation() {
		return contextLocation;
	}

	public void setContextLocation(String contextLocation) {
		this.contextLocation = contextLocation;
	}

	@Override
	public File getWorkingDir() {
		return workingDir;
	}

	public void setWorkingDir(File workingDir) {
		this.workingDir = workingDir;
	}

	@Override
	public boolean isFilterContext() {
		return filterContext;
	}

	public void setFilterContext(boolean filterContext) {
		this.filterContext = filterContext;
	}

	@Override
	public List getExportIncludes() {
		return exportIncludes;
	}

	public void setExportIncludes(List exportIncludes) {
		this.exportIncludes = exportIncludes;
	}

	@Override
	public List getExportExcludes() {
		return exportExcludes;
	}

	public void setExportExcludes(List exportExcludes) {
		this.exportExcludes = exportExcludes;
	}

	public String getExportInclude() {
		return exportInclude;
	}

	public void setExportInclude(String exportInclude) {
		this.exportInclude = exportInclude;
	}

	public String getExportExclude() {
		return exportExclude;
	}

	public void setExportExclude(String exportExclude) {
		this.exportExclude = exportExclude;
	}

	public String getFilterInclude() {
		return filterInclude;
	}

	public void setFilterInclude(String filterInclude) {
		this.filterInclude = filterInclude;
	}

	public String getFilterExclude() {
		return filterExclude;
	}

	public void setFilterExclude(String filterExclude) {
		this.filterExclude = filterExclude;
	}

	@Override
	public List getFilterIncludes() {
		return filterIncludes;
	}

	public void setFilterIncludes(List filterIncludes) {
		this.filterIncludes = filterIncludes;
	}

	@Override
	public List getFilterExcludes() {
		return filterExcludes;
	}

	public void setFilterExcludes(List filterExcludes) {
		this.filterExcludes = filterExcludes;
	}

	@Override
	public Properties getProperties() {
		return properties;
	}

	public void setProperties(Properties properties) {
		this.properties = properties;
	}

	@Override
	public boolean isExportProperties() {
		return exportProperties;
	}

	public void setExportProperties(boolean exportProperties) {
		this.exportProperties = exportProperties;
	}

	@Override
	public File getExportPropertiesFile() {
		return exportPropertiesFile;
	}

	public void setExportPropertiesFile(File exportPropertiesFile) {
		this.exportPropertiesFile = exportPropertiesFile;
	}

	@Override
	public String getExportPropertiesFileProperty() {
		return exportPropertiesFileProperty;
	}

	public void setExportPropertiesFileProperty(String exportPropertiesFileProperty) {
		this.exportPropertiesFileProperty = exportPropertiesFileProperty;
	}

	@Override
	public GlobalPropertiesMode getGlobalPropertiesMode() {
		return globalPropertiesMode;
	}

	public void setGlobalPropertiesMode(GlobalPropertiesMode globalPropertiesMode) {
		this.globalPropertiesMode = globalPropertiesMode;
	}

	@Override
	public PropertyPlaceholderHelper getHelper() {
		return helper;
	}

	public void setHelper(PropertyPlaceholderHelper helper) {
		this.helper = helper;
	}

	public String getServiceClassname() {
		return serviceClassname;
	}

	public void setServiceClassname(String serviceClassname) {
		this.serviceClassname = serviceClassname;
	}

}