com.sap.cds.maven.plugin.build

Class WatchMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.sap.cds.maven.plugin.AbstractCdsMojo

com.sap.cds.maven.plugin.build.BuildMojo

com.sap.cds.maven.plugin.build.WatchMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AutoBuildMojo

@Mojo(name="watch",
      defaultPhase=NONE,
      aggregator=true)
public class WatchMojo
extends BuildMojo

Starts a CAP Java NG application and watches for changes in the CDS model. If changes are detected, the application is built and automatically restarted. Call mvn cds:watch or mvn com.sap.cds:cds-maven-plugin:watch to start the CAP Java NG application.

In order to get even faster development cycles locally, add an optional dependency to the Spring Boot Developer tools in the pom.xml. In this case the watch goal leaves the restart of the application to the developer tools, which is faster.

  <dependencies>
   ...
   <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-devtools</artifactId>
     <optional>true</optional>
     <scope>runtime</scope>
   </dependency>
   ...
 </dependencies>
 

Note: This goal can only be executed from the command line.

Since:

1.17.0

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	noStart Indicates whether the CAP Java NG application will be started or not.

Fields inherited from class com.sap.cds.maven.plugin.AbstractCdsMojo

buildContext, CDS_SERVICES_GROUPID, mojoExecution, PLUGIN_KEY, project, session, settings

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

ROLE

Constructor Summary

Constructors

Constructor and Description
WatchMojo()

Method Summary

Modifier and Type	Method and Description
protected org.apache.maven.shared.invoker.InvocationRequest	createRequest(List<String> goals)
void	execute()
protected Process	executeMaven(org.apache.maven.shared.invoker.InvocationRequest request)
protected void	executeMojo(org.apache.maven.model.Plugin plugin, String goal, org.apache.maven.model.PluginExecution pluginExec)
protected org.apache.maven.plugin.descriptor.MojoDescriptor	getMojoDescriptor(org.apache.maven.model.Plugin plugin, String goal)

Methods inherited from class com.sap.cds.maven.plugin.build.BuildMojo

executeBuild, executeGoal

Methods inherited from class com.sap.cds.maven.plugin.AbstractCdsMojo

ensureCliExecuted, findGoalExecution, findSrvProject, getReactorBaseDirectory, isCliExecuted, logDebug, logDebug, logError, logError, logError, logInfo, logWarn, logWarn, logWarn, scanDirectory, setProperty, strong

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

noStart

protected boolean noStart

Indicates whether the CAP Java NG application will be started or not. If the application start is disabled, only a cds:build is executed on changes in the CDS model.

Constructor Detail

WatchMojo

public WatchMojo()

Method Detail

execute

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

Specified by:

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

Overrides:

execute in class BuildMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

createRequest

protected org.apache.maven.shared.invoker.InvocationRequest createRequest(List<String> goals)

executeMojo

protected void executeMojo(org.apache.maven.model.Plugin plugin,
                           String goal,
                           org.apache.maven.model.PluginExecution pluginExec)
                    throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

executeMaven

protected Process executeMaven(org.apache.maven.shared.invoker.InvocationRequest request)
                        throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getMojoDescriptor

protected org.apache.maven.plugin.descriptor.MojoDescriptor getMojoDescriptor(org.apache.maven.model.Plugin plugin,
                                                                              String goal)
                                                                       throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException