org.kualigan.maven.plugins.api

Class DefaultPrototypeHelper

java.lang.Object

org.kualigan.maven.plugins.api.DefaultPrototypeHelper

All Implemented Interfaces:

PrototypeHelper

@Component(role=PrototypeHelper.class,
           hint="default")
public class DefaultPrototypeHelper
extends Object
implements PrototypeHelper

Creates a prototype from the given KFS project resource. A KFS project resource can be either of the following:

• KFS war file
• KFS project directory with source
• KFS svn repo

Author:

Leo Przybylski

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.maven.archetype.Archetype	archetype
protected org.codehaus.plexus.archiver.manager.ArchiverManager	archiverManager
protected org.apache.maven.artifact.repository.ArtifactRepositoryFactory	artifactRepositoryFactory
protected org.apache.maven.artifact.repository.layout.ArtifactRepositoryLayout	defaultArtifactRepositoryLayout
protected org.codehaus.plexus.components.interactivity.Prompter	prompter
static String	ROLE_HINT

Fields inherited from interface org.kualigan.maven.plugins.api.PrototypeHelper

ROLE

Constructor Summary

Constructors

Constructor and Description
DefaultPrototypeHelper()

Method Summary

Methods

Modifier and Type	Method and Description
protected int	executeCommandLine(String... args)
void	extractTempPom() Puts temporary pom in the system temp directory.
void	filterTempPom(String groupId, String artifactId, String packaging, String version) Executes the install-file goal with the new pom against the artifact file.
org.apache.maven.plugin.AbstractMojo	getCaller()
protected String	getTempPomPath() Temporary POM location
void	installArtifact(File artifact, File sources, File mavenHome, String groupId, String artifactId, String version, String repositoryId) Executes the install-file goal with the new pom against the artifact file.
protected void	logUnpack(File file, File location, String includes, String excludes)
protected void	pack(File file, File location, String includes, String excludes) Packs a jar
File	repack(File file, String artifactId) Handles repacking of the war as a jar file with classes, etc...
void	setCaller(org.apache.maven.plugin.AbstractMojo caller)
protected void	unpack(File file, File location, String includes, String excludes) Unpacks the archive file.
protected File	zipSourcesIfRequired(File sources)

Methods inherited from class java.lang.Object

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

Field Detail

ROLE_HINT

public static final String ROLE_HINT

See Also:

Constant Field Values

archetype

@Requirement
protected org.apache.maven.archetype.Archetype archetype

prompter

@Requirement
protected org.codehaus.plexus.components.interactivity.Prompter prompter

artifactRepositoryFactory

@Requirement
protected org.apache.maven.artifact.repository.ArtifactRepositoryFactory artifactRepositoryFactory

defaultArtifactRepositoryLayout

@Requirement(role=org.apache.maven.artifact.repository.layout.ArtifactRepositoryLayout.class,
             hint="default")
protected org.apache.maven.artifact.repository.layout.ArtifactRepositoryLayout defaultArtifactRepositoryLayout

archiverManager

@Requirement
protected org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager

Constructor Detail

DefaultPrototypeHelper

public DefaultPrototypeHelper()

Method Detail

logUnpack

protected void logUnpack(File file,
             File location,
             String includes,
             String excludes)

executeCommandLine

protected int executeCommandLine(String... args)
                          throws org.apache.commons.exec.ExecuteException,
                                 IOException

Throws:

org.apache.commons.exec.ExecuteException

IOException

repack

public File repack(File file,
          String artifactId)
            throws org.apache.maven.plugin.MojoExecutionException

Handles repacking of the war as a jar file with classes, etc... Basically makes a jar of everything in the war file's WEB-INF/classes path.

Specified by:

repack in interface PrototypeHelper

Parameters:

file - is the war file to repackage

Returns:

File instance of the repacked jar

Throws:

org.apache.maven.plugin.MojoExecutionException

unpack

protected void unpack(File file,
          File location,
          String includes,
          String excludes)
               throws org.apache.maven.plugin.MojoExecutionException

Unpacks the archive file.

Parameters:

file - File to be unpacked.

location - Location where to put the unpacked files.

includes - Comma separated list of file patterns to include i.e. **/.xml, **/*.properties

excludes - Comma separated list of file patterns to exclude i.e. **/*.xml, **/*.properties

Throws:

org.apache.maven.plugin.MojoExecutionException

pack

protected void pack(File file,
        File location,
        String includes,
        String excludes)
             throws org.apache.maven.plugin.MojoExecutionException

Packs a jar

Parameters:

file - Destination file.

location - Directory source.

includes - Comma separated list of file patterns to include i.e. **/.xml, **/*.properties

excludes - Comma separated list of file patterns to exclude i.e. **/*.xml, **/*.properties

Throws:

org.apache.maven.plugin.MojoExecutionException

installArtifact

public void installArtifact(File artifact,
                   File sources,
                   File mavenHome,
                   String groupId,
                   String artifactId,
                   String version,
                   String repositoryId)
                     throws org.apache.maven.plugin.MojoExecutionException

Executes the install-file goal with the new pom against the artifact file.

Specified by:

installArtifact in interface PrototypeHelper

Parameters:

artifact - File instance to install

Throws:

org.apache.maven.plugin.MojoExecutionException

filterTempPom

public void filterTempPom(String groupId,
                 String artifactId,
                 String packaging,
                 String version)
                   throws org.apache.maven.plugin.MojoExecutionException

Executes the install-file goal with the new pom against the artifact file.

Throws:

org.apache.maven.plugin.MojoExecutionException

getTempPomPath

protected String getTempPomPath()

Temporary POM location

Returns:

String value the path of the temporary POM

extractTempPom

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

Puts temporary pom in the system temp directory. prototype-pom.xml is extracted from the plugin.

Specified by:

extractTempPom in interface PrototypeHelper

Throws:

org.apache.maven.plugin.MojoExecutionException

zipSourcesIfRequired

protected File zipSourcesIfRequired(File sources)

setCaller

public void setCaller(org.apache.maven.plugin.AbstractMojo caller)

Specified by:

setCaller in interface PrototypeHelper

getCaller

public org.apache.maven.plugin.AbstractMojo getCaller()

Specified by:

getCaller in interface PrototypeHelper