org.springframework.boot.maven

Class AbstractRunMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.springframework.boot.maven.AbstractDependencyFilterMojo

org.springframework.boot.maven.AbstractRunMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

RunMojo, StartMojo

public abstract class AbstractRunMojo
extends AbstractDependencyFilterMojo

Base class to run a Spring Boot application.

Since:

1.3.0

Author:

Phillip Webb, Stephane Nicoll, David Liu, Daniel Young, Dmytro Nosan

See Also:

RunMojo, StartMojo

Field Summary

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
void	execute()
protected java.net.URL[]	getClassPathUrls()
protected java.lang.String	getJavaExecutable() Provides access to the java binary executable, regardless of OS.
protected boolean	isFork() Specify if the application process should be forked.
protected void	logDisabledFork() Log a warning indicating that fork mode has been explicitly disabled while some conditions are present that require to enable it.
protected org.springframework.boot.maven.RunArguments	resolveApplicationArguments() Resolve the application arguments to use.
protected org.springframework.boot.maven.EnvVariables	resolveEnvVariables() Resolve the environment variables to use.
protected org.springframework.boot.maven.RunArguments	resolveJvmArguments() Resolve the JVM arguments to use.
protected abstract void	runWithForkedJvm(java.io.File workingDirectory, java.util.List<java.lang.String> args, java.util.Map<java.lang.String,java.lang.String> environmentVariables) Run with a forked VM, using the specified command line arguments.
protected abstract void	runWithMavenJvm(java.lang.String startClassName, java.lang.String... arguments) Run with the current VM, using the specified arguments.

Methods inherited from class org.springframework.boot.maven.AbstractDependencyFilterMojo

filterDependencies, getFilters, setExcludeGroupIds, setExcludes, setIncludes

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

Constructor Detail

AbstractRunMojo

public AbstractRunMojo()

Method Detail

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

isFork

protected boolean isFork()

Specify if the application process should be forked.

Returns:

true if the application process should be forked

logDisabledFork

protected void logDisabledFork()

Log a warning indicating that fork mode has been explicitly disabled while some conditions are present that require to enable it.

runWithForkedJvm

protected abstract void runWithForkedJvm(java.io.File workingDirectory,
                                         java.util.List<java.lang.String> args,
                                         java.util.Map<java.lang.String,java.lang.String> environmentVariables)
                                  throws org.apache.maven.plugin.MojoExecutionException,
                                         org.apache.maven.plugin.MojoFailureException

Run with a forked VM, using the specified command line arguments.

Parameters:

workingDirectory - the working directory of the forked JVM

args - the arguments (JVM arguments and application arguments)

environmentVariables - the environment variables

Throws:

org.apache.maven.plugin.MojoExecutionException - in case of MOJO execution errors

org.apache.maven.plugin.MojoFailureException - in case of MOJO failures

runWithMavenJvm

protected abstract void runWithMavenJvm(java.lang.String startClassName,
                                        java.lang.String... arguments)
                                 throws org.apache.maven.plugin.MojoExecutionException,
                                        org.apache.maven.plugin.MojoFailureException

Run with the current VM, using the specified arguments.

Parameters:

startClassName - the class to run

arguments - the class arguments

Throws:

org.apache.maven.plugin.MojoExecutionException - in case of MOJO execution errors

org.apache.maven.plugin.MojoFailureException - in case of MOJO failures

resolveApplicationArguments

protected org.springframework.boot.maven.RunArguments resolveApplicationArguments()

Resolve the application arguments to use.

Returns:

a RunArguments defining the application arguments

getJavaExecutable

protected java.lang.String getJavaExecutable()

Provides access to the java binary executable, regardless of OS.

Returns:

the java executable

resolveEnvVariables

protected org.springframework.boot.maven.EnvVariables resolveEnvVariables()

Resolve the environment variables to use.

Returns:

an EnvVariables defining the environment variables

resolveJvmArguments

protected org.springframework.boot.maven.RunArguments resolveJvmArguments()

Resolve the JVM arguments to use.

Returns:

a RunArguments defining the JVM arguments

getClassPathUrls

protected java.net.URL[] getClassPathUrls()
                                   throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException