net.nicoulaj.maven.plugins.vagrant

Class HaltMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

de.saumya.mojo.jruby.AbstractJRubyMojo

de.saumya.mojo.gem.AbstractGemMojo

net.nicoulaj.maven.plugins.vagrant.HaltMojo

All Implemented Interfaces:

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

@Mojo(name="halt")
public final class HaltMojo
extends de.saumya.mojo.gem.AbstractGemMojo

Invokes Vagrant halt command.

Since:

1.0

Author:

Julien Nicoulaud

Field Summary

Fields

Modifier and Type	Field and Description
protected org.sonatype.plexus.build.incremental.BuildContext	buildContext Required by AbstractGemMojo.
protected org.codehaus.classworlds.ClassRealm	classRealm Required by AbstractGemMojo.
protected boolean	force Force shut down.
protected File	gemHome Custom gems directory.
protected org.apache.maven.artifact.repository.ArtifactRepository	localRepository Required by AbstractGemMojo.
protected de.saumya.mojo.ruby.gems.GemManager	manager Required by AbstractGemMojo.
static String	NAME Mojo/Vagrant command name.
protected org.apache.maven.plugin.descriptor.PluginDescriptor	plugin Required by AbstractGemMojo.
protected org.apache.maven.project.MavenProject	project Required by AbstractGemMojo.
protected org.apache.maven.repository.RepositorySystem	repositorySystem Required by AbstractGemMojo.
protected org.codehaus.plexus.archiver.UnArchiver	unzip Required by AbstractGemMojo.
protected File	vagrantHome Custom VAGRANT_HOME, which is the directory where Vagrant boxes are stored.
protected File	vagrantRc Custom VAGRANT_RC, which is the configuration file used by Vagrant.
protected String	vm VM name.

Fields inherited from class de.saumya.mojo.gem.AbstractGemMojo

binDirectory, gemHomes, gemPath, gemsConfig, gemsInstaller, gemUseSystem, includeGemsInResources, includeLibDirectoryInResources, includeOpenSSL, includeProvidedRubygemsInResources, includeRubygemsInResources, includeRubygemsInTestResources, installRDoc, installRI, supportNative

Fields inherited from class de.saumya.mojo.jruby.AbstractJRubyMojo

addProjectClasspath, args, DEFAULT_JRUBY_VERSION, eclipseRefresh, eclipseWatches, env, factory, JRUBY_COMPLETE, JRUBY_CORE, JRUBY_STDLIB, jrubyFork, jrubyJvmArgs, jrubySwitches, jrubyVerbose, libDirectory, logger, rubySourceDirectory

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

ROLE

Constructor Summary

Constructors

Constructor and Description
HaltMojo()

Method Summary

Modifier and Type	Method and Description
protected void	cli(Iterable<String> args)
protected void	cli(String... args)
protected void	doExecute()
void	execute()
protected void	executeWithGems()

Methods inherited from class de.saumya.mojo.gem.AbstractGemMojo

addResource, executeJRuby, gemHome, getRemoteRepos, newScriptFactory

Methods inherited from class de.saumya.mojo.jruby.AbstractJRubyMojo

getDefaultJRubyVersion, getJrubyVersion, getProjectClasspath, launchDirectory, resolveJRubyArtifact, resolveJRubyCompleteArtifact, resolveJRubyStdlibArtifact

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

NAME

public static final String NAME

Mojo/Vagrant command name.

See Also:

Constant Field Values

vm

@Parameter
protected String vm

VM name.

force

@Parameter(defaultValue="false")
protected boolean force

Force shut down.

gemHome

@Parameter(defaultValue="${project.build.directory}/vagrant/gems")
protected File gemHome

Custom gems directory.

Modifying this property has an impact on isolation/build portability, eg:

• In project.build.directory (default): user installation can not impact build, but gems are unpacked at every build.
• In project.basedir: user installation can not impact build, gems are unpacked once for all, but files are created outside of build directory.
• Outside project.basedir (Vagrant default): user installation can impact build.

Since:

1.0

vagrantHome

@Parameter(defaultValue="${project.build.directory}/vagrant/vagrant.d")
protected File vagrantHome

Custom VAGRANT_HOME, which is the directory where Vagrant boxes are stored.

Modifying this property has an impact on isolation/build portability, eg:

• In project.build.directory (default): boxes must be imported every time, but no file is created outside of build directory.
• In project.basedir: boxes can be imported once for all, but files are created outside of build directory.
• In ~/.vagrant.d (Vagrant default): user boxes can be directly used, but files are created outside of project structure.

Since:

1.0

vagrantRc

@Parameter(defaultValue="${project.build.directory}/vagrant/vagrantrc")
protected File vagrantRc

Custom VAGRANT_RC, which is the configuration file used by Vagrant.

Modifying this property has an impact on isolation/build portability, eg:

• In project.build.directory (default): user installation can not impact build.
• In project.basedir: user installation can not impact build.
• In ~/.vagrantrc (Vagrant default): user installation can impact build.

Since:

1.0

project

@Parameter(defaultValue="${project}",
           readonly=true)
protected org.apache.maven.project.MavenProject project

Required by AbstractGemMojo.

plugin

@Parameter(defaultValue="${plugin}",
           readonly=true)
protected org.apache.maven.plugin.descriptor.PluginDescriptor plugin

Required by AbstractGemMojo.

repositorySystem

@Component
protected org.apache.maven.repository.RepositorySystem repositorySystem

Required by AbstractGemMojo.

localRepository

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

Required by AbstractGemMojo.

classRealm

@Parameter(readonly=true,
           defaultValue="${dummy}")
protected org.codehaus.classworlds.ClassRealm classRealm

Required by AbstractGemMojo.

unzip

@Component(hint="zip")
protected org.codehaus.plexus.archiver.UnArchiver unzip

Required by AbstractGemMojo.

Is a Plexus component defined by:

role-hint:

zip

manager

@Component
protected de.saumya.mojo.ruby.gems.GemManager manager

Required by AbstractGemMojo.

buildContext

@Component
protected org.sonatype.plexus.build.incremental.BuildContext buildContext

Required by AbstractGemMojo.

Constructor Detail

HaltMojo

public HaltMojo()

Method Detail

doExecute

protected void doExecute()
                  throws IOException,
                         de.saumya.mojo.ruby.script.ScriptException

Throws:

IOException

de.saumya.mojo.ruby.script.ScriptException

execute

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

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Overrides:

execute in class de.saumya.mojo.gem.AbstractGemMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

executeWithGems

protected final void executeWithGems()
                              throws org.apache.maven.plugin.MojoExecutionException,
                                     org.apache.maven.plugin.MojoFailureException

Specified by:

executeWithGems in class de.saumya.mojo.gem.AbstractGemMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

cli

protected final void cli(String... args)
                  throws IOException,
                         de.saumya.mojo.ruby.script.ScriptException

Throws:

IOException

de.saumya.mojo.ruby.script.ScriptException

cli

protected final void cli(Iterable<String> args)
                  throws IOException,
                         de.saumya.mojo.ruby.script.ScriptException

Throws:

IOException

de.saumya.mojo.ruby.script.ScriptException