org.apache.maven.plugin.nar
Interface NarLayout

All Known Implementing Classes:

AbstractNarLayout, NarLayout20, NarLayout21

public interface NarLayout

Interface to define the layout of nar files (executables, libs, include dirs) in both the repository (local, unpacked) as well as in target.

Author:

Mark Donszelmann (Mark.Donszelmann@gmail.com)

Method Summary

void	attachNars(java.io.File baseDir, org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager, org.apache.maven.project.MavenProjectHelper projectHelper, org.apache.maven.project.MavenProject project, NarInfo narInfo) Called to attach nars to main nar/jar file.
java.io.File	getBinDirectory(java.io.File baseDir, java.lang.String artifactId, java.lang.String version, java.lang.String aol) Specifies where binaries are stored
java.io.File	getIncludeDirectory(java.io.File baseDir, java.lang.String artifactId, java.lang.String version) Specifies where includes are stored
java.io.File	getLibDirectory(java.io.File baseDir, java.lang.String artifactId, java.lang.String version, java.lang.String aol, java.lang.String type) Specifies where libraries are stored
java.io.File	getNarUnpackDirectory(java.io.File baseUnpackDirectory, java.io.File narFile) Returns the unpack directory of a specific nar file.
java.io.File	getNoArchDirectory(java.io.File baseDir, java.lang.String artifactId, java.lang.String version) Specifies where all the "no architecture" specific files are stored
void	unpackNar(java.io.File baseDir, org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager, java.io.File file, java.lang.String os, java.lang.String linkerName, AOL defaultAOL) Called to unpack a nar file

Method Detail

getNoArchDirectory

java.io.File getNoArchDirectory(java.io.File baseDir,
                                java.lang.String artifactId,
                                java.lang.String version)
                                throws org.apache.maven.plugin.MojoExecutionException,
                                       org.apache.maven.plugin.MojoFailureException

Specifies where all the "no architecture" specific files are stored

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getLibDirectory

java.io.File getLibDirectory(java.io.File baseDir,
                             java.lang.String artifactId,
                             java.lang.String version,
                             java.lang.String aol,
                             java.lang.String type)
                             throws org.apache.maven.plugin.MojoExecutionException,
                                    org.apache.maven.plugin.MojoFailureException

Specifies where libraries are stored

Returns:

Throws:

MojoExecutionException, - MojoFailureException

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getIncludeDirectory

java.io.File getIncludeDirectory(java.io.File baseDir,
                                 java.lang.String artifactId,
                                 java.lang.String version)
                                 throws org.apache.maven.plugin.MojoExecutionException,
                                        org.apache.maven.plugin.MojoFailureException

Specifies where includes are stored

Returns:

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getBinDirectory

java.io.File getBinDirectory(java.io.File baseDir,
                             java.lang.String artifactId,
                             java.lang.String version,
                             java.lang.String aol)
                             throws org.apache.maven.plugin.MojoExecutionException,
                                    org.apache.maven.plugin.MojoFailureException

Specifies where binaries are stored

Returns:

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

attachNars

void attachNars(java.io.File baseDir,
                org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager,
                org.apache.maven.project.MavenProjectHelper projectHelper,
                org.apache.maven.project.MavenProject project,
                NarInfo narInfo)
                throws org.apache.maven.plugin.MojoExecutionException,
                       org.apache.maven.plugin.MojoFailureException

Called to attach nars to main nar/jar file. This method needs to produce all the attached nar files and set NarInfo accordingly.

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

unpackNar

void unpackNar(java.io.File baseDir,
               org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager,
               java.io.File file,
               java.lang.String os,
               java.lang.String linkerName,
               AOL defaultAOL)
               throws org.apache.maven.plugin.MojoExecutionException,
                      org.apache.maven.plugin.MojoFailureException

Called to unpack a nar file

Parameters:

defaultAOL -

linkerName -

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getNarUnpackDirectory

java.io.File getNarUnpackDirectory(java.io.File baseUnpackDirectory,
                                   java.io.File narFile)

Returns the unpack directory of a specific nar file.