org.alfresco.maven.plugin.amp.packaging
Interface AmpPackagingContext

public interface AmpPackagingContext

The packaging context of the AMP

Author:

Stephane Nicoll - Modified version for AMP

Method Summary

java.io.File	getAmpConfigDirectory() Returns the AMP classes + resources folder
java.io.File	getAmpDirectory() Returns the webapp directory.
java.lang.String[]	getAmpJarExcludes() Returns the webapp source excludes.
java.lang.String[]	getAmpJarIncludes() Returns the webapp source includes.
AmpStructure	getAmpStructure() Returns the AmpStructure.
java.io.File	getAmpWebDirectory() Returns the AMP web directory.
java.lang.String[]	getAmpWebExcludes() Returns the AMP web/ excludes.
java.lang.String[]	getAmpWebIncludes() Returns the AMP web/ includes.
org.apache.maven.archiver.MavenArchiveConfiguration	getArchive() The maven archive configuration to use.
org.codehaus.plexus.archiver.manager.ArchiverManager	getArchiverManager() Returns the archiver manager to use.
java.io.File	getClassesDirectory() Returns the directory holding generated classes to be packed in the jar - By default is the same of the AMP configuration
java.util.Map	getFilterProperties() Returns the filter properties to use to filter resources.
java.util.List	getFilters() Returns the list of filter files to use.
org.codehaus.plexus.archiver.jar.JarArchiver	getJarArchiver() Returns the Jar archiver needed for archiving classes directory into jar file under WEB-INF/lib.
org.apache.maven.plugin.logging.Log	getLog() Returns the logger to use to output logging event.
java.lang.String	getOutputFileNameMapping() Returns the output file name mapping to use, if any.
java.io.File	getOverlaysWorkDirectory() Returns the directory to unpack dependent WARs into if needed.
java.util.List	getOwnerIds() Returns the list of registered overlays for this session.
org.apache.maven.project.MavenProject	getProject() Returns the maven project.

Method Detail

getProject

org.apache.maven.project.MavenProject getProject()

Returns the maven project.

Returns:

the project

getAmpDirectory

java.io.File getAmpDirectory()

Returns the webapp directory. Packaging tasks should use this directory to generate the webapp.

Returns:

the webapp directory

getAmpConfigDirectory

java.io.File getAmpConfigDirectory()

Returns the AMP classes + resources folder

Returns:

the webapp source directory

getAmpWebDirectory

java.io.File getAmpWebDirectory()

Returns the AMP web directory.

Returns:

the webapp source directory

getAmpJarIncludes

java.lang.String[] getAmpJarIncludes()

Returns the webapp source includes.

Returns:

the webapp source includes

getAmpJarExcludes

java.lang.String[] getAmpJarExcludes()

Returns the webapp source excludes.

Returns:

the webapp source excludes

getAmpWebIncludes

java.lang.String[] getAmpWebIncludes()

Returns the AMP web/ includes.

Returns:

the AMP web/ includes

getAmpWebExcludes

java.lang.String[] getAmpWebExcludes()

Returns the AMP web/ excludes.

Returns:

the AMP web/ excludes

getClassesDirectory

java.io.File getClassesDirectory()

Returns the directory holding generated classes to be packed in the jar - By default is the same of the AMP configuration

Returns:

the classes directory

getLog

org.apache.maven.plugin.logging.Log getLog()

Returns the logger to use to output logging event.

Returns:

the logger

getOverlaysWorkDirectory

java.io.File getOverlaysWorkDirectory()

Returns the directory to unpack dependent WARs into if needed.

Returns:

the overlays work directory

getArchiverManager

org.codehaus.plexus.archiver.manager.ArchiverManager getArchiverManager()

Returns the archiver manager to use.

Returns:

the archiver manager

getArchive

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

The maven archive configuration to use.

Returns:

the maven archive configuration

getJarArchiver

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

Returns the Jar archiver needed for archiving classes directory into jar file under WEB-INF/lib.

Returns:

the jar archiver to user

getOutputFileNameMapping

java.lang.String getOutputFileNameMapping()

Returns the output file name mapping to use, if any. Returns null if no file name mapping is set.

Returns:

the output file name mapping or null

getFilters

java.util.List getFilters()

Returns the list of filter files to use.

Returns:

a list of filter files

getFilterProperties

java.util.Map getFilterProperties()
                                  throws org.apache.maven.plugin.MojoExecutionException

Returns the filter properties to use to filter resources.

TODO: this needs to be refactored to use the resource plugin somehow.

Returns:

a map of filter properties

Throws:

org.apache.maven.plugin.MojoExecutionException - if an error occured while reading a filter file

getAmpStructure

AmpStructure getAmpStructure()

Returns the AmpStructure.

Returns:

the webapp structure

getOwnerIds

java.util.List getOwnerIds()

Returns the list of registered overlays for this session. This list might differ from the one returned by the cache; in this case, it means that the project's configuration has changed. The plugin will handle thos cases nicely but it would be better in general to invoke the clean goal.

Returns:

the list of registered overlays, including the current project