net.sf.environments

Class AbstractEnvironmentsMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

net.sf.environments.AbstractEnvironmentsMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

ConfigurationMojo, EnvironmentMojo

public abstract class AbstractEnvironmentsMojo
extends org.apache.maven.plugin.AbstractMojo

Author:

Karl-Heinz Marbaise khmarbaise@soebes.de

Field Summary

Fields

Modifier and Type	Field and Description
protected String	excludeEnvironments Comma separated list of names of environments.
protected org.apache.maven.shared.filtering.MavenResourcesFiltering	mavenResourcesFiltering

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractEnvironmentsMojo()

Method Summary

Modifier and Type	Method and Description
protected org.apache.maven.archiver.MavenArchiveConfiguration	addEnvironmentToManifest(org.apache.maven.archiver.MavenArchiveConfiguration archive, String environment)
protected File	createArchiveFile(File unpackDirectory, File targetDirectory, String directory, String archiveExt)
protected void	createLoggingOutput(String[] identifiedEnvironments)
protected File	createPluginResourceOutput()
protected File	createUnpackDirectory() Create the unpack directory for later unpacking of the main artifact.
protected void	deleteDirectoryOfPreviousRunIfExist(File directoryOfPreviousRun)
protected List<String>	environmentNamesAreValid(String[] environmens) This will check if an environment (directory) contains a space cause the environment will later being used as a classifier which does not allow a space.
protected void	filterResources(File outputDir, String environment, boolean singleEnvironment, boolean ignoreTargetPath)
protected void	filterResourcesToAdditionalDirectories(String[] identifiedEnvironments)
protected void	filterResourcesToTarget(String[] identifiedEnvironments)
org.apache.maven.archiver.MavenArchiveConfiguration	getArchive(String environment)
protected String	getArchiveExtensionOfTheArtifact(org.apache.maven.artifact.Artifact artifact)
protected String	getArchiveExtensionOfTheProjectMainArtifact()
protected File	getArchiveFile(File basedir, String finalName, String classifier, String archiveExt) Returns the archive file to generate, based on an optional classifier.
List<EnvironmentArchiveConfiguration>	getArchives()
protected String	getCommonDir()
LinkedHashSet<String>	getDelimiters()
String	getEncoding()
String	getEscapeString()
String	getExcludeEnvironments()
List<String>	getFilters()
String	getFinalName()
protected abstract org.codehaus.plexus.archiver.jar.JarArchiver	getJarArchiver()
org.apache.maven.project.MavenProject	getMavenProject()
org.apache.maven.execution.MavenSession	getMavenSession()
List<String>	getNonFilteredFileExtensions()
File	getOutputDirectory()
org.apache.maven.project.MavenProjectHelper	getProjectHelper()
File	getSourceDirectory()
String	getTargetPath()
protected String	getTargetPath(boolean singleEnvironment, String environment)
protected String[]	getTheEnvironments(File resourceResult)
boolean	isEscapeWindowsPaths()
boolean	isFileNameFiltering()
boolean	isIncludeEmptyDirs()
boolean	isSupportMultiLineFiltering()
boolean	isUseDefaultDelimiters()
void	setExcludeEnvironments(String excludeEnvironments)
void	setIncludeEmptyDirs(boolean includeEmptyDirs)
protected boolean	shouldSkip(String environment) Returns true if this directory in src/main/environments doesn't represent an environment.
protected void	validateEnvironments(String[] identifiedEnvironments) This will validate the environments and will fail the build in case of errors.

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.maven.plugin.Mojo

execute

Field Detail

excludeEnvironments

@Parameter(defaultValue="",
           name="excludeEnvironments",
           required=false)
protected String excludeEnvironments

Comma separated list of names of environments.

mavenResourcesFiltering

@Component(role=org.apache.maven.shared.filtering.MavenResourcesFiltering.class,
           hint="default")
protected org.apache.maven.shared.filtering.MavenResourcesFiltering mavenResourcesFiltering

Constructor Detail

AbstractEnvironmentsMojo

public AbstractEnvironmentsMojo()

Method Detail

getArchives

public List<EnvironmentArchiveConfiguration> getArchives()

getArchive

public org.apache.maven.archiver.MavenArchiveConfiguration getArchive(String environment)

addEnvironmentToManifest

protected org.apache.maven.archiver.MavenArchiveConfiguration addEnvironmentToManifest(org.apache.maven.archiver.MavenArchiveConfiguration archive,
                                                                                       String environment)

getMavenProject

public org.apache.maven.project.MavenProject getMavenProject()

getMavenSession

public org.apache.maven.execution.MavenSession getMavenSession()

getOutputDirectory

public File getOutputDirectory()

getProjectHelper

public org.apache.maven.project.MavenProjectHelper getProjectHelper()

getSourceDirectory

public File getSourceDirectory()

getFinalName

public String getFinalName()

getEncoding

public String getEncoding()

getTheEnvironments

protected String[] getTheEnvironments(File resourceResult)

