org.codehaus.mojo.appassembler

Class AbstractScriptGeneratorMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.appassembler.AbstractAppAssemblerMojo

org.codehaus.mojo.appassembler.AbstractScriptGeneratorMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

Direct Known Subclasses:

AssembleMojo, GenerateDaemonsMojo

public abstract class AbstractScriptGeneratorMojo
extends AbstractAppAssemblerMojo

This is intended to collect all generic parts of the script generating Mojos assemble and generate-daemons into a single class. A first step of hopefully merging the two into one some day.

Version:

$Id$

Author:

Dennis Lundberg

Field Summary

Fields

Modifier and Type	Field and Description
protected List<org.apache.maven.artifact.Artifact>	artifacts
protected List<String>	buildFilters Project build filters.
protected String	configurationDirectory The name of the target directory for configuration files.
protected File	configurationSourceDirectory The source directory for configuration files.
protected boolean	copyConfigurationDirectory If the source configuration directory should be copied to the configured configurationDirectory.
protected DaemonGeneratorService	daemonGeneratorService
protected String	encoding The character encoding scheme to be applied when filtering the source configuration directory.
protected String	endorsedDir Location under base directory where all of files non-recursively are added before the generated classpath.
protected String	environmentSetupFileName Setup file in $BASEDIR/bin to be called prior to execution.
protected String	escapeString Expressions preceded with this String won't be interpolated.
protected boolean	filterConfigurationDirectory If the source configuration directory should be filtered when copied to the configured configurationDirectory.
protected boolean	filterPreAssembleDirectory If the source pre-assemble directory should be filtered when copied to the configured assembleDirectory.
protected boolean	generateRepository Set to false to skip repository generation.
protected File	licenseHeaderFile You can define a license header file which will be used instead the default header in the generated scripts.
protected String	logsDirectory The logs directory for the assembled project.
protected org.apache.maven.project.MavenProject	mavenProject
protected org.apache.maven.shared.filtering.MavenResourcesFiltering	mavenResourcesFiltering The filtering component used when copying the source configuration directory.
protected File	preAssembleDirectory If exists, copy this directory's contents to the configured assembleDirectory with option to filter.
protected String	tempDirectory The temp directory of the assembled project.
protected String	unixScriptTemplate The unix template of the generated script.
protected boolean	useWildcardClassPath Sometimes it happens that you have many dependencies which means having a very long classpath, and becomes too long (in particular on Windows based platforms).
protected String	windowsScriptTemplate The windows template of the generated script.

Fields inherited from class org.codehaus.mojo.appassembler.AbstractAppAssemblerMojo

artifactRepositoryFactory, container, localRepository, outputFileNameMapping, projectArtifact, repositoryLayout, useTimestampInSnapshotFileName

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractScriptGeneratorMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doCopyConfigurationDirectory(String targetDirectory)
protected void	doCopyPreAssembleDirectory(String targetDirectory)
protected void	doCreateExtraDirectories(File targetDirectory)
protected void	installDependencies(String outputDirectory, String repositoryName)

Methods inherited from class org.codehaus.mojo.appassembler.AbstractAppAssemblerMojo

contextualize, getArtifactRepositoryLayout, installArtifact, installArtifact

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

environmentSetupFileName

@Parameter
protected String environmentSetupFileName

Setup file in $BASEDIR/bin to be called prior to execution.

Note: only for the jsw platform. If this optional environment file also sets up WRAPPER_CONF_OVERRIDES variable, it will be passed into JSW native launcher's command line arguments to override wrapper.conf's properties. See http://wrapper.tanukisoftware.com/doc/english/props-command-line.html for details.

Since:

1.2.3 (generate-daemons)

licenseHeaderFile

@Parameter
protected File licenseHeaderFile

You can define a license header file which will be used instead the default header in the generated scripts.

Since:

1.2

unixScriptTemplate

@Parameter(property="unixScriptTemplate")
protected String unixScriptTemplate

The unix template of the generated script. It can be a file or resource path. If not given, an internal one is used. Use with care since it is not guaranteed to be compatible with new plugin release.

Since:

1.3

useWildcardClassPath

@Parameter(defaultValue="false")
protected boolean useWildcardClassPath

