org.apache.maven.plugin.install
Class InstallFileMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.plugin.install.AbstractInstallMojo
          org.apache.maven.plugin.install.InstallFileMojo

All Implemented Interfaces:

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

public class InstallFileMojo
extends AbstractInstallMojo

Installs a file in the local repository.

Version:

$Id: InstallFileMojo.java 942550 2010-05-09 15:19:07Z krosenvold $

Author:

Brett Porter

Aggregates the Maven project and its child modules.

Is defined by the goal name:

install-file

Requires a Maven project to run:

false

Field Summary

protected String	artifactId ArtifactId of the artifact to be installed.
protected String	classifier Classifier type of the artifact to be installed.
protected String	groupId GroupId of the artifact to be installed.
protected String	packaging Packaging type of the artifact to be installed.
protected String	version Version of the artifact to be installed.

Fields inherited from class org.apache.maven.plugin.install.AbstractInstallMojo

artifactFactory, createChecksum, installer, localRepository, md5Digester, sha1Digester, updateReleaseInfo

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

ROLE

Constructor Summary

InstallFileMojo()

Method Summary

void	execute()
File	getLocalRepositoryPath()
void	setLocalRepositoryPath(File theLocalRepositoryPath)

Methods inherited from class org.apache.maven.plugin.install.AbstractInstallMojo

getLocalRepoFile, getLocalRepoFile, installChecksums

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

groupId

protected String groupId

GroupId of the artifact to be installed. Retrieved from POM file if one is specified.

Is defined by:

expression:

${groupId}

artifactId

protected String artifactId

ArtifactId of the artifact to be installed. Retrieved from POM file if one is specified.

Is defined by:

expression:

${artifactId}

version

protected String version

Version of the artifact to be installed. Retrieved from POM file if one is specified.

Is defined by:

expression:

${version}

packaging

protected String packaging

Packaging type of the artifact to be installed. Retrieved from POM file if one is specified.

Is defined by:

expression:

${packaging}

classifier

protected String classifier

Classifier type of the artifact to be installed. For example, "sources" or "javadoc". Defaults to none which means this is the project's main artifact.

Since:

2.2

Is defined by:

expression:

${classifier}

Constructor Detail

InstallFileMojo

public InstallFileMojo()

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

See Also:

Mojo.execute()

getLocalRepositoryPath

public File getLocalRepositoryPath()

Returns:

the localRepositoryPath

setLocalRepositoryPath

public void setLocalRepositoryPath(File theLocalRepositoryPath)

Parameters:

theLocalRepositoryPath - the localRepositoryPath to set