Parameters:

resourceResult - The directory where to search for different environments.

Returns:

The list of identified environments. This list is converted to lower case.

environmentNamesAreValid

protected List<String> environmentNamesAreValid(String[] environmens)

This will check if an environment (directory) contains a space cause the environment will later being used as a classifier which does not allow a space.

Parameters:

environmens - The environments which should be checked.

Returns:

The list contains the invalid environments. If the list is empty all environments are ok.

getArchiveFile

protected File getArchiveFile(File basedir,
                              String finalName,
                              String classifier,
                              String archiveExt)

Returns the archive file to generate, based on an optional classifier.

Parameters:

basedir - the output directory

finalName - the name of the ear file

classifier - an optional classifier

archiveExt - Archive Extension

Returns:

the file to generate

getEscapeString

public String getEscapeString()

isEscapeWindowsPaths

public boolean isEscapeWindowsPaths()

getFilters

public List<String> getFilters()

isFileNameFiltering

public boolean isFileNameFiltering()

getDelimiters

public LinkedHashSet<String> getDelimiters()

isUseDefaultDelimiters

public boolean isUseDefaultDelimiters()

getNonFilteredFileExtensions

public List<String> getNonFilteredFileExtensions()

isSupportMultiLineFiltering

public boolean isSupportMultiLineFiltering()

getExcludeEnvironments

public String getExcludeEnvironments()

setExcludeEnvironments

public void setExcludeEnvironments(String excludeEnvironments)

deleteDirectoryOfPreviousRunIfExist

protected void deleteDirectoryOfPreviousRunIfExist(File directoryOfPreviousRun)
                                            throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

createUnpackDirectory

protected File createUnpackDirectory()
                              throws org.apache.maven.plugin.MojoFailureException,
                                     org.apache.maven.plugin.MojoExecutionException

Create the unpack directory for later unpacking of the main artifact.

Returns:

The directory which has been created.

Throws:

org.apache.maven.plugin.MojoFailureException - in case of failures.

org.apache.maven.plugin.MojoExecutionException - in case of failures.

getArchiveExtensionOfTheProjectMainArtifact

protected String getArchiveExtensionOfTheProjectMainArtifact()
                                                      throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getArchiveExtensionOfTheArtifact

protected String getArchiveExtensionOfTheArtifact(org.apache.maven.artifact.Artifact artifact)
                                           throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

createPluginResourceOutput

protected File createPluginResourceOutput()
                                   throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

isIncludeEmptyDirs

public boolean isIncludeEmptyDirs()

setIncludeEmptyDirs

public void setIncludeEmptyDirs(boolean includeEmptyDirs)

filterResources

protected void filterResources(File outputDir,
                               String environment,
                               boolean singleEnvironment,
                               boolean ignoreTargetPath)
                        throws org.apache.maven.plugin.MojoExecutionException

Parameters:

outputDir - Output Directory where the resources need to be copied.

environment - absolute path of the environment directory.

singleEnvironment - boolean that specifies the user specified em.env command line switch.

Throws:

org.apache.maven.plugin.MojoExecutionException - in case of failures.

filterResourcesToTarget

protected void filterResourcesToTarget(String[] identifiedEnvironments)
                                throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

filterResourcesToAdditionalDirectories

protected void filterResourcesToAdditionalDirectories(String[] identifiedEnvironments)
                                               throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getTargetPath

protected String getTargetPath(boolean singleEnvironment,
                               String environment)

shouldSkip

protected boolean shouldSkip(String environment)

Returns true if this directory in src/main/environments doesn't represent an environment. The following directories are excluded - Comma separated list of directory names enclosed within excludeEnvironments tags in plugin configuration. - Directory name enclosed in common tag in plugin configuration.

Parameters:

environment - name of the environment.

Returns:

boolean indicating whether the specified environment should be skipped.

createLoggingOutput

protected void createLoggingOutput(String[] identifiedEnvironments)

validateEnvironments

protected void validateEnvironments(String[] identifiedEnvironments)
                             throws org.apache.maven.plugin.MojoFailureException

This will validate the environments and will fail the build in case of errors.

Parameters:

identifiedEnvironments - The environments which will be checked.

Throws:

org.apache.maven.plugin.MojoFailureException - in case of invalid environments.

createArchiveFile

protected File createArchiveFile(File unpackDirectory,
                                 File targetDirectory,
                                 String directory,
                                 String archiveExt)
                          throws org.codehaus.plexus.archiver.manager.NoSuchArchiverException,
                                 IOException,
                                 org.apache.maven.plugin.MojoExecutionException

Throws:

org.codehaus.plexus.archiver.manager.NoSuchArchiverException

IOException

org.apache.maven.plugin.MojoExecutionException

getCommonDir

protected String getCommonDir()

getTargetPath

public String getTargetPath()

getJarArchiver

protected abstract org.codehaus.plexus.archiver.jar.JarArchiver getJarArchiver()