Sometimes it happens that you have many dependencies which means having a very long classpath, and becomes too long (in particular on Windows based platforms). This option can help in such situation. If you activate this option, your classpath contains only a classpath wildcard (REPO/*). But be aware that this works only in combination with Java 1.6 and above and with AbstractAppAssemblerMojo.repositoryLayout flat.

Since:

1.2.3 (assemble), 1.3.1 (generate-daemons)

windowsScriptTemplate

@Parameter(property="windowsScriptTemplate")
protected String windowsScriptTemplate

The windows template of the generated script. It can be a file or resource path. If not given, an internal one is used. Use with care since it is not guaranteed to be compatible with new plugin release.

Since:

1.3

artifacts

@Parameter(defaultValue="${project.runtimeArtifacts}",
           readonly=true)
protected List<org.apache.maven.artifact.Artifact> artifacts

mavenProject

@Parameter(defaultValue="${project}",
           readonly=true,
           required=true)
protected org.apache.maven.project.MavenProject mavenProject

generateRepository

@Parameter(defaultValue="true")
protected boolean generateRepository

Set to false to skip repository generation.

configurationDirectory

@Parameter(defaultValue="etc")
protected String configurationDirectory

The name of the target directory for configuration files. Prior to version 1.7 this value defaults to 'conf' for assemble goal and 'etc' for generate-daemons

configurationSourceDirectory

@Parameter(defaultValue="src/main/config")
protected File configurationSourceDirectory

The source directory for configuration files.

Since:

1.1

filterConfigurationDirectory

@Parameter(defaultValue="false")
protected boolean filterConfigurationDirectory

If the source configuration directory should be filtered when copied to the configured configurationDirectory. This configuration can be replaced by a more generic preAssembleDirectory option

Since:

1.8

copyConfigurationDirectory

@Parameter(defaultValue="false")
protected boolean copyConfigurationDirectory

If the source configuration directory should be copied to the configured configurationDirectory.

Since:

1.1 (assemble), 1.7 (generate-daemons)

preAssembleDirectory

@Parameter
protected File preAssembleDirectory

If exists, copy this directory's contents to the configured assembleDirectory with option to filter. This configuration can replace copyConfigurationDirectory

Since:

1.10

filterPreAssembleDirectory

@Parameter(defaultValue="false")
protected boolean filterPreAssembleDirectory

If the source pre-assemble directory should be filtered when copied to the configured assembleDirectory.

Since:

1.10

endorsedDir

@Parameter
protected String endorsedDir

Location under base directory where all of files non-recursively are added before the generated classpath. Java 6+ only since it uses wildcard classpath format. This is a convenient way to have user to add artifacts that not possible to be part of final assembly such as LGPL/GPL artifacts

Since:

1.6

buildFilters

@Parameter(defaultValue="${project.build.filters}",
           readonly=true)
protected List<String> buildFilters

Project build filters.

Since:

1.8

encoding

@Parameter(defaultValue="${project.build.sourceEncoding}")
protected String encoding

The character encoding scheme to be applied when filtering the source configuration directory.

Since:

1.8

escapeString

@Parameter
protected String escapeString

Expressions preceded with this String won't be interpolated. \${foo} will be replaced with ${foo}.

Since:

1.8

logsDirectory

@Parameter(property="logsDirectory")
protected String logsDirectory

The logs directory for the assembled project. If you specify a value for this parameter an empty directory with the name given will be created.

Since:

1.8

tempDirectory

@Parameter(property="tempDirectory")
protected String tempDirectory

The temp directory of the assembled project. If you specify a value for this parameter an empty directory with the name given will be created.

Since:

1.8

daemonGeneratorService

@Component
protected DaemonGeneratorService daemonGeneratorService

mavenResourcesFiltering

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

The filtering component used when copying the source configuration directory.

Since:

1.8

Constructor Detail

AbstractScriptGeneratorMojo

public AbstractScriptGeneratorMojo()

Method Detail

doCopyConfigurationDirectory

protected void doCopyConfigurationDirectory(String targetDirectory)
                                     throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

doCopyPreAssembleDirectory

protected void doCopyPreAssembleDirectory(String targetDirectory)
                                   throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

doCreateExtraDirectories

protected void doCreateExtraDirectories(File targetDirectory)
                                 throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

installDependencies

protected void installDependencies(String outputDirectory,
                       String repositoryName)
                            throws org.apache.maven.plugin.MojoExecutionException,
                                   org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException