org.jvnet.updatecenter2
Class PackageMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.jvnet.updatecenter2.PackageMojo

All Implemented Interfaces:

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

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

Builds an IPS package.

Author:

Kohsuke Kawaguchi

Field Summary

protected boolean	attach Attaches the created package file as an artifact of the build (which in turn causes it to be installed to your local repository or to be deployed remotely to a Maven repository.)
protected java.io.File	baseDir The base directory to be passed to makepkgs.py.
protected java.io.File	baseDirectory Deprecated. As of release 0.4, replaced by baseDir
protected java.io.File	destFile Path to generated IPS package file.
protected java.io.File	localRepository Deprecated. As of release 0.4, replaced by prototype
protected java.io.File	makePkgsDir Directory that extracts makepkgs.py to.
protected java.io.File	manifestBase The base directory for the source files of a manifest.
protected java.io.File[]	manifestFile The manifest file to create the package fmri, multiple manifest-fmri can be specified.
protected java.lang.String	manifestFMRI The package fmri (name@version) to use for manifest file.
protected java.lang.String[]	ostarget The OS for which the packages are targeted.
protected java.io.File	packageFile Deprecated. As of release 0.4, replaced by destFile
protected org.apache.maven.project.MavenProject	project This is injected by Maven and not meant to be set by POM.
protected java.io.File	proto Deprecated. As of release 0.4, replaced by prototype
protected java.io.File	prototype Package definition file that drives the packaging process.
protected java.lang.String	python Path to python executable.
protected java.lang.String	remoteRepository Deprecated. As of release 0.4, replaced by repourl
protected java.lang.String	repourl Repository URL to deposit the generated package, it can be either a remote repository(http://remote-repository) or local repository (file://C:\repository\pkg).

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

ROLE

Constructor Summary

PackageMojo()

Method Summary

void

execute()

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

proto

@Deprecated
protected java.io.File proto

Deprecated. As of release 0.4, replaced by prototype

Package definition file that drives the packaging process.

prototype

protected java.io.File prototype

Package definition file that drives the packaging process.

makePkgsDir

protected java.io.File makePkgsDir

Directory that extracts makepkgs.py to. If this directory already exists, then the script is assumed to be already in there. This is useful for testing modified versions of makepkgs.py. This also implements the caching semantics.

Since:

0.4

localRepository

protected java.io.File localRepository

Deprecated. As of release 0.4, replaced by prototype

Local directory to deposit the generated package.

baseDirectory

@Deprecated
protected java.io.File baseDirectory

Deprecated. As of release 0.4, replaced by baseDir

The base directory to be passed to makepkgs.py. This determines where the relative paths in your prototype.py are resolved.

baseDir

protected java.io.File baseDir

The base directory to be passed to makepkgs.py. This determines where the relative paths in your prototype.py are resolved.

Since:

0.4

packageFile

@Deprecated
protected java.io.File packageFile

Deprecated. As of release 0.4, replaced by destFile

Path to generated IPS package file.

destFile

protected java.io.File destFile

Path to generated IPS package file. The generated file will be in .tgz or .zip format depending the value entered.

Since:

0.4

remoteRepository

@Deprecated
protected java.lang.String remoteRepository

Deprecated. As of release 0.4, replaced by repourl

Repository URL to deposit the generated package.

If this parameter is non-null, this takes precedence over the local repository parameter.

repourl

protected java.lang.String repourl

Repository URL to deposit the generated package, it can be either a remote repository(http://remote-repository) or local repository (file://C:\repository\pkg).

If this parameter is non-null, this takes precedence over the local repository parameter.

Since:

0.4

attach

protected boolean attach

Attaches the created package file as an artifact of the build (which in turn causes it to be installed to your local repository or to be deployed remotely to a Maven repository.)

python

protected java.lang.String python

Path to python executable. By default, the mojo downloads minimal Python specifically packaged for UC2, but if you'd like to use your own version, specify it here.

The typical use case of this is to specify it in the command-line, like mvn -Dpython=python2.5 install

project

protected org.apache.maven.project.MavenProject project

This is injected by Maven and not meant to be set by POM.

ostarget

protected java.lang.String[] ostarget

The OS for which the packages are targeted. You can specify more than one os element. The prototype file allows you to specify the ostarget value for each file/dir/dirtrees. If the OS specified in the ostarget element of makepkgs matches the name specified in the prototype file, that particular file/dir/dirtees in the prototype will be included in the package.

Since:

0.4

manifestFMRI

protected java.lang.String manifestFMRI

The package fmri (name@version) to use for manifest file.

Since:

0.4

manifestFile

protected java.io.File[] manifestFile

The manifest file to create the package fmri, multiple manifest-fmri can be specified.

Since:

0.4

manifestBase

protected java.io.File manifestBase

The base directory for the source files of a manifest.

Since:

0.4

Constructor Detail

PackageMojo

public PackageMojo()

Method Detail

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException