scripts = new ArrayList<>();
+
+ /**
+ * The path to the server configuration to use.
+ */
+ @Parameter(alias = "server-config", property = PropertyNames.SERVER_CONFIG)
+ private String serverConfig;
+
+ /**
+ * Additional extensions of files located in {@code src/webapp} directory and its sub-directories that don't
+ * require a redeployment on update.
+ *
+ * The builtin list is {@code html, xhtml, jsp, js, css}.
+ *
+ *
+ * You can set the system property {@code wildfly.dev.web.extensions} to a white space separated list of file
+ * extensions.
+ *
+ */
+ @Parameter(property = "wildfly.dev.web.extensions", alias = "web-extensions")
+ private List webExtensions = new ArrayList<>();
+
+ /**
+ * File patterns that we should ignore during watch.
+ *
+ * Hidden files and files ending with '~' are ignored.
+ *
+ *
+ * You can set the system property {@code wildfly.dev.ignore.patterns} to a white space separated list of file
+ * patterns.
+ *
+ */
+ @Parameter(property = "wildfly.dev.ignore.patterns", alias = "ignore-patterns")
+ private List ignorePatterns = new ArrayList<>();
+ // Lazily loaded list of patterns based on the ignorePatterns
+ private final List ignoreUpdatePatterns = new ArrayList<>();
+
+ @Override
+ public void execute() throws MojoExecutionException, MojoFailureException {
+ final var packageType = PackageType.resolve(project);
+ if (!"war".equals(packageType.getPackaging())) {
+ throw new MojoExecutionException("The dev goal only works for WAR deployments");
+ }
+ // Start the container
+ final ServerContext context = startServer(ServerType.STANDALONE);
+ // Do we need to build first?
+ if (needsCompile()) {
+ triggerResources();
+ triggerCompile();
+ triggerExplodeWar();
+ }
+ try (final WatchService watcher = FileSystems.getDefault().newWatchService()) {
+ final CompiledSourceHandler sourceHandler = new CompiledSourceHandler();
+ registerDir(watcher, Path.of(project.getBuild().getSourceDirectory()), sourceHandler);
+ for (Resource resource : project.getResources()) {
+ registerDir(watcher, Path.of(resource.getDirectory()), new ResourceHandler());
+ }
+ registerDir(watcher, resolveWebAppSourceDir(), new WebAppResourceHandler(webExtensions));
+ try (ModelControllerClient client = createClient()) {
+ // Execute commands before the deployment is done
+ final CommandConfiguration cmdConfig = CommandConfiguration.of(this::createClient, this::getClientConfiguration)
+ .addCommands(commands)
+ .addScripts(scripts)
+ .setJBossHome(context.jbossHome())
+ .setFork(true)
+ .setStdout("none")
+ .setTimeout(timeout)
+ .build();
+ commandExecutor.execute(cmdConfig, mavenRepoManager);
+ final DeploymentManager deploymentManager = DeploymentManager.Factory.create(client);
+ final Deployment deployment = getDeploymentContent();
+ try {
+ final DeploymentResult result = deploymentManager.forceDeploy(deployment);
+ if (!result.successful()) {
+ throw new MojoExecutionException("Failed to deploy content: " + result.getFailureMessage());
+ }
+ watch(watcher, deploymentManager, deployment);
+ } finally {
+ deploymentManager.undeploy(UndeployDescription.of(deployment));
+ ServerHelper.shutdownStandalone(client);
+ }
+ }
+ } catch (IOException e) {
+ throw new MojoExecutionException(e.getLocalizedMessage(), e);
+ } finally {
+ context.process().destroyForcibly();
+ }
+ }
+
+ @Override
+ public String goal() {
+ return "dev";
+ }
+
+ @Override
+ protected CommandBuilder createCommandBuilder(final Path jbossHome) throws MojoExecutionException {
+ return createStandaloneCommandBuilder(jbossHome, serverConfig);
+ }
+
+ /**
+ * Allows the {@linkplain #webExtensions} to be set as a string.
+ *
+ * @param webExtensions a whitespace delimited string for the web file extensions
+ */
+ @SuppressWarnings("unused")
+ public void setWebExtensions(final String webExtensions) {
+ this.webExtensions = Utils.splitArguments(webExtensions);
+ }
+
+ /**
+ * Allows the {@linkplain #ignorePatterns} to be set as a string.
+ *
+ * @param ignorePatterns a whitespace delimited string for the file patterns
+ */
+ @SuppressWarnings("unused")
+ public void setIgnorePatterns(final String ignorePatterns) {
+ this.ignorePatterns = Utils.splitArguments(ignorePatterns);
+ }
+
+ private boolean registerDir(final WatchService watcher, final Path dir, final WatchHandler handler) throws IOException {
+ if (Files.exists(dir) && Files.isDirectory(dir)) {
+ final int currentSize = watchedDirectories.size();
+ final Set registered = watchedDirectories.values()
+ .stream()
+ .map(WatchContext::directory)
+ .collect(Collectors.toCollection(HashSet::new));
+ Files.walkFileTree(dir, new SimpleFileVisitor<>() {
+ @Override
+ public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) throws IOException {
+ if (!project.getBuild().getOutputDirectory().equals(dir.toString())) {
+ if (registered.add(dir)) {
+ final WatchKey key = dir.register(watcher, ENTRY_CREATE, ENTRY_DELETE, ENTRY_MODIFY);
+ watchedDirectories.put(key, WatchContext.of(dir, handler));
+ debug("Watching for changes in %s", dir);
+ }
+ return FileVisitResult.CONTINUE;
+ } else {
+ return FileVisitResult.SKIP_SUBTREE;
+ }
+ }
+ });
+ return currentSize == watchedDirectories.size();
+ }
+ return false;
+ }
+
+ @SuppressWarnings("InfiniteLoopStatement")
+ private void watch(final WatchService watcher, final DeploymentManager deploymentManager, final Deployment deployment) {
+ final var projectDir = project.getBasedir().toPath();
+ try {
+ for (; ; ) {
+ WatchKey key = watcher.take();
+ for (WatchEvent event : key.pollEvents()) {
+ WatchEvent.Kind kind = event.kind();
+ if (kind == OVERFLOW) {
+ continue;
+ }
+ @SuppressWarnings("unchecked")
+ final WatchEvent ev = (WatchEvent) event;
+ debug("File changed [%s]: %s", ev.kind().name(), ev.context());
+ final Path absolutePath = getPath(key, ev.context());
+ if (absolutePath == null) {
+ continue;
+ }
+ final var eventPath = absolutePath.getFileName();
+ try {
+ if (isIgnoredChange(eventPath)) {
+ debug("Ignoring change for %s", eventPath);
+ continue;
+ }
+ } catch (IOException ex) {
+ debug("Failed checking %s for ignored state: %s", eventPath, ex);
+ }
+ try {
+ final var context = watchedDirectories.get(key);
+ if (context == null) {
+ getLog().warn(String.format("Failed to find context for %s", ev.context()));
+ continue;
+ }
+ final var relativePath = projectDir.relativize(absolutePath);
+ if (ev.kind() == ENTRY_DELETE) {
+ // Undeploy application as Windows won't be able to delete the directory
+ DeploymentResult deploymentResult = deploymentManager.undeploy(UndeployDescription.of(deployment));
+ if (!deploymentResult.successful()) {
+ getLog().warn(String.format("Failed to undeploy application. Unexpected results may occur. Failure: %s",
+ deploymentResult.getFailureMessage()));
+ } else {
+ // Clean the deployment directory
+ final Path path = resolveWarDir();
+ deleteRecursively(path);
+ triggerResources();
+ triggerCompile();
+ triggerExplodeWar();
+ deploymentResult = deploymentManager.deploy(deployment);
+ if (!deploymentResult.successful()) {
+ throw new MojoExecutionException("Failed to deploy content: " + deploymentResult.getFailureMessage());
+ }
+ if (Files.notExists(context.directory())) {
+ watchedDirectories.remove(key);
+ key.cancel();
+ }
+ continue;
+ }
+ } else if (ev.kind() == ENTRY_CREATE) {
+ // If this is a directory we need to add the directory
+ if (Files.isDirectory(eventPath)) {
+ if (registerDir(watcher, eventPath, context.handler())) {
+ debug("New directory registered: %s", relativePath);
+ }
+ } else {
+ final Path parent = absolutePath.getParent();
+ if (parent != null) {
+ if (registerDir(watcher, parent, context.handler())) {
+ debug("New directory registered: %s", relativePath);
+ }
+ }
+ debug("A new source file has been created: %s", relativePath);
+ }
+ } else if (ev.kind() == ENTRY_MODIFY) {
+ debug("Source file modified: %s", relativePath);
+ }
+ // Handle the file
+ final var result = context.handle(ev, absolutePath);
+ if (result.requiresRecompile()) {
+ triggerCompile();
+ }
+ if (result.requiresCopyResources()) {
+ triggerResources();
+ }
+ if (result.requiresRepackage()) {
+ triggerExplodeWar();
+ }
+ if (result.requiresRedeploy()) {
+ final DeploymentResult deploymentResult = deploymentManager.redeployToRuntime(deployment);
+ if (!deploymentResult.successful()) {
+ throw new MojoExecutionException("Failed to deploy content: " + deploymentResult.getFailureMessage());
+ }
+ }
+ } catch (Exception ex) {
+ getLog().error("Exception handling file change: " + ex);
+ }
+ }
+ key.reset();
+ }
+ } catch (ClosedWatchServiceException ex) {
+ // OK Can ignore, we have been closed by shutdown hook.
+ } catch (InterruptedException e) {
+ throw new RuntimeException("Interrupted during watch.", e);
+ }
+ }
+
+ private void triggerCompile() throws MojoExecutionException {
+ // Compile the Java sources if needed
+ final String compilerPluginKey = ORG_APACHE_MAVEN_PLUGINS + ":" + MAVEN_COMPILER_PLUGIN;
+ final Plugin compilerPlugin = project.getPlugin(compilerPluginKey);
+ if (compilerPlugin != null) {
+ executeGoal(project, compilerPlugin, ORG_APACHE_MAVEN_PLUGINS, MAVEN_COMPILER_PLUGIN, MAVEN_COMPILER_GOAL, getPluginConfig(compilerPlugin, MAVEN_COMPILER_GOAL));
+ }
+ }
+
+ private void triggerExplodeWar() throws MojoExecutionException {
+ // Compile the Java sources if needed
+ final String warPluginKey = ORG_APACHE_MAVEN_PLUGINS + ":" + MAVEN_WAR_PLUGIN;
+ final Plugin warPlugin = project.getPlugin(warPluginKey);
+ if (warPlugin != null) {
+ executeGoal(project, warPlugin, ORG_APACHE_MAVEN_PLUGINS, MAVEN_WAR_PLUGIN, MAVEN_EXPLODED_GOAL, getPluginConfig(warPlugin));
+ } else {
+ getLog().warn("Can't package war application, war plugin not found");
+ }
+ }
+
+ private void triggerResources() throws MojoExecutionException {
+ List resources = project.getResources();
+ if (resources.isEmpty()) {
+ return;
+ }
+ Plugin resourcesPlugin = project.getPlugin(ORG_APACHE_MAVEN_PLUGINS + ":" + MAVEN_RESOURCES_PLUGIN);
+ if (resourcesPlugin == null) {
+ return;
+ }
+ executeGoal(project, resourcesPlugin, ORG_APACHE_MAVEN_PLUGINS, MAVEN_RESOURCES_PLUGIN, MAVEN_RESOURCES_GOAL, getPluginConfig(resourcesPlugin, MAVEN_RESOURCES_GOAL));
+ }
+
+ private Path getPath(final WatchKey key, final Path fileName) {
+ final WatchContext context = watchedDirectories.get(key);
+ if (context == null) {
+ getLog().debug("No more watching key, ignoring change done to " + fileName);
+ return null;
+ } else {
+ final Path resolved = context.directory().resolve(fileName);
+ // Fully ignore target dir
+ if (Path.of(project.getBuild().getDirectory()).equals(resolved)) {
+ return null;
+ }
+ return resolved;
+ }
+
+ }
+
+ private boolean needsCompile() {
+ // Check if compiling is going to be done by a previous goal
+ boolean compileNeeded = true;
+ for (String goal : mavenSession.getGoals()) {
+ if (POST_COMPILE_PHASES.contains(goal)) {
+ compileNeeded = false;
+ break;
+ }
+ if (goal.endsWith("wildfly:" + goal())) {
+ break;
+ }
+ }
+ return compileNeeded;
+ }
+
+ private void executeGoal(final MavenProject project, final Plugin plugin, final String groupId, final String artifactId, final String goal, final Xpp3Dom config) throws MojoExecutionException {
+ executeMojo(plugin(groupId(groupId), artifactId(artifactId), version(plugin.getVersion()), plugin.getDependencies()), MojoExecutor.goal(goal), config, executionEnvironment(project, mavenSession, pluginManager));
+ }
+
+ private Xpp3Dom getPluginConfig(final Plugin plugin, final String goal) throws MojoExecutionException {
+ Xpp3Dom mergedConfig = null;
+ if (!plugin.getExecutions().isEmpty()) {
+ for (PluginExecution exec : plugin.getExecutions()) {
+ if (exec.getConfiguration() != null && exec.getGoals().contains(goal)) {
+ mergedConfig = mergedConfig == null ? (Xpp3Dom) exec.getConfiguration() : Xpp3Dom.mergeXpp3Dom(mergedConfig, (Xpp3Dom) exec.getConfiguration(), true);
+ }
+ }
+ }
+
+ if (plugin.getConfiguration() != null) {
+ mergedConfig = mergedConfig == null ? (Xpp3Dom) plugin.getConfiguration() : Xpp3Dom.mergeXpp3Dom(mergedConfig, (Xpp3Dom) plugin.getConfiguration(), true);
+ }
+
+ final Xpp3Dom configuration = configuration();
+
+ if (mergedConfig != null) {
+ Set supportedParams = null;
+ // Filter out `test*` configurations
+ for (Xpp3Dom child : mergedConfig.getChildren()) {
+ if (child.getName().startsWith("test")) {
+ continue;
+ }
+ if (supportedParams == null) {
+ supportedParams = getMojoDescriptor(plugin, goal).getParameterMap().keySet();
+ }
+ if (supportedParams.contains(child.getName())) {
+ configuration.addChild(child);
+ }
+ }
+ }
+
+ return configuration;
+ }
+
+ private Xpp3Dom getPluginConfig(final Plugin plugin) {
+
+ final Xpp3Dom configuration = configuration();
+
+ final Xpp3Dom pluginConfiguration = (Xpp3Dom) plugin.getConfiguration();
+ if (pluginConfiguration != null) {
+ //Filter out `test*` configurations
+ for (Xpp3Dom child : pluginConfiguration.getChildren()) {
+ if (!child.getName().startsWith("test") && !child.getName().startsWith("failOnMissingWebXml")) {
+ configuration.addChild(child);
+ }
+ }
+ }
+
+ final MojoExecutor.Element e = new MojoExecutor.Element("webappDirectory", resolveWarDir().toAbsolutePath()
+ .toString());
+ configuration.addChild(e.toDom());
+ return configuration;
+ }
+
+ // Required to retrieve the actual set of supported configuration items.
+ private MojoDescriptor getMojoDescriptor(Plugin plugin, String goal) throws MojoExecutionException {
+ try {
+ return pluginManager.getMojoDescriptor(plugin, goal, repositories, session);
+ } catch (Exception e) {
+ throw new MojoExecutionException("Failed to obtain descriptor for Maven plugin " + plugin.getId() + " goal " + goal, e);
+ }
+ }
+
+ private boolean isIgnoredChange(final Path file) throws IOException {
+ if (isHiddenFile(file) || file.getFileName().toString().endsWith("~")) {
+ return true;
+ }
+ for (Pattern pattern : getPatterns()) {
+ if (pattern.matcher(file.getFileName().toString()).matches()) {
+ return true;
+ }
+ }
+ return false;
+ }
+
+ private boolean isHiddenFile(final Path p) throws IOException {
+ if (Environment.isWindows()) {
+ final DosFileAttributes dosAttrs = Files.readAttributes(p, DosFileAttributes.class);
+ return dosAttrs.isHidden();
+ } else {
+ return Files.isHidden(p);
+ }
+ }
+
+ private List getPatterns() {
+ if (!ignorePatterns.isEmpty()) {
+ if (ignoreUpdatePatterns.isEmpty()) {
+ for (String p : ignorePatterns) {
+ Pattern pattern = Pattern.compile(p);
+ ignoreUpdatePatterns.add(pattern);
+ }
+ }
+ }
+ return ignoreUpdatePatterns;
+ }
+
+ private Deployment getDeploymentContent() {
+ final PackageType packageType = PackageType.resolve(project);
+ final Deployment deployment = Deployment.of(resolveWarDir());
+ final String filename;
+ //if (this.filename == null) {
+ filename = String.format("%s.%s", project.getBuild().getFinalName(), packageType.getFileExtension());
+ //} else {
+ //filename = this.filename;
+ //}
+ return deployment.setRuntimeName(filename);
+ }
+
+ private Path resolveWebAppSourceDir() {
+ final String warPluginKey = ORG_APACHE_MAVEN_PLUGINS + ":" + MAVEN_WAR_PLUGIN;
+ final Plugin warPlugin = project.getPlugin(warPluginKey);
+ Xpp3Dom dom = getPluginConfig(warPlugin);
+ final Xpp3Dom warSourceDirectory = dom.getChild("warSourceDirectory");
+ if (warSourceDirectory == null) {
+ return project.getBasedir().toPath().resolve("src").resolve("main").resolve("webapp");
+ }
+ return Path.of(warSourceDirectory.getValue());
+ }
+
+ private Path resolveWarDir() {
+ return Path.of(project.getBuild().getDirectory()).resolve(project.getBuild().getFinalName());
+ }
+
+ private void debug(final String format, final Object... args) {
+ getLog().debug(String.format("[WATCH] " + format, args));
+ }
+
+ private static void deleteRecursively(final Path path) throws IOException {
+ if (Files.isDirectory(path)) {
+ Files.walkFileTree(path, new SimpleFileVisitor<>() {
+
+ @Override
+ public FileVisitResult visitFile(final Path file, final BasicFileAttributes attrs) throws IOException {
+ Files.delete(file);
+ return FileVisitResult.CONTINUE;
+ }
+
+ @Override
+ public FileVisitResult postVisitDirectory(final Path dir, final IOException exc) throws IOException {
+ Files.delete(dir);
+ return FileVisitResult.CONTINUE;
+ }
+ });
+ } else if (Files.exists(path)) {
+ Files.delete(path);
+ }
+ }
+}
diff --git a/plugin/src/main/java/org/wildfly/plugin/dev/ResourceHandler.java b/plugin/src/main/java/org/wildfly/plugin/dev/ResourceHandler.java
new file mode 100644
index 00000000..fe88349f
--- /dev/null
+++ b/plugin/src/main/java/org/wildfly/plugin/dev/ResourceHandler.java
@@ -0,0 +1,50 @@
+/*
+ * JBoss, Home of Professional Open Source.
+ *
+ * Copyright 2023 Red Hat, Inc., and individual contributors
+ * as indicated by the @author tags.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.wildfly.plugin.dev;
+
+import java.io.IOException;
+import java.nio.file.Path;
+import java.nio.file.WatchEvent;
+
+/**
+ * @author James R. Perkins
+ */
+class ResourceHandler implements WatchHandler {
+
+ @Override
+ public Result handle(final WatchContext context, final WatchEvent event, final Path file) throws IOException {
+ return new Result() {
+ @Override
+ public boolean requiresCopyResources() {
+ return true;
+ }
+
+ @Override
+ public boolean requiresRepackage() {
+ return true;
+ }
+
+ @Override
+ public boolean requiresRedeploy() {
+ return true;
+ }
+ };
+ }
+}
diff --git a/plugin/src/main/java/org/wildfly/plugin/dev/WatchContext.java b/plugin/src/main/java/org/wildfly/plugin/dev/WatchContext.java
new file mode 100644
index 00000000..f3ef6966
--- /dev/null
+++ b/plugin/src/main/java/org/wildfly/plugin/dev/WatchContext.java
@@ -0,0 +1,61 @@
+/*
+ * JBoss, Home of Professional Open Source.
+ *
+ * Copyright 2023 Red Hat, Inc., and individual contributors
+ * as indicated by the @author tags.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.wildfly.plugin.dev;
+
+import java.io.IOException;
+import java.nio.file.Path;
+import java.nio.file.WatchEvent;
+
+import org.apache.maven.plugin.MojoExecutionException;
+
+/**
+ * @author James R. Perkins
+ */
+class WatchContext implements Comparable {
+ private final Path directory;
+ private final WatchHandler handler;
+
+ private WatchContext(final Path directory, final WatchHandler handler) {
+ this.directory = directory;
+ this.handler = handler;
+ }
+
+ static WatchContext of(final Path directory, final WatchHandler handler) {
+ return new WatchContext(directory, handler);
+ }
+
+ Path directory() {
+ return directory;
+ }
+
+ WatchHandler handler() {
+ return handler;
+ }
+
+ // TODO (jrp) should this just go away?
+ WatchHandler.Result handle(final WatchEvent event, final Path file) throws MojoExecutionException, IOException {
+ return handler.handle(this, event, directory.resolve(file));
+ }
+
+ @Override
+ public int compareTo(final WatchContext o) {
+ return directory().compareTo(o.directory());
+ }
+}
diff --git a/plugin/src/main/java/org/wildfly/plugin/dev/WatchHandler.java b/plugin/src/main/java/org/wildfly/plugin/dev/WatchHandler.java
new file mode 100644
index 00000000..8ecd58ce
--- /dev/null
+++ b/plugin/src/main/java/org/wildfly/plugin/dev/WatchHandler.java
@@ -0,0 +1,79 @@
+/*
+ * JBoss, Home of Professional Open Source.
+ *
+ * Copyright 2023 Red Hat, Inc., and individual contributors
+ * as indicated by the @author tags.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.wildfly.plugin.dev;
+
+import java.io.IOException;
+import java.nio.file.Path;
+import java.nio.file.WatchEvent;
+
+import org.apache.maven.plugin.MojoExecutionException;
+
+/**
+ * A handler for changes that happen to source files.
+ *
+ * @author James R. Perkins
+ */
+public interface WatchHandler {
+
+
+ Result handle(WatchContext context, WatchEvent event, Path file) throws IOException, MojoExecutionException;
+
+ /**
+ * The result of handling the changed source file.
+ */
+ interface Result {
+
+ /**
+ * Indicates whether a recompile is required.
+ *
+ * @return {@code true} if a recompile is required
+ */
+ default boolean requiresRecompile() {
+ return false;
+ }
+
+ /**
+ * Indicates whether the deployment should be redeployed is required.
+ *
+ * @return {@code true} if the deployment should be redeployed is required
+ */
+ default boolean requiresRedeploy() {
+ return false;
+ }
+
+ /**
+ * Indicates whether the resources should be copied.
+ *
+ * @return {@code true} if the resources should be copied
+ */
+ default boolean requiresCopyResources() {
+ return false;
+ }
+
+ /**
+ * Indicates whether the deployment should be repackaged.
+ *
+ * @return {@code true} if the deployment should be repackaged
+ */
+ default boolean requiresRepackage() {
+ return false;
+ }
+ }
+}
diff --git a/plugin/src/main/java/org/wildfly/plugin/dev/WebAppResourceHandler.java b/plugin/src/main/java/org/wildfly/plugin/dev/WebAppResourceHandler.java
new file mode 100644
index 00000000..0eba356d
--- /dev/null
+++ b/plugin/src/main/java/org/wildfly/plugin/dev/WebAppResourceHandler.java
@@ -0,0 +1,72 @@
+/*
+ * JBoss, Home of Professional Open Source.
+ *
+ * Copyright 2023 Red Hat, Inc., and individual contributors
+ * as indicated by the @author tags.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.wildfly.plugin.dev;
+
+import java.io.IOException;
+import java.nio.file.Path;
+import java.nio.file.WatchEvent;
+import java.util.Collection;
+import java.util.HashSet;
+import java.util.Locale;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+/**
+ * @author James R. Perkins
+ */
+class WebAppResourceHandler implements WatchHandler {
+ private static final Set NO_DEPLOYMENT_WEB_FILE_EXTENSIONS = Set.of(
+ ".xhtml",
+ ".html",
+ ".jsp",
+ ".js",
+ ".css"
+ );
+
+ private final Set ignoredFileExtensions;
+
+ WebAppResourceHandler(final Collection ignoredFileExtensions) {
+ this.ignoredFileExtensions = ignoredFileExtensions.stream()
+ .map((value) -> value.charAt(0) == '.' ? value : "." + value)
+ .collect(Collectors.toCollection(HashSet::new));
+ this.ignoredFileExtensions.addAll(NO_DEPLOYMENT_WEB_FILE_EXTENSIONS);
+ }
+
+ @Override
+ public Result handle(final WatchContext context, final WatchEvent event, final Path file) throws IOException {
+ // Check the file extension to see if a redeploy should be ignored
+ final String fileName = file.getFileName().toString();
+ final int dot = fileName.lastIndexOf('.');
+ final boolean requiresRedeploy = dot <= 0 ||
+ !ignoredFileExtensions.contains(fileName.substring(dot).toLowerCase(Locale.ROOT));
+ return new Result() {
+
+ @Override
+ public boolean requiresRepackage() {
+ return true;
+ }
+
+ @Override
+ public boolean requiresRedeploy() {
+ return requiresRedeploy;
+ }
+ };
+ }
+}
diff --git a/plugin/src/main/java/org/wildfly/plugin/server/AbstractServerStartMojo.java b/plugin/src/main/java/org/wildfly/plugin/server/AbstractServerStartMojo.java
new file mode 100644
index 00000000..147b6bb2
--- /dev/null
+++ b/plugin/src/main/java/org/wildfly/plugin/server/AbstractServerStartMojo.java
@@ -0,0 +1,415 @@
+/*
+ * JBoss, Home of Professional Open Source.
+ *
+ * Copyright 2023 Red Hat, Inc., and individual contributors
+ * as indicated by the @author tags.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.wildfly.plugin.server;
+
+import java.io.File;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.List;
+import java.util.Map;
+
+import org.apache.maven.execution.MavenSession;
+import org.apache.maven.plugin.MojoExecutionException;
+import org.apache.maven.plugin.MojoFailureException;
+import org.apache.maven.plugin.logging.Log;
+import org.apache.maven.plugins.annotations.Component;
+import org.apache.maven.plugins.annotations.Parameter;
+import org.apache.maven.project.MavenProject;
+import org.eclipse.aether.RepositorySystem;
+import org.eclipse.aether.RepositorySystemSession;
+import org.eclipse.aether.repository.RemoteRepository;
+import org.jboss.as.controller.client.ModelControllerClient;
+import org.jboss.as.controller.client.helpers.domain.DomainClient;
+import org.jboss.galleon.ProvisioningException;
+import org.jboss.galleon.maven.plugin.util.MavenArtifactRepositoryManager;
+import org.jboss.galleon.universe.maven.repo.MavenRepoManager;
+import org.wildfly.core.launcher.CommandBuilder;
+import org.wildfly.core.launcher.DomainCommandBuilder;
+import org.wildfly.core.launcher.Launcher;
+import org.wildfly.core.launcher.StandaloneCommandBuilder;
+import org.wildfly.plugin.common.AbstractServerConnection;
+import org.wildfly.plugin.common.Environment;
+import org.wildfly.plugin.common.PropertyNames;
+import org.wildfly.plugin.common.StandardOutput;
+import org.wildfly.plugin.common.Utils;
+import org.wildfly.plugin.core.GalleonUtils;
+import org.wildfly.plugin.core.MavenRepositoriesEnricher;
+import org.wildfly.plugin.core.ServerHelper;
+
+/**
+ * @author James R. Perkins
+ */
+public abstract class AbstractServerStartMojo extends AbstractServerConnection {
+
+ @Component
+ protected RepositorySystem repoSystem;
+
+ @Parameter(defaultValue = "${repositorySystemSession}", readonly = true, required = true)
+ protected RepositorySystemSession session;
+
+ @Parameter(defaultValue = "${project.remoteProjectRepositories}", readonly = true, required = true)
+ protected List repositories;
+
+ @Parameter(defaultValue = "${project}", readonly = true, required = true)
+ protected MavenProject project;
+
+ @Parameter(defaultValue = "${session}", readonly = true, required = true)
+ protected MavenSession mavenSession;
+ /**
+ * The target directory the application to be deployed is located.
+ */
+ @Parameter(defaultValue = "${project.build.directory}", readonly = true, required = true)
+ private File targetDir;
+
+ /**
+ * The WildFly Application Server's home directory. If not used, WildFly will be downloaded.
+ */
+ @Parameter(alias = "jboss-home", property = PropertyNames.JBOSS_HOME)
+ private String jbossHome;
+
+ /**
+ * The feature pack location. See the documentation
+ * for details on how to format a feature pack location.
+ *
+ * Note that if you define the version in the feature pack location, e.g. {@code #26.1.1.Final}, the {@code version}
+ * configuration parameter should be left blank.
+ *
+ */
+ @Parameter(alias = "feature-pack-location", property = PropertyNames.WILDFLY_FEATURE_PACK_LOCATION)
+ private String featurePackLocation;
+
+ /**
+ * The version of the WildFly default server to install in case no jboss-home has been set
+ * and no server has previously been provisioned.
+ *
+ * The latest stable version is resolved if left blank.
+ *
+ */
+ @Parameter(property = PropertyNames.WILDFLY_VERSION)
+ private String version;
+
+ /**
+ * The directory name inside the buildDir where to provision the default server.
+ * By default the server is provisioned into the 'server' directory.
+ *
+ * @since 3.0
+ */
+ @Parameter(alias = "provisioning-dir", property = PropertyNames.WILDFLY_PROVISIONING_DIR, defaultValue = Utils.WILDFLY_DEFAULT_DIR)
+ private String provisioningDir;
+
+ /**
+ * The modules path or paths to use. A single path can be used or multiple paths by enclosing them in a paths
+ * element.
+ */
+ @Parameter(alias = "modules-path", property = PropertyNames.MODULES_PATH)
+ private ModulesPath modulesPath;
+
+ /**
+ * The JVM options to use.
+ */
+ @Parameter(alias = "java-opts", property = PropertyNames.JAVA_OPTS)
+ private String[] javaOpts;
+
+ /**
+ * The {@code JAVA_HOME} to use for launching the server.
+ */
+ @Parameter(alias = "java-home", property = PropertyNames.JAVA_HOME)
+ private String javaHome;
+
+ /**
+ * Starts the server with debugging enabled.
+ */
+ @Parameter(property = "wildfly.debug", defaultValue = "false")
+ private boolean debug;
+
+ /**
+ * Sets the hostname to listen on for debugging. An {@code *} means all hosts.
+ */
+ @Parameter(property = "wildfly.debug.host", defaultValue = "*")
+ private String debugHost;
+
+ /**
+ * Sets the port the debugger should listen on.
+ */
+ @Parameter(property = "wildfly.debug.port", defaultValue = "8787")
+ private int debugPort;
+
+ /**
+ * Indicates whether the server should suspend itself until a debugger is attached.
+ */
+ @Parameter(property = "wildfly.debug.suspend", defaultValue = "false")
+ private boolean debugSuspend;
+
+ /**
+ * The path to the system properties file to load.
+ */
+ @Parameter(alias = "properties-file", property = PropertyNames.PROPERTIES_FILE)
+ private String propertiesFile;
+
+ /**
+ * The timeout value to use when starting the server.
+ */
+ @Parameter(alias = "startup-timeout", defaultValue = "60", property = PropertyNames.STARTUP_TIMEOUT)
+ private long startupTimeout;
+
+ /**
+ * The arguments to be passed to the server.
+ */
+ @Parameter(alias = "server-args", property = PropertyNames.SERVER_ARGS)
+ private String[] serverArgs;
+
+ /**
+ * Set to {@code true} if you want to skip this goal, otherwise {@code false}.
+ */
+ @Parameter(defaultValue = "false", property = PropertyNames.SKIP)
+ protected boolean skip;
+
+ /**
+ * The users to add to the server.
+ */
+ @Parameter(alias = "add-user", property = "wildfly.add-user")
+ private AddUser addUser;
+
+ /**
+ * Specifies the environment variables to be passed to the process being started.
+ *
+ *
+ * <env>
+ * <HOME>/home/wildfly/</HOME>
+ * </env>
+ *
+ *
- * Note that if you define the version in the feature pack location, e.g. {@code #26.1.1.Final}, the {@code version}
- * configuration parameter should be left blank.
- *
- */
- @Parameter(alias = "feature-pack-location", property = PropertyNames.WILDFLY_FEATURE_PACK_LOCATION)
- private String featurePackLocation;
-
- /**
- * The version of the WildFly default server to install in case no jboss-home has been set
- * and no server has previously been provisioned.
- * The latest stable version is resolved if left blank.
- */
- @Parameter(property = PropertyNames.WILDFLY_VERSION)
- private String version;
-
- /**
- * The directory name inside the buildDir where to provision the default server.
- * By default the server is provisioned into the 'server' directory.
- *
- * @since 3.0
- */
- @Parameter(alias = "provisioning-dir", property = PropertyNames.WILDFLY_PROVISIONING_DIR, defaultValue = Utils.WILDFLY_DEFAULT_DIR)
- private String provisioningDir;
-
- /**
- * The modules path or paths to use. A single path can be used or multiple paths by enclosing them in a paths
- * element.
- */
- @Parameter(alias = "modules-path", property = PropertyNames.MODULES_PATH)
- private ModulesPath modulesPath;
-
- /**
- * The JVM options to use.
- */
- @Parameter(alias = "java-opts", property = PropertyNames.JAVA_OPTS)
- private String[] javaOpts;
-
- /**
- * The {@code JAVA_HOME} to use for launching the server.
- */
- @Parameter(alias = "java-home", property = PropertyNames.JAVA_HOME)
- private String javaHome;
-
/**
* The CLI commands to execute before the deployment is deployed.
*/
@@ -168,43 +80,6 @@ public class RunMojo extends AbstractServerConnection {
@Parameter(alias = "server-config", property = PropertyNames.SERVER_CONFIG)
private String serverConfig;
- /**
- * The path to the system properties file to load.
- */
- @Parameter(alias = "properties-file", property = PropertyNames.PROPERTIES_FILE)
- private String propertiesFile;
-
- /**
- * The timeout value to use when starting the server.
- */
- @Parameter(alias = "startup-timeout", defaultValue = "60", property = PropertyNames.STARTUP_TIMEOUT)
- private long startupTimeout;
-
- /**
- * The arguments to be passed to the server.
- */
- @Parameter(alias = "server-args", property = PropertyNames.SERVER_ARGS)
- private String[] serverArgs;
-
- /**
- * The users to add to the server.
- */
- @Parameter(alias = "add-user", property = "wildfly.add-user")
- private AddUser addUser;
-
- /**
- * Specifies the environment variables to be passed to the process being started.
- *
- *
- * <env>
- * <HOME>/home/wildfly/</HOME>
- * </env>
- *
- *
- * Note that if you define the version in the feature pack location, e.g. {@code #26.1.1.Final}, the {@code version}
- * configuration parameter should be left blank.
- *
- */
- @Parameter(alias = "feature-pack-location", property = PropertyNames.WILDFLY_FEATURE_PACK_LOCATION)
- private String featurePackLocation;
-
- /**
- * The version of the WildFly default server to install in case no jboss-home has been set
- * and no server has previously been provisioned.
- * The latest stable version is resolved if left blank.
- */
- @Parameter(alias = "version", property = PropertyNames.WILDFLY_VERSION)
- private String version;
-
- /**
- * The directory name inside the buildDir where to provision the default server.
- * By default the server is provisioned into the 'server' directory.
- *
- * @since 3.0
- */
- @Parameter(alias = "provisioning-dir", property = PropertyNames.WILDFLY_PROVISIONING_DIR, defaultValue = Utils.WILDFLY_DEFAULT_DIR)
- private String provisioningDir;
-
- /**
- * The modules path or paths to use. A single path can be used or multiple paths by enclosing them in a paths
- * element.
- */
- @Parameter(alias = "modules-path", property = PropertyNames.MODULES_PATH)
- private ModulesPath modulesPath;
-
- /**
- * The JVM options to use.
- */
- @Parameter(alias = "java-opts", property = PropertyNames.JAVA_OPTS)
- private String[] javaOpts;
-
- /**
- * The {@code JAVA_HOME} to use for launching the server.
- */
- @Parameter(alias = "java-home", property = PropertyNames.JAVA_HOME)
- private String javaHome;
+public class StartMojo extends AbstractServerStartMojo {
/**
* The path to the server configuration to use. This is only used for standalone servers.
@@ -162,28 +64,13 @@ public class StartMojo extends AbstractServerConnection {
private String hostConfig;
/**
- * The path to the system properties file to load.
- */
- @Parameter(alias = "properties-file", property = PropertyNames.PROPERTIES_FILE)
- private String propertiesFile;
-
- /**
- * The timeout value to use when starting the server.
- */
- @Parameter(alias = "startup-timeout", defaultValue = "60", property = PropertyNames.STARTUP_TIMEOUT)
- private long startupTimeout;
-
- /**
- * The arguments to be passed to the server.
- */
- @Parameter(alias = "server-args", property = PropertyNames.SERVER_ARGS)
- private String[] serverArgs;
-
- /**
- * Set to {@code true} if you want to skip server start, otherwise {@code false}.
+ * The type of server to start.
+ *
+ * {@code STANDALONE} for a standalone server and {@code DOMAIN} for a domain server.
+ *
*/
- @Parameter(defaultValue = "false", property = PropertyNames.SKIP)
- private boolean skip;
+ @Parameter(alias = "server-type", property = "wildfly.server.type", defaultValue = "STANDALONE")
+ protected ServerType serverType;
/**
* Indicates how {@code stdout} and {@code stderr} should be handled for the spawned server process. Note that
@@ -209,36 +96,6 @@ public class StartMojo extends AbstractServerConnection {
@Parameter(property = PropertyNames.STDOUT)
private String stdout;
- /**
- * The users to add to the server.
- */
- @Parameter(alias = "add-user", property = "wildfly.add-user")
- private AddUser addUser;
-
- /**
- * The type of server to start.
- *
- * {@code STANDALONE} for a standalone server and {@code DOMAIN} for a domain server.
- *
- */
- @Parameter(alias = "server-type", property = "wildfly.server.type", defaultValue = "STANDALONE")
- private ServerType serverType;
-
- private MavenRepoManager mavenRepoManager;
-
- /**
- * Specifies the environment variables to be passed to the process being started.
- *
- *
- * <env>
- * <HOME>/home/wildfly/</HOME>
- * </env>
- *
- *