org.kualigan.maven.plugins.kc

Class CreatePrototypeMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.kualigan.maven.plugins.kc.CreatePrototypeMojo

All Implemented Interfaces:

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

@Mojo(name="create-prototype",
      requiresProject=false)
public class CreatePrototypeMojo
extends org.apache.maven.plugin.AbstractMojo

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

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

Field Summary

Fields

Modifier and Type	Field and Description
protected String	artifactId
protected File	file WAR file to create a prototype from.
protected String	groupId
protected PrototypeHelper	helper
protected String	kcPath Path for where the kc instance is we want to migrate
protected org.apache.maven.artifact.repository.ArtifactRepository	localRepository
protected File	mavenHome The M2_HOME parameter to use for forked Maven invocations.
protected String	packageName
protected org.apache.maven.project.MavenProject	project
protected String	repositoryId
protected File	sources Assembled sources file.
protected String	version

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

ROLE

Constructor Summary

Constructors

Constructor and Description
CreatePrototypeMojo()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() Create a prototype
File	getMavenHome()
String	getRepositoryId()
void	setMavenHome(File mavenHome)
void	setRepositoryId(String repositoryId)

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

helper

@Component(role=org.kualigan.maven.plugins.api.PrototypeHelper.class,
           hint="default")
protected PrototypeHelper helper

localRepository

@Parameter(property="localRepository")
protected org.apache.maven.artifact.repository.ArtifactRepository localRepository

kcPath

@Parameter(property="kc.local.path")
protected String kcPath

Path for where the kc instance is we want to migrate

packageName

@Parameter(property="packageName",
           defaultValue="org.kuali.kc")
protected String packageName

groupId

@Parameter(property="groupId",
           defaultValue="org.kuali.kc")
protected String groupId

artifactId

@Parameter(property="artifactId",
           defaultValue="kc")
protected String artifactId

version

@Parameter(property="version",
           defaultValue="5.0")
protected String version

file

@Parameter(property="file")
protected File file

WAR file to create a prototype from. Only used when creating a prototype from a war.

sources

@Parameter(property="sources")
protected File sources

Assembled sources file.

project

@Parameter(property="project")
protected org.apache.maven.project.MavenProject project

repositoryId

@Parameter(property="repositoryId")
protected String repositoryId

mavenHome

@Parameter(defaultValue="${maven.home}")
protected File mavenHome

The M2_HOME parameter to use for forked Maven invocations.

Constructor Detail

CreatePrototypeMojo

public CreatePrototypeMojo()

Method Detail

execute

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

Create a prototype

The following are the steps for creating a prototype from a kc instance

When using a war file:

1. Basically, use the install-file mojo and generate a POM from the archetype

When using an svn repo:

1. Checkout the source.
2. Run migrate on it.

When using a local path:

1. Delegate to migrate

The basic way to understand how this works is the kc-archetype is used to create kc maven projects, but it is dynamically generated. Then, source files are copied to it.

Throws:

org.apache.maven.plugin.MojoExecutionException

setMavenHome

public void setMavenHome(File mavenHome)

getMavenHome

public File getMavenHome()

setRepositoryId

public void setRepositoryId(String repositoryId)

getRepositoryId

public String getRepositoryId()