org.nuiton.helper.plugin

Class ExecuteRemoteCommandMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.nuiton.plugin.AbstractPlugin

org.nuiton.helper.plugin.ExecuteRemoteCommandMojo

All Implemented Interfaces:

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

@Mojo(name="execute-remote-command",
      defaultPhase=VALIDATE,
      requiresOnline=true,
      requiresProject=true)
public class ExecuteRemoteCommandMojo
extends AbstractPlugin

Mojo to execute on a remote server some scripts.

Since:

1.3.1

Author:

tchemit

Nested Class Summary

Nested classes/interfaces inherited from interface org.nuiton.plugin.Plugin

Plugin.InitState, Plugin.Packaging

Field Summary

Fields

Modifier and Type	Field and Description
protected String	command Command to execute on remote server.
protected org.apache.maven.project.MavenProject	project Project.
protected org.apache.maven.settings.Proxy	proxy Active proxy from settings (if any).
protected String	repositoryId Id of the server to use to obtain user login.
protected String	repositoryUrl Url where to execute script.
protected org.apache.maven.settings.Settings	settings Settings.
protected boolean	verbose A flag to activate verbose mode.
protected org.apache.maven.artifact.manager.WagonManager	wagonManager Wagon manager component.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
ExecuteRemoteCommandMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	disconnect(org.apache.maven.wagon.Wagon wagon)
protected void	doAction() Do plugin action.
org.apache.maven.project.MavenProject	getProject()
protected org.apache.maven.wagon.proxy.ProxyInfo	getProxyInfo()
protected org.apache.maven.wagon.Wagon	getWagon(org.apache.maven.wagon.repository.Repository repository)
protected void	init() Method to initialize the mojo before doing any concrete actions.
boolean	isVerbose()
void	setProject(org.apache.maven.project.MavenProject project)
void	setVerbose(boolean verbose)

Methods inherited from class org.nuiton.plugin.AbstractPlugin

acceptPackaging, addCompileSourceRoots, addDirectoryToUrlsList, addResourceDir, addTestCompileSourceRoots, addTestResourceDir, addUrlToUrlsList, afterExecute, backupFile, checkEncoding, checkPackaging, checkResource, checkRunOnceDone, checkSkip, copyFile, createDirectoryIfNecessary, createNewFile, deleteFile, execute, getBackupFile, getFileFromBasedir, getFilesToTreate, getFilesToTreateForRoots, getRootProject, getTemplate, hasClassPath, initClassLoader, isExecutionRoot, isFileNewerThanPomFile, rejectPackaging, removeCompileSourceRoots, removeTestCompileSourceRoots, renameFile, writeFile

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

getLog, setLog

Field Detail

verbose

@Parameter(property="helper.verbose",
           defaultValue="${maven.verbose}")
protected boolean verbose

A flag to activate verbose mode.

project

@Component
protected org.apache.maven.project.MavenProject project

Project.

proxy

@Parameter(defaultValue="${settings.activeProxy}",
           required=true,
           readonly=true)
protected org.apache.maven.settings.Proxy proxy

Active proxy from settings (if any).

settings

@Component
protected org.apache.maven.settings.Settings settings

Settings.

Since:

1.1.0

repositoryId

@Parameter(property="helper.repositoryId",
           required=true)
protected String repositoryId

Id of the server to use to obtain user login.

Must be found in your settings.xml.

repositoryUrl

@Parameter(property="helper.repositoryUrl",
           required=true)
protected String repositoryUrl

Url where to execute script.

The url must contains the wagon protocol (says scp:... or scpexe:...).

command

@Parameter(property="helper.command",
           required=true)
protected String command

Command to execute on remote server.

wagonManager

@Component
protected org.apache.maven.artifact.manager.WagonManager wagonManager

Wagon manager component.

Constructor Detail

ExecuteRemoteCommandMojo

public ExecuteRemoteCommandMojo()

Method Detail

init

protected void init()
             throws Exception

Description copied from class: AbstractPlugin

Method to initialize the mojo before doing any concrete actions.

Note: The method is invoked before the AbstractPlugin.doAction() method.

Specified by:

init in class AbstractPlugin

Throws:

Exception - if any

doAction

protected void doAction()
                 throws Exception

Description copied from class: AbstractPlugin

Do plugin action.

The method AbstractPlugin.execute() invoke this method only and only if :

• AbstractPlugin.checkPackaging() returns true.
• method AbstractPlugin.init() returns true.

Specified by:

doAction in class AbstractPlugin

Throws:

Exception - if any

getProject

public org.apache.maven.project.MavenProject getProject()

setProject

public void setProject(org.apache.maven.project.MavenProject project)

isVerbose

public boolean isVerbose()

setVerbose

public void setVerbose(boolean verbose)

getWagon

protected org.apache.maven.wagon.Wagon getWagon(org.apache.maven.wagon.repository.Repository repository)
                                         throws Exception

Throws:

Exception

disconnect

protected void disconnect(org.apache.maven.wagon.Wagon wagon)

getProxyInfo

protected org.apache.maven.wagon.proxy.ProxyInfo getProxyInfo()