org.devzendo.xplp

Class LauncherCreator

java.lang.Object

org.devzendo.xplp.LauncherCreator

Direct Known Subclasses:

MacOSXAppLauncherCreator, UnixScriptLauncherCreator, WindowsLauncherCreator

public abstract class LauncherCreator
extends Object

A LauncherCreator is given all the parameters, extracted from the plugin configuration, and creates an appropriate launcher filesystem structure under the output directory.

Author:

matt

Constructor Summary

Constructors

Constructor and Description
LauncherCreator(org.apache.maven.plugin.AbstractMojo mojo, File outputDirectory, String mainClassName, String applicationName, String libraryDirectory, Set<org.apache.maven.artifact.Artifact> transitiveArtifacts, Set<File> resourceDirectories, Properties parameterProperties, String[] systemProperties, String[] vmArguments, String[] narClassifierTypes)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	copyFile(File sourceFile, File destinationDirectory) Copy a file from its source to a destination directory.
protected void	copyInterpolatedPluginResource(String resourceName, File outputFile) Copy a plugin resource to a file, interpolating with the configuration properties
protected void	copyInterpolatedProjectResource(String resourceName, File outputFile) Copy a user project resource to a file, interpolating with the configuration properties
protected void	copyPluginResource(String resourceName, File destinationFile) Copy a resource from the plugin's resources to a file.
protected void	copyProjectResource(String resourceName, File destinationFile) Copy a resource from the user project to a file
protected void	copyTransitiveArtifacts(File destinationDirectory) Copy all compile-scoped jar-typed transitive artifacts into a destination directory.
abstract void	createLauncher() Create a launcher specific to a given platform.
protected String	getApplicationName()
protected String	getLibraryDirectory()
protected String	getMainClassName()
protected org.apache.maven.plugin.AbstractMojo	getMojo()
protected File	getOutputDirectory()
protected Properties	getParameterProperties()
protected Set<File>	getResourceDirectories()
protected String[]	getSystemProperties()
protected Set<org.apache.maven.artifact.Artifact>	getTransitiveArtifacts()
protected Set<String>	getTransitiveJarOrNarArtifactFileNames(Set<org.apache.maven.artifact.Artifact> transitiveArtifacts) Find all the compile-scoped .jar or .nar artifacts in a set, and ensure they're returned as .jars ('cos that's what they are).
protected String[]	getVmArguments()
protected void	makeExecutable(File nonExecutableFile) Make a file executable, in the terms of the specific platform.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LauncherCreator

public LauncherCreator(org.apache.maven.plugin.AbstractMojo mojo,
               File outputDirectory,
               String mainClassName,
               String applicationName,
               String libraryDirectory,
               Set<org.apache.maven.artifact.Artifact> transitiveArtifacts,
               Set<File> resourceDirectories,
               Properties parameterProperties,
               String[] systemProperties,
               String[] vmArguments,
               String[] narClassifierTypes)

Parameters:

mojo - the parent mojo class

outputDirectory - where to create the .app structure

mainClassName - the main class

applicationName - the name of the application

libraryDirectory - where the libraries are stored

transitiveArtifacts - the set of transitive artifact dependencies

resourceDirectories - the project's resource directories

parameterProperties - the plugin configuration parameters, as properties

systemProperties - an array of name=value system properties

vmArguments - an array of arguments to the VM

narClassifierTypes - an array of NAR classifier:types

Method Detail

getMojo

protected final org.apache.maven.plugin.AbstractMojo getMojo()

Returns:

the mojo that Austin Powers stole

getTransitiveArtifacts

protected final Set<org.apache.maven.artifact.Artifact> getTransitiveArtifacts()

Returns:

the transitiveArtifacts

getOutputDirectory

protected final File getOutputDirectory()

Returns:

the outputDirectory

getMainClassName

protected final String getMainClassName()

Returns:

the mainClassName

getApplicationName

protected final String getApplicationName()

Returns:

the applicationName

getLibraryDirectory

protected final String getLibraryDirectory()

Returns:

the libraryDirectory

getResourceDirectories

protected final Set<File> getResourceDirectories()

Returns:

the resourceDirectories

getParameterProperties

protected final Properties getParameterProperties()

Returns:

the parameterProperties

getSystemProperties

protected final String[] getSystemProperties()

Returns:

the array of system properties name=value pair strings

getVmArguments

protected final String[] getVmArguments()

Returns:

the array of VM arguments

createLauncher

public abstract void createLauncher()
                             throws IOException

Create a launcher specific to a given platform.

Throws:

IOException - on creation failure

copyPluginResource

protected final void copyPluginResource(String resourceName,
                      File destinationFile)
                                 throws IOException

Copy a resource from the plugin's resources to a file.

Parameters:

resourceName - the name of the resource

destinationFile - the file to write it to

Throws:

IOException - on write failure

copyProjectResource

protected final void copyProjectResource(String resourceName,
                       File destinationFile)
                                  throws IOException

Copy a resource from the user project to a file

Parameters:

resourceName - the name of the resource in the user project

destinationFile - the file to write it to

Throws:

IOException - on write failure

getTransitiveJarOrNarArtifactFileNames

protected Set<String> getTransitiveJarOrNarArtifactFileNames(Set<org.apache.maven.artifact.Artifact> transitiveArtifacts)

Find all the compile-scoped .jar or .nar artifacts in a set, and ensure they're returned as .jars ('cos that's what they are).

Parameters:

transitiveArtifacts - a set of artifacts

Returns:

the names of the filtered, transformed artifacts

copyFile

protected final void copyFile(File sourceFile,
            File destinationDirectory)
                       throws IOException

Copy a file from its source to a destination directory.

Parameters:

sourceFile - the source file

destinationDirectory - the destination directory, which must exist

Throws:

IOException - on copy failure

copyTransitiveArtifacts

protected final void copyTransitiveArtifacts(File destinationDirectory)
                                      throws IOException

Copy all compile-scoped jar-typed transitive artifacts into a destination directory.

Parameters:

destinationDirectory - the destination directory, which must exist

Throws:

IOException - on copy failure

copyInterpolatedProjectResource

protected final void copyInterpolatedProjectResource(String resourceName,
                                   File outputFile)
                                              throws IOException

Copy a user project resource to a file, interpolating with the configuration properties

Parameters:

resourceName - the name of the resource in the user project

outputFile - the file to write it to

Throws:

IOException - on write failure

copyInterpolatedPluginResource

protected final void copyInterpolatedPluginResource(String resourceName,
                                  File outputFile)
                                             throws IOException

Copy a plugin resource to a file, interpolating with the configuration properties

Parameters:

resourceName - the name of the plugin resource

outputFile - the file to write it to

Throws:

IOException - on write failure

makeExecutable

protected final void makeExecutable(File nonExecutableFile)

Make a file executable, in the terms of the specific platform.

Parameters:

nonExecutableFile - some file that may not currently be executable