ninja.maven

Class NinjaRunMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

ninja.maven.NinjaRunMojo

All Implemented Interfaces:

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

@Mojo(name="run",
      requiresDependencyResolution=COMPILE_PLUS_RUNTIME,
      defaultPhase=NONE,
      threadSafe=true)
public class NinjaRunMojo
extends org.apache.maven.plugin.AbstractMojo

Starts Ninja's SuperDevMode.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	buildOutputDirectory Directory containing the build files.
protected String	context Context path for SuperDevMode.
protected String	contextPath Deprecated.
protected List<String>	excludes Exludes in Java regex format.
protected List<String>	includes Includes in Java regex format.
protected String	jvmArgs Extra arguments to pass to the forked JVM.
protected String	mainClass Main class to run in SuperDevMode.
protected String	mode Mode for SuperDevMode.
protected List<org.apache.maven.artifact.Artifact>	pluginArtifacts
protected Integer	port Port for SuperDevMode (can also be set in conf/application.conf)
protected org.apache.maven.project.MavenProject	project
protected Long	settleDownMillis Amount of time to wait for file changes to settle down before triggering a restart in SuperDevMode.
protected boolean	skip Skip execution of this plugin.
protected Integer	sslPort SSL port for SuperDevMode (can also be set in conf/application.conf)
protected boolean	useDefaultExcludes Adds assets directory and freemarker templates to excluded files.
protected boolean	watchAllClassPathDirs Watch all directories on runtime classpath of project.
protected boolean	watchAllClassPathJars Watch all jars on runtime classpath of project.
protected File[]	watchDirs All directories to watch for changes.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
NinjaRunMojo()

Method Summary

Modifier and Type	Method and Description
protected void	alertAndStopExecutionIfDirectoryWithCompiledClassesOfThisProjectDoesNotExist(String directoryWithCompiledClassesOfThisProject)
protected DelayedRestartTrigger	buildDelayedRestartTrigger(RunClassInSeparateJvmMachine machine)
protected List<String>	buildJvmArguments()
protected RunClassInSeparateJvmMachine	buildRunClassInSeparateJvmMachine(String name, String classNameWithMainToRun, List<String> classpath, List<String> jvmArguments, File mavenBaseDir)
protected WatchAndRestartMachine	buildWatchAndRestartMachine(Set<Path> directoriesToRecursivelyWatch, Set<String> includes, Set<String> excludes, DelayedRestartTrigger restartTrigger)
void	execute()
protected List<org.apache.maven.artifact.Artifact>	getAllArtifactsComingFromNinjaStandalone(List<org.apache.maven.artifact.Artifact> artifacts) This might be a bit hacky.
protected String	getContextPath()
protected void	initMojoFromUserSubmittedParameters()

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

project

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

pluginArtifacts

@Parameter(defaultValue="${plugin.artifacts}",
           readonly=true)
protected List<org.apache.maven.artifact.Artifact> pluginArtifacts

skip

@Parameter(property="ninja.skip",
           defaultValue="false",
           required=true)
protected boolean skip

Skip execution of this plugin.

buildOutputDirectory

@Parameter(property="ninja.outputDirectory",
           defaultValue="${project.build.outputDirectory}",
           required=true)
protected String buildOutputDirectory

Directory containing the build files. For webapps this is usually something like /User/username/workspace/project/target/classes

watchDirs

@Parameter(property="ninja.watchDirs",
           required=false)
protected File[] watchDirs

All directories to watch for changes.

watchAllClassPathDirs

@Parameter(property="ninja.watchAllClassPathDirs",
           defaultValue="false",
           required=true)
protected boolean watchAllClassPathDirs

Watch all directories on runtime classpath of project. For single maven projects this usually will be identical to the buildOutputDirectory and this property is therefore redundant. However, for multi-module projects, all dependent project build output directories will be included (assuming you launched maven from parent project directory). A simple way to use this plugin and watch for changes across an entire multi-module project.

watchAllClassPathJars

@Parameter(property="ninja.watchAllClassPathJars",
           defaultValue="false",
           required=true)
protected boolean watchAllClassPathJars

Watch all jars on runtime classpath of project. A simple way to monitor all transitive dependencies and trigger a restart if they change. Since Java's filesystem monitoring API only watches directories, this property adds the parent directory of where the jar is stored and also adds an include rule to always match that jar filename. If other files in the directory of jars on your classpath (unlikely if you're using maven in a normal manner), then just be cautious you'll want to add exclude rules to not include them.

