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, org.nuiton.plugin.Plugin
@Mojo(name="execute-remote-command", defaultPhase=VALIDATE, requiresOnline=true, requiresProject=true) public class ExecuteRemoteCommandMojo extends org.nuiton.plugin.AbstractPlugin
Mojo to execute on a remote server some scripts.
Since:
1.3.1
Author:
Tony Chemit - chemit@codelutin.com

  • Nested Class Summary

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

    org.nuiton.plugin.Plugin.InitState, org.nuiton.plugin.Plugin.Packaging

  • Field Summary

    Fields
    Modifier and Type
    Field
    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
    Description
    ExecuteRemoteCommandMojo()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    disconnect(org.apache.maven.wagon.Wagon wagon)
     
    protected void
    doAction()
     
    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()
     
    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, needInvoke, needInvoke, rejectPackaging, removeCompileSourceRoots, removeTestCompileSourceRoots, renameFile, writeFile

    Methods inherited from class org.apache.maven.plugin.AbstractMojo

    getLog, getPluginContext, setLog, setPluginContext

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

    getLog, setLog

  • Field Details

    • verbose

      @Parameter(property="helper.verbose", defaultValue="${maven.verbose}") protected boolean verbose
      A flag to activate verbose mode.

    • project

      @Parameter(defaultValue="${project}", required=true, readonly=true) 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

      @Parameter(defaultValue="${settings}", required=true, readonly=true) 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 Details

    • ExecuteRemoteCommandMojo

      public ExecuteRemoteCommandMojo()

  • Method Details

    • init

      protected void init() throws Exception
      Specified by:
      init in class org.nuiton.plugin.AbstractPlugin
      Throws:
      Exception

    • doAction

      protected void doAction() throws Exception
      Specified by:
      doAction in class org.nuiton.plugin.AbstractPlugin
      Throws:
      Exception

    • 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()