io.reactiverse.vertx.maven.plugin.mojos

Class AbstractRunMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

RunMojo, StartMojo, StopMojo

public class AbstractRunMojo
extends AbstractVertxMojo

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AbstractRunMojo.JavaBuildCallback
class	AbstractRunMojo.ResourceBuildCallback

Field Summary

Fields

Modifier and Type	Field and Description
protected File	classesDirectory The maven project classes directory, defaults to target/classes
(package private) File	config This property will be passed as the -config option to vertx run.
protected List<String>	jvmArgs JVM arguments that should be associated with the forked process used to run the application.
(package private) List<String>	optionalRunExtraArgs to hold extra options that can be passed to run command
protected boolean	redeploy This property is used to enable vertx to do redeployment of the verticles in case of modifications to the sources.
(package private) long	redeployGracePeriod
(package private) long	redeployScanPeriod
(package private) long	redeployTerminationPeriod
(package private) String	vertxCommand The default command to use when calling io.vertx.core.Launcher.
(package private) File	workDirectory This property will be used as the working directory for the process when running in forked mode.

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

Method Summary

Modifier and Type	Method and Description
private void	addClassesDirectory(List<URL> classpathUrls) This will add the ${project.build.outputDirectory} to the classpath url collection
(package private) void	addClasspath(List<String> args) This add or build the classpath that will be passed to the forked process JVM i.e "-cp"
private void	addRedeployExtraArgs(List<String> argsList) This method will add the extra redeployment arguments as mentioned in
private void	addRunExtraArgs(List<String> argsList) This method will add the extra arguments required for the run either used by core Vert.x Launcher or by custom Launcher
private void	addVertxArgs(List<String> argsList) This will build the Vertx specific arguments that needs to be passed to the runnable process
private ClassLoader	buildClassLoader(Collection<URL> classPathUrls) This will build the URLClassLoader object from the collection of classpath URLS
private void	compileIfNeeded()
private List<Callable<Void>>	computeExecutionChain()
private void	computeOutputDirsWildcard(StringBuilder redeployArg) The method that will compute the Output directory wildcard that will be added to the --redeploy argument to Vert.x to trigger redeployment for scanning for changes to trigger redeployment
private void	convertYamlToJson()
private void	ensureVerticleOrLauncher()
void	execute()
private List<URL>	getClassPathUrls() This will resolve the project's test and runtime dependencies along with classes directory to the collection of classpath urls.
private void	handleRedeploy(List<String> argsList)
(package private) boolean	isVertxLauncher(String launcher) Method to check if the Launcher is AbstractVertxMojo.IO_VERTX_CORE_LAUNCHER or instance of io.vertx.core.Launcher
private boolean	isYaml(String configFile) Method to check if the file is YAML file
private void	lookForConfiguration()
private static boolean	lookupForLauncherInClassHierarchy(List<Class<?>> superClasses)
protected void	run(List<String> argsList) This method will trigger the lauch of the applicaiton as non-forked, running in same JVM as maven.
(package private) void	scanAndLoadConfigs() This method loads configuration files from `src/main/conf`.
private Callable<Void>	toTask(MojoExecution execution)

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

classesDirectory

@Parameter(defaultValue="${project.build.outputDirectory}",
           required=true)
protected File classesDirectory

The maven project classes directory, defaults to target/classes

redeploy

@Parameter(name="redeploy")
protected boolean redeploy

This property is used to enable vertx to do redeployment of the verticles in case of modifications to the sources. The redeployPattern defines the source directories that will be watched for changes to trigger redeployment

redeployScanPeriod

@Parameter(alias="redeployScanPeriod",
           property="vertx.redeploy.scan.period",
           defaultValue="1000")
long redeployScanPeriod

redeployGracePeriod

@Parameter(alias="redeployGracePeriod",
           property="vertx.redeploy.grace.period")
long redeployGracePeriod

redeployTerminationPeriod

@Parameter(alias="redeployTerminationPeriod",
           property="vertx.redeploy.termination.period",
           defaultValue="1000")
long redeployTerminationPeriod

vertxCommand

String vertxCommand

The default command to use when calling io.vertx.core.Launcher. possible commands are,

• bare
• list
• run
• start
• stop
• run

config

@Parameter(alias="config",
           property="vertx.config")
File config

This property will be passed as the -config option to vertx run. It defaults to file "src/main/config/application.json", if it exists it will passed to the vertx run

workDirectory

@Parameter(alias="workDirectory",
           property="vertx.directory",
           defaultValue="${project.basedir}")
File workDirectory

This property will be used as the working directory for the process when running in forked mode. This defaults to ${project.basedir}

jvmArgs

@Parameter(alias="jvmArgs",
           property="vertx.jvmArguments")
protected List<String> jvmArgs

JVM arguments that should be associated with the forked process used to run the application. On command line, make sure to wrap multiple values between quotes.