includes

@Parameter(property="ninja.includes",
           required=false)
protected List<String> includes

Includes in Java regex format. Negative regex patterns are difficult to write, so include rules are processed before exclude rules. Positive matches shortcut the matching process and that file will be included.

excludes

@Parameter(property="ninja.excludes",
           required=false)
protected List<String> excludes

Exludes in Java regex format. If you want to exclude all freemarker templates use something like (.*)ftl.html$ for instance.

useDefaultExcludes

@Parameter(property="ninja.useDefaultExcludes",
           defaultValue="true",
           required=true)
protected boolean useDefaultExcludes

Adds assets directory and freemarker templates to excluded files. These are loaded from the src directory in dev mode. Default excludes are: - "(.*)ftl\\.html$" - "File.pathSeparator + "assets" + File.separator"

context

@Parameter(property="ninja.context",
           required=false)
protected String context

Context path for SuperDevMode.

contextPath

@Deprecated
protected String contextPath

Deprecated.

mode

@Parameter(property="ninja.mode",
           defaultValue="dev",
           required=false)
protected String mode

Mode for SuperDevMode.

port

@Parameter(property="ninja.port",
           required=false)
protected Integer port

Port for SuperDevMode (can also be set in conf/application.conf)

sslPort

@Parameter(property="ninja.ssl.port",
           required=false)
protected Integer sslPort

SSL port for SuperDevMode (can also be set in conf/application.conf)

mainClass

@Parameter(property="ninja.mainClass",
           required=false)
protected String mainClass

Main class to run in SuperDevMode. Defaults to default standalone class in Ninja.

jvmArgs

@Parameter(property="ninja.jvmArgs",
           required=false)
protected String jvmArgs

Extra arguments to pass to the forked JVM. If you keep your arguments fairly simple, they should be tokenized (split) correctly. Uses excellent DrJava ArgumentTokenizer class for splitting line into separate arguments.

settleDownMillis

@Parameter(property="ninja.settleDownMillis",
           defaultValue="500",
           required=false)
protected Long settleDownMillis

Amount of time to wait for file changes to settle down before triggering a restart in SuperDevMode.

Constructor Detail

NinjaRunMojo

public NinjaRunMojo()

Method Detail

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

getContextPath

protected String getContextPath()

buildDelayedRestartTrigger

protected DelayedRestartTrigger buildDelayedRestartTrigger(RunClassInSeparateJvmMachine machine)

buildWatchAndRestartMachine

protected WatchAndRestartMachine buildWatchAndRestartMachine(Set<Path> directoriesToRecursivelyWatch,
                                                             Set<String> includes,
                                                             Set<String> excludes,
                                                             DelayedRestartTrigger restartTrigger)
                                                      throws IOException

Throws:

IOException

buildRunClassInSeparateJvmMachine

protected RunClassInSeparateJvmMachine buildRunClassInSeparateJvmMachine(String name,
                                                                         String classNameWithMainToRun,
                                                                         List<String> classpath,
                                                                         List<String> jvmArguments,
                                                                         File mavenBaseDir)

buildJvmArguments

protected List<String> buildJvmArguments()

initMojoFromUserSubmittedParameters

protected void initMojoFromUserSubmittedParameters()

getAllArtifactsComingFromNinjaStandalone

protected List<org.apache.maven.artifact.Artifact> getAllArtifactsComingFromNinjaStandalone(List<org.apache.maven.artifact.Artifact> artifacts)

This might be a bit hacky. But just a little bit. We have to add ninja-standalone and all of its dependencies to the classpath, so that NinjaJetty can start. But we do not want the user to declare the dependencies inside his project pom.xml. Therefore we declare the dependency in this plugin pom.xml. But we do not want to include all of this plugin's dependencies in the classpath for NinjaJetty. Therefore this method filters everything and only adds dependencies (also transitive deps) that originate from ninja-standalone. That way we get all deps we need.

Parameters:

artifacts - A list of artifacts that will be filtered.

Returns:

All artifacts coming from artifactId "ninja-standalone" (including transitive dependencies)

alertAndStopExecutionIfDirectoryWithCompiledClassesOfThisProjectDoesNotExist

protected void alertAndStopExecutionIfDirectoryWithCompiledClassesOfThisProjectDoesNotExist(String directoryWithCompiledClassesOfThisProject)
                                                                                     throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException