Package org.codehaus.mojo.wagon

Class AbstractSingleWagonMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.wagon.AbstractWagonMojo

org.codehaus.mojo.wagon.AbstractSingleWagonMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractWagonListMojo, DownloadSingleMojo, ExistMojo, SshExecMojo, UploadMojo, UploadSingleMojo

public abstract class AbstractSingleWagonMojo
extends AbstractWagonMojo

Provides base functionality for dealing with I/O using single wagon.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	url	URL to upload to or download from or list.

Fields inherited from class org.codehaus.mojo.wagon.AbstractWagonMojo

project, settings, skip, wagonFactory

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

ROLE

Constructor Summary

Constructors

Constructor	Description
AbstractSingleWagonMojo()

Method Summary

Modifier and Type	Method	Description
void	execute()
protected abstract void	execute(org.apache.maven.wagon.Wagon wagon)	Perform the necessary action.

Methods inherited from class org.codehaus.mojo.wagon.AbstractWagonMojo

createWagon, getWagonFileSet

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 Details

url

@Parameter(property="wagon.url",
           required=true)
protected String url

URL to upload to or download from or list. Must exist and point to a directory.

Constructor Details

AbstractSingleWagonMojo

public AbstractSingleWagonMojo()

Method Details

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

execute

protected abstract void execute(org.apache.maven.wagon.Wagon wagon)
                         throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.wagon.WagonException,
IOException

Perform the necessary action. To be implemented in the child mojo.

Parameters:

wagon - - wagon instance to use

Throws:

org.apache.maven.plugin.MojoExecutionException - if any execution error

org.apache.maven.wagon.WagonException - if any wagon error

IOException - if any io error