The additional arguments that will be passed as program arguments to the JVM, all standard vertx arguments are automatically applied.

Since:

1.0.2

optionalRunExtraArgs

List<String> optionalRunExtraArgs

to hold extra options that can be passed to run command

Constructor Detail

AbstractRunMojo

public AbstractRunMojo()

Method Detail

execute

public void execute()
             throws MojoExecutionException,
                    MojoFailureException

Throws:

MojoExecutionException

MojoFailureException

ensureVerticleOrLauncher

private void ensureVerticleOrLauncher()
                               throws MojoExecutionException

Throws:

MojoExecutionException

compileIfNeeded

private void compileIfNeeded()

addClasspath

void addClasspath(List<String> args)
           throws MojoExecutionException

This add or build the classpath that will be passed to the forked process JVM i.e "-cp"

Parameters:

args - - the forked process argument list to which the classpath will be appended

Throws:

MojoExecutionException - - any error that might occur while building or adding classpath

addClassesDirectory

private void addClassesDirectory(List<URL> classpathUrls)
                          throws IOException

This will add the ${project.build.outputDirectory} to the classpath url collection

Parameters:

classpathUrls - - the existing classpath url collection to which the ${project.build.outputDirectory} be added

Throws:

IOException - - any exception that might occur while get the classes directory as URL

addVertxArgs

private void addVertxArgs(List<String> argsList)

This will build the Vertx specific arguments that needs to be passed to the runnable process

Parameters:

argsList - - the existing collection of arguments to which the vertx arguments will be added

handleRedeploy

private void handleRedeploy(List<String> argsList)

computeOutputDirsWildcard

private void computeOutputDirsWildcard(StringBuilder redeployArg)

The method that will compute the Output directory wildcard that will be added to the --redeploy argument to Vert.x to trigger redeployment for scanning for changes to trigger redeployment

Parameters:

redeployArg - - the redeploy StringBuilder to which the values will be appended

addRedeployExtraArgs

private void addRedeployExtraArgs(List<String> argsList)

This method will add the extra redeployment arguments as mentioned in

Parameters:

argsList - - the argument list to be appended

See Also:

Live Redeploy

addRunExtraArgs

private void addRunExtraArgs(List<String> argsList)

This method will add the extra arguments required for the run either used by core Vert.x Launcher or by custom Launcher

Parameters:

argsList - the list of arguments

isVertxLauncher

boolean isVertxLauncher(String launcher)
                 throws MojoExecutionException

Method to check if the Launcher is AbstractVertxMojo.IO_VERTX_CORE_LAUNCHER or instance of io.vertx.core.Launcher

Parameters:

launcher - - the launcher class as string that needs to be checked

Returns:

true if its AbstractVertxMojo.IO_VERTX_CORE_LAUNCHER or instance of io.vertx.core.Launcher

Throws:

MojoExecutionException - - any error that might occur while checking

lookupForLauncherInClassHierarchy

private static boolean lookupForLauncherInClassHierarchy(List<Class<?>> superClasses)

run

protected void run(List<String> argsList)
            throws MojoExecutionException

This method will trigger the lauch of the applicaiton as non-forked, running in same JVM as maven.

Parameters:

argsList - - the arguments to be passed to the vertx launcher

Throws:

MojoExecutionException - - any error that might occur while starting the process

computeExecutionChain

private List<Callable<Void>> computeExecutionChain()

toTask

private Callable<Void> toTask(MojoExecution execution)

lookForConfiguration

private void lookForConfiguration()

scanAndLoadConfigs

void scanAndLoadConfigs()
                 throws MojoExecutionException

This method loads configuration files from `src/main/conf`. It uses the pattern ${basedir}/src/main/conf/application.{json/yaml/yml}. In case of YAML, the configuration is converted to JSON.

Throws:

MojoExecutionException

convertYamlToJson

private void convertYamlToJson()
                        throws MojoExecutionException

Throws:

MojoExecutionException

buildClassLoader

private ClassLoader buildClassLoader(Collection<URL> classPathUrls)

This will build the URLClassLoader object from the collection of classpath URLS

Parameters:

classPathUrls - - the classpath urls which will be used to build the URLClassLoader

Returns:

an instance of URLClassLoader

getClassPathUrls

private List<URL> getClassPathUrls()
                            throws MojoExecutionException

This will resolve the project's test and runtime dependencies along with classes directory to the collection of classpath urls. Notice that resources directory are NOT appended, as they should be copied to tha `target/classes` directory.

Returns:

@{link List} which will have all the dependencies, classes directory, resources directory etc.,

Throws:

MojoExecutionException - any error that might occur while building collection like resolution errors

isYaml

private boolean isYaml(String configFile)

Method to check if the file is YAML file

Parameters:

configFile - - the config file to be checked

Returns:

if its YAML file e.g. application.yml or application.yml