io.reactiverse.vertx.maven.plugin.mojos

Class StartMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

io.reactiverse.vertx.maven.plugin.mojos.AbstractVertxMojo

io.reactiverse.vertx.maven.plugin.mojos.AbstractRunMojo

io.reactiverse.vertx.maven.plugin.mojos.StartMojo

All Implemented Interfaces:

ContextEnabled, Mojo, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

@Mojo(name="start",
      threadSafe=true,
      requiresDependencyCollection=COMPILE_PLUS_RUNTIME,
      requiresDependencyResolution=COMPILE_PLUS_RUNTIME)
public class StartMojo
extends AbstractRunMojo

This goal is used to run the vertx application in background mode, the application id will be persisted in the working directory of the project with a file name vertx-start-process.id

Author:

kameshs

Nested Class Summary

Nested classes/interfaces inherited from class io.reactiverse.vertx.maven.plugin.mojos.AbstractRunMojo

AbstractRunMojo.JavaBuildCallback, AbstractRunMojo.ResourceBuildCallback

Field Summary

Fields

Modifier and Type	Field and Description
protected String	appId the custom id that will be assigned when running vertx application, this should be unique.
protected String	classifier The artifact classifier.
protected String	runMode this parameter is used to decide which mode the application should be started, it can have two values "jar" or "exploded" default mode is "jar"

Fields inherited from class io.reactiverse.vertx.maven.plugin.mojos.AbstractRunMojo

classesDirectory, config, jvmArgs, optionalRunExtraArgs, redeploy, redeployGracePeriod, redeployScanPeriod, redeployTerminationPeriod, vertxCommand, workDirectory

Fields inherited from class io.reactiverse.vertx.maven.plugin.mojos.AbstractVertxMojo

archive, buildPluginManager, container, DEFAULT_CONF_DIR, IO_VERTX_CORE_LAUNCHER, launcher, lifecycleExecutor, mavenSession, project, projectBuildDir, remoteRepositories, repositorySystem, repositorySystemSession, scmManager, skip, skipScmMetadata, verticle, VERTX_ARG_CONF, VERTX_ARG_JAVA_OPT, VERTX_ARG_LAUNCHER_CLASS, VERTX_ARG_REDEPLOY, VERTX_ARG_REDEPLOY_GRACE_PERIOD, VERTX_ARG_REDEPLOY_SCAN_PERIOD, VERTX_ARG_REDEPLOY_TERMINATION_PERIOD, VERTX_COMMAND_START, VERTX_COMMAND_STOP, VERTX_CONFIG_FILE_JSON, VERTX_PACKAGING, VERTX_PID_FILE, VERTX_RUN_MODE_JAR, WILDCARD_CONFIG_FILES

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

ROLE

Constructor Summary

Constructors

Constructor and Description
StartMojo()

Method Summary

Modifier and Type	Method and Description
private void	appendConfigIfRequired(List<String> argsList)
private void	appendLauncherIfRequired(List<String> argsList)
private void	appendSysProperties(List<String> argsList)
private void	buildJarIfRequired(File fatjar)
void	execute()
private String	getAppId() This will compute the vertx application id that will be passed to the vertx applicaiton with "-id" option, if the appId is not found in the configuration an new UUID will be generated and assigned
private void	writePidFile(String vertxProcId)

Methods inherited from class io.reactiverse.vertx.maven.plugin.mojos.AbstractRunMojo

addClasspath, isVertxLauncher, run, scanAndLoadConfigs

Methods inherited from class io.reactiverse.vertx.maven.plugin.mojos.AbstractVertxMojo

asMavenCoordinates, computeArchive, contextualize, extractArtifactPaths, getArtifactFile, getProject, getScmManager, resolveArtifact, skipScmMetadata

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

runMode

@Parameter(alias="mode",
           property="vertx.start.mode",
           defaultValue="jar")
protected String runMode

this parameter is used to decide which mode the application should be started, it can have two values "jar" or "exploded" default mode is "jar"

appId

@Parameter(alias="appId",
           property="vertx.app.id")
protected String appId

the custom id that will be assigned when running vertx application, this should be unique. If left blank the UUID will be used to generate the id. The same id will be used to terminate the application via the "vertx:stop" goal

classifier

@Parameter(name="classifier")
protected String classifier

The artifact classifier. If not set, the plugin uses the default final name.

Constructor Detail

StartMojo

public StartMojo()

Method Detail

execute

public void execute()
             throws MojoExecutionException,
                    MojoFailureException

Specified by:

execute in interface Mojo

Overrides:

execute in class AbstractRunMojo

Throws:

MojoExecutionException

MojoFailureException

writePidFile

private void writePidFile(String vertxProcId)
                   throws MojoExecutionException

Throws:

MojoExecutionException

buildJarIfRequired

private void buildJarIfRequired(File fatjar)

appendSysProperties

private void appendSysProperties(List<String> argsList)

appendLauncherIfRequired

private void appendLauncherIfRequired(List<String> argsList)
                               throws MojoExecutionException

Throws:

MojoExecutionException

appendConfigIfRequired

private void appendConfigIfRequired(List<String> argsList)

getAppId

private String getAppId()

This will compute the vertx application id that will be passed to the vertx applicaiton with "-id" option, if the appId is not found in the configuration an new UUID will be generated and assigned

Returns:

- the application id