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: AbstractScriptGeneratorMojo.java 18832 2013-10-29 20:09:27Z krosenvold $

Author:

Dennis Lundberg

Field Summary

Fields

Modifier and Type	Field and Description
protected List	artifacts
protected DaemonGeneratorService	daemonGeneratorService
protected String	environmentSetupFileName Setup file in $BASEDIR/bin to be called prior to execution.
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 org.apache.maven.project.MavenProject	mavenProject
protected String	unixScriptTemplate The unix template of the generated script.
protected String	windowsScriptTemplate The windows template of the generated script.

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

artifactRepositoryFactory, container, endorsedDir, 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	installDependencies(String outputDirectory, String repositoryName)
boolean	isGenerateRepository() Should we generate repository or not.
boolean	isUseWildcardClassPath() Should the /* part for the classpath be used or not.
void	setGenerateRepository(boolean generateRepository) Should we generate repository or not.
void	setUseWildcardClassPath(boolean useWildcardClassPath) Use wildcard classpath or not.

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

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

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

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 case since it is not guaranteed to be compatible with new plugin release.

Since:

1.3

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

protected List artifacts

mavenProject

protected org.apache.maven.project.MavenProject mavenProject

generateRepository

protected boolean generateRepository

Set to false to skip repository generation.

daemonGeneratorService

protected DaemonGeneratorService daemonGeneratorService

Constructor Detail

AbstractScriptGeneratorMojo

public AbstractScriptGeneratorMojo()

Method Detail

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

isUseWildcardClassPath

public boolean isUseWildcardClassPath()

Should the /* part for the classpath be used or not.

Returns:

true if the wild card class path will be used false otherwise.

setUseWildcardClassPath

public void setUseWildcardClassPath(boolean useWildcardClassPath)

Use wildcard classpath or not.

Parameters:

useWildcardClassPath - true to use wildcard classpath false otherwise.

isGenerateRepository

public boolean isGenerateRepository()

Should we generate repository or not.

Returns:

true if we need to generate repository, false otherwise.

setGenerateRepository

public void setGenerateRepository(boolean generateRepository)

Should we generate repository or not.

Parameters:

generateRepository - true to generate repository, false otherwise.