org.codehaus.mojo.appassembler

Class AssembleMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.appassembler.AbstractAppAssemblerMojo

org.codehaus.mojo.appassembler.AbstractScriptGeneratorMojo

org.codehaus.mojo.appassembler.AssembleMojo

All Implemented Interfaces:

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

public class AssembleMojo
extends AbstractScriptGeneratorMojo

Assembles the artifacts and generates bin scripts for the configured applications

Version:

$Id: AssembleMojo.java 18843 2013-10-31 02:22:20Z dantran $

Author:

Kristian Nordal

Field Summary

Fields

Modifier and Type	Field and Description
protected Map	binFileExtensions The file extensions to use for bin files.

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

artifacts, daemonGeneratorService, environmentSetupFileName, generateRepository, licenseHeaderFile, mavenProject, unixScriptTemplate, windowsScriptTemplate

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

Method Summary

Methods

Modifier and Type	Method and Description
void	checkDeprecatedParameterAndFailIfOneOfThemIsUsed()
void	execute() calling from Maven.
boolean	isProjectArtifactFirstInClassPath() Be the project the first artifact in classpath or not.
boolean	isUseAllDependencies() Deprecated. use isUseAllProjectDependencies() instead.
boolean	isUseAllProjectDependencies() Should all project dependencies be used incl.
boolean	isUseAsterikClassPath() Deprecated. use AbstractScriptGeneratorMojo.isUseWildcardClassPath() instead.
static List	parseTokens(String arg) This will tokenize the given argument or give the extraJvmArguments back if the given argument is empty.
void	setProjectArtifactFirstInClassPath(boolean projectArtifactFirstInClassPath) Set if the project should be the artifact at first position or not.
void	setUseAllDependencies(boolean useAllDependencies) Deprecated. use setUseAllProjectDependencies(boolean) instead.
void	setUseAllProjectDependencies(boolean useAllProjectDependencies) Define if all project dependencies should be used or not.
void	setUseAsterikClassPath(boolean useAsterikClassPath) Deprecated. use AbstractScriptGeneratorMojo.setUseWildcardClassPath(boolean) instead.

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

installDependencies, isGenerateRepository, isUseWildcardClassPath, setGenerateRepository, setUseWildcardClassPath

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

Field Detail

binFileExtensions

protected Map binFileExtensions

The file extensions to use for bin files. The file extensions are stored in a Map that uses the platform name as key. To change the file extension for Unix bin files to ".sh" use this configuration:

          <binFileExtensions>
            <unix>.sh</unix>
          </binFileExtensions>
 

Since:

1.1

Constructor Detail

AssembleMojo

public AssembleMojo()

Method Detail

checkDeprecatedParameterAndFailIfOneOfThemIsUsed

public void checkDeprecatedParameterAndFailIfOneOfThemIsUsed()
                                                      throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

calling from Maven.

Throws:

{@link - MojoExecutionException}

{@link - MojoFailureException}

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

See Also:

Mojo.execute()

parseTokens

public static List parseTokens(String arg)

This will tokenize the given argument or give the extraJvmArguments back if the given argument is empty.

Parameters:

arg - The argument to parse.

Returns:

List of arguments.

isProjectArtifactFirstInClassPath

public boolean isProjectArtifactFirstInClassPath()

Be the project the first artifact in classpath or not.

Returns:

true if the project should be the first artifact in classpath false otherwise.

setProjectArtifactFirstInClassPath

public void setProjectArtifactFirstInClassPath(boolean projectArtifactFirstInClassPath)

Set if the project should be the artifact at first position or not.

Parameters:

projectArtifactFirstInClassPath - true if the project artifact will be first false otherwise.

isUseAllDependencies

public boolean isUseAllDependencies()

Deprecated. use isUseAllProjectDependencies() instead.

Should all dependencies be used incl. system scoped.

Returns:

true if set to yes false otherwise.

setUseAllDependencies

public void setUseAllDependencies(boolean useAllDependencies)

Deprecated. use setUseAllProjectDependencies(boolean) instead.

Define if all dependencies should be used or not.

Parameters:

useAllDependencies - true to activate false otherwise.

isUseAllProjectDependencies

public boolean isUseAllProjectDependencies()

Should all project dependencies be used incl. system scoped.

Returns:

true if we will use all project dependencies false otherwise.

setUseAllProjectDependencies

public void setUseAllProjectDependencies(boolean useAllProjectDependencies)

Define if all project dependencies should be used or not.

Parameters:

useAllProjectDependencies - true to activate false otherwise.

isUseAsterikClassPath

public boolean isUseAsterikClassPath()

Deprecated. use AbstractScriptGeneratorMojo.isUseWildcardClassPath() instead.

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

Returns:

true if the asterik-classpath will be used false otherwise.

setUseAsterikClassPath

public void setUseAsterikClassPath(boolean useAsterikClassPath)

Deprecated. use AbstractScriptGeneratorMojo.setUseWildcardClassPath(boolean) instead.

Use asterik-classpath or not.

Parameters:

useAsterikClassPath - true to use asterik classpath false otherwise.