com.soebes.maven.plugins.multienv

Class AbstractMultiEnvMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.soebes.maven.plugins.multienv.AbstractMultiEnvMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

ConfigurationMojo, EnvironmentMojo

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

Author:

Karl-Heinz Marbaise khmarbaise@soebes.de

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.maven.shared.filtering.MavenResourcesFiltering	mavenResourcesFiltering

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractMultiEnvMojo()

Method Summary

Modifier and Type	Method and Description
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 outputDirectory)
org.apache.maven.archiver.MavenArchiveConfiguration	getArchive()
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.
LinkedHashSet<String>	getDelimiters()
String	getEncoding()
String	getEscapeString()
List<String>	getFilters()
String	getFinalName()
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()
protected String[]	getTheEnvironments(File resourceResult)
boolean	isEscapeWindowsPaths()
boolean	isFileNameFiltering()
boolean	isIncludeEmptyDirs()
boolean	isSupportMultiLineFiltering()
boolean	isUseDefaultDelimiters()
void	setIncludeEmptyDirs(boolean includeEmptyDirs)
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

mavenResourcesFiltering

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

Constructor Detail

AbstractMultiEnvMojo

public AbstractMultiEnvMojo()

Method Detail

getArchive

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

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

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()

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.MojoExecutionException - in case of failures.

org.apache.maven.plugin.MojoFailureException

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 outputDirectory)
                        throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

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.