org.apache.maven.plugin.deploy

Class AbstractDeployMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugin.deploy.AbstractDeployMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

DeployFileMojo, DeployMojo

public abstract class AbstractDeployMojo
extends org.apache.maven.plugin.AbstractMojo

Version:

$Id: AbstractDeployMojo.java 1531347 2013-10-11 16:38:02Z rfscholte $

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.maven.artifact.factory.ArtifactFactory	artifactFactory Component used to create an artifact.
private org.apache.maven.artifact.deployer.ArtifactDeployer	deployer
private org.apache.maven.artifact.repository.ArtifactRepository	localRepository
private boolean	offline Flag whether Maven is currently in online/offline mode.
(package private) org.apache.maven.artifact.repository.ArtifactRepositoryFactory	repositoryFactory Component used to create a repository.
private java.util.Map<java.lang.String,org.apache.maven.artifact.repository.layout.ArtifactRepositoryLayout>	repositoryLayouts Map that contains the layouts.
private int	retryFailedDeploymentCount Parameter used to control how many times a failed deployment will be retried before giving up and failing.
protected boolean	updateReleaseInfo Parameter used to update the metadata to make the artifact as release.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractDeployMojo()

Method Summary

Modifier and Type	Method and Description
protected void	deploy(java.io.File source, org.apache.maven.artifact.Artifact artifact, org.apache.maven.artifact.repository.ArtifactRepository deploymentRepository, org.apache.maven.artifact.repository.ArtifactRepository localRepository, int retryFailedDeploymentCount) Deploy an artifact from a particular file.
(package private) void	failIfOffline()
org.apache.maven.artifact.deployer.ArtifactDeployer	getDeployer()
(package private) org.apache.maven.artifact.repository.layout.ArtifactRepositoryLayout	getLayout(java.lang.String id)
org.apache.maven.artifact.repository.ArtifactRepository	getLocalRepository()
(package private) int	getRetryFailedDeploymentCount()
(package private) boolean	isUpdateReleaseInfo()
void	setDeployer(org.apache.maven.artifact.deployer.ArtifactDeployer deployer)
void	setLocalRepository(org.apache.maven.artifact.repository.ArtifactRepository localRepository)

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

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

execute

Field Detail

deployer

@Component
private org.apache.maven.artifact.deployer.ArtifactDeployer deployer

artifactFactory

@Component
protected org.apache.maven.artifact.factory.ArtifactFactory artifactFactory

Component used to create an artifact.

repositoryFactory

@Component
org.apache.maven.artifact.repository.ArtifactRepositoryFactory repositoryFactory

Component used to create a repository.

repositoryLayouts

@Component(role=org.apache.maven.artifact.repository.layout.ArtifactRepositoryLayout.class)
private java.util.Map<java.lang.String,org.apache.maven.artifact.repository.layout.ArtifactRepositoryLayout> repositoryLayouts

Map that contains the layouts.

localRepository

@Parameter(defaultValue="${localRepository}",
           required=true,
           readonly=true)
private org.apache.maven.artifact.repository.ArtifactRepository localRepository

offline

@Parameter(defaultValue="${settings.offline}",
           readonly=true)
private boolean offline

Flag whether Maven is currently in online/offline mode.

updateReleaseInfo

@Parameter(property="updateReleaseInfo",
           defaultValue="false")
protected boolean updateReleaseInfo

Parameter used to update the metadata to make the artifact as release.

retryFailedDeploymentCount

@Parameter(property="retryFailedDeploymentCount",
           defaultValue="1")
private int retryFailedDeploymentCount

Parameter used to control how many times a failed deployment will be retried before giving up and failing. If a value outside the range 1-10 is specified it will be pulled to the nearest value within the range 1-10.

Since:

2.7

Constructor Detail

AbstractDeployMojo

public AbstractDeployMojo()

Method Detail

getDeployer

public org.apache.maven.artifact.deployer.ArtifactDeployer getDeployer()

setDeployer

public void setDeployer(org.apache.maven.artifact.deployer.ArtifactDeployer deployer)

getLocalRepository

public org.apache.maven.artifact.repository.ArtifactRepository getLocalRepository()

setLocalRepository

public void setLocalRepository(org.apache.maven.artifact.repository.ArtifactRepository localRepository)

failIfOffline

void failIfOffline()
            throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

getLayout

org.apache.maven.artifact.repository.layout.ArtifactRepositoryLayout getLayout(java.lang.String id)
                                                                        throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

isUpdateReleaseInfo

boolean isUpdateReleaseInfo()

getRetryFailedDeploymentCount

int getRetryFailedDeploymentCount()

deploy

protected void deploy(java.io.File source,
                      org.apache.maven.artifact.Artifact artifact,
                      org.apache.maven.artifact.repository.ArtifactRepository deploymentRepository,
                      org.apache.maven.artifact.repository.ArtifactRepository localRepository,
                      int retryFailedDeploymentCount)
               throws org.apache.maven.artifact.deployer.ArtifactDeploymentException

Deploy an artifact from a particular file.

Parameters:

source - the file to deploy

artifact - the artifact definition

deploymentRepository - the repository to deploy to

localRepository - the local repository to install into

retryFailedDeploymentCount - TODO

Throws:

org.apache.maven.artifact.deployer.ArtifactDeploymentException - if an error occurred deploying the artifact