uk.org.retep.kernel.maven.AbstractKernelMojo Maven / Gradle / Ivy
/*
* Copyright (c) 1998-2010, Peter T Mount
* All rights reserved.
*
*
* 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
*
*
* GNU GENERAL PUBLIC LICENSE - CLASSPATH EXCEPTION
*
*
*
* Linking this library statically or dynamically with other modules
* is making a combined work based on this library. Thus, the terms
* and conditions of the GNU General Public License cover the whole
* combination.
*
*
*
* As a special exception, the copyright holders of this library give
* you permission to link this library with independent modules to
* produce an executable, regardless of the license terms of these
* independent modules, and to copy and distribute the resulting
* executable under terms of your choice, provided that you also meet,
* for each linked independent module, the terms and conditions of the
* license of that module.
*
*
*
* An independent module is a module which is either not derived from or based
* on this library, or a module who's classes extend those within this library
* as part of the implementation of the library.
*
*
*
* If you modify this library, you may extend this exception to your version
* of the library, but you are not obligated to do so. If you do not wish to
* do so, delete this exception statement from your version.
*
*/
package uk.org.retep.kernel.maven;
import java.io.File;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.project.MavenProject;
import uk.org.retep.util.maven.LoggingFacade;
/**
* Base class for all mojos. This class defines the parameters the plugin
* accepts and the logging bridge but no logic.
*
* @author peter
*/
public abstract class AbstractKernelMojo
extends AbstractMojo
{
/**
* Default location used for mojo unless overridden in ArtifactItem
*
* @parameter expression="${outputDirectory}"
* default-value="${project.build.directory}/${project.artifactId}-${project.version}"
* @optional
* @since 1.0
*/
protected File outputDirectory;
/**
* The application name being built
*
* @parameter expression="${applicationName}"
* default-value="${project.artifactId}"
* @optional
*/
protected String applicationName;
/**
* The layout of the application (determines the class loader style)
*
* @parameter expression="${applicationLayout}"
* default-value="standard"
* @optional
*/
protected String applicationLayout;
/**
* The source directory containing the configuration files
* @parameter expression="${configSource}"
* default-value="${basedir}/src/main/etc"
*/
protected File configSource;
/**
* The source directory containing the optional shell script files
* @parameter expression="${configscriptSourceSource}"
* default-value="${basedir}/src/main/scripts"
*/
protected File scriptSource;
/**
* The source directory containing the optional data files
* @parameter expression="${dataSource}"
* default-value="${basedir}/src/main/data"
*/
protected File dataSource;
/**
* When true log more
* @parameter expression="{verbose}"
* default-value="false"
*/
protected boolean verbose;
/**
* Default location used for mojo unless overridden in ArtifactItem
*
* @parameter expression="${artifactFile}"
* default-value="${project.build.directory}/${project.artifactId}-${project.version}.${project.packaging}"
* @optional
* @since 1.0
*/
protected File artifactFile;
/**
* POM
*
* @parameter expression="${project}"
* @readonly
* @required
*/
protected MavenProject project;
/**
* LoggingFacade allowing log4j and maven to interact
*/
private LoggingFacade logger;
protected final LoggingFacade getLogger()
{
if( logger == null )
{
logger = new LoggingFacade( getLog() );
}
return logger;
}
}