org.kualigan.maven.plugins.kfs

Class MigrateMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.kualigan.maven.plugins.kfs.MigrateMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

public class MigrateMojo
extends org.apache.maven.plugin.AbstractMojo

Migrates an existing KFS distribution to Maven as a Prototype.

Field Summary

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
MigrateMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	copyFilesFromArcheType(String basedir) Copy files from the archetype into the new project into the appropriate package directories.
org.apache.maven.artifact.repository.ArtifactRepository	createRepository(String url, String repositoryId) Creates an ArtifactRepository instance.
void	execute() The following are steps to migrating a KFS distribution to Maven: Create a staging directory to copy project resources to from the kfs maven archetype Create modules core, it, and web Copy java source files from work to core/src/main/java Copy java source files from test to it/src/test/java Copy non-java, non-web resources from work to core/src/main/resources Copy non-java, non-web resources from test to it/src/test/resources Copy web resources from work/web-root/ to web/src/main/webapp Retrieve the latest kuali POM information and create poms in ./, core/, it/, and web/ Note: When copying files, files are not overwritten.
protected void	setupDefaults()

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

Constructor Detail

MigrateMojo

public MigrateMojo()

Method Detail

setupDefaults

protected void setupDefaults()
                      throws Exception

Throws:

Exception

execute

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

The following are steps to migrating a KFS distribution to Maven:

1. Create a staging directory to copy project resources to from the kfs maven archetype
2. Create modules core, it, and web
3. Copy java source files from work to core/src/main/java
4. Copy java source files from test to it/src/test/java
5. Copy non-java, non-web resources from work to core/src/main/resources
6. Copy non-java, non-web resources from test to it/src/test/resources
7. Copy web resources from work/web-root/ to web/src/main/webapp
8. Retrieve the latest kuali POM information and create poms in ./, core/, it/, and web/

Note: When copying files, files are not overwritten. This allows us to copy the archetype first and preclude andy settings with those from the archetype. The basic way to understand how this works is the kfs-archetype is used to create kfs maven projects, but it is dynamically generated. Then, source files are copied to it.

Throws:

org.apache.maven.plugin.MojoExecutionException

copyFilesFromArcheType

protected void copyFilesFromArcheType(String basedir)

Copy files from the archetype into the new project into the appropriate package directories. TODO: This method currently isn't used because files don't need to be copied yet, but it should probably get used at some point

createRepository

public org.apache.maven.artifact.repository.ArtifactRepository createRepository(String url,
                                                                       String repositoryId)

Creates an ArtifactRepository instance. This code was borrowed from the maven-hpi-plugin

Parameters:

url -

repositoryId -

Returns:

ArtifactRepository