org.glassfish.maven.RunMojo Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of maven-embedded-glassfish-plugin Show documentation
Show all versions of maven-embedded-glassfish-plugin Show documentation
Maven Embedded GlassFish Plugin
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package org.glassfish.maven;
import org.apache.maven.model.Plugin;
import org.apache.maven.model.PluginExecution;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.codehaus.plexus.util.xml.Xpp3Dom;
import java.io.BufferedReader;
import java.io.File;
import java.io.InputStreamReader;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.List;
import java.util.Properties;
/**
* This Mojo starts Embedded GlassFish, executes all the 'admin' goals,
* and executes all 'deploy' goals, and waits for user's input.
*
*
* While it is waiting for user's input, the user can access the deployed applications.
*
* Upon user's input, it undeploys all the applications that were
* defined in all 'deploy' goals, and redeploys all of them.
*
* If user enters 'X' in their console for this Mojo will stop Embedded GlassFish and
* will exit.
*
* @author [email protected]
* @goal run
* @phase pre-integration-test
*/
public class RunMojo extends AbstractDeployMojo {
public void execute() throws MojoExecutionException, MojoFailureException {
List commands = getAdminCommandConfigurations();
try {
/**
* Start GlassFish server.
*/
startGlassFish(serverID, getClassLoader(), getBootStrapProperties(),
getGlassFishProperties());
/**
* Execute all 'admin' goals.
*/
for (Properties command : commands) {
runCommand(serverID, getClassLoader(),
((List) command.get("commands")).toArray(new String[0]));
}
while (true) {
List deployments = getDeploymentConfigurations();
/**
* Execute all 'deploy' goals.
*/
for (Properties deployment : deployments) {
doDeploy(serverID, getClassLoader(), getBootStrapProperties(),
getGlassFishProperties(), new File(getApp(deployment.getProperty("app"))),
getDeploymentParameters(deployment));
}
/**
* Wait for user input.
*/
System.out.println("Hit ENTER to redeploy, X to exit");
String str = new BufferedReader(new InputStreamReader(System.in)).readLine();
/**
* Undeploy all the applications deployed via 'deploy' goal.
*/
for (Properties deployment : deployments) {
doUndeploy(serverID, getClassLoader(), getBootStrapProperties(),
getGlassFishProperties(), deployment.getProperty("name"), new String[0]);
}
/**
* Exit from embedded-glassfish:run if 'X' is entered.
*/
if (str.equalsIgnoreCase("X"))
break;
}
/**
* Stop GlassFish server
*/
stopGlassFish(serverID, getClassLoader());
} catch (Exception e) {
throw new MojoExecutionException(e.getMessage(), e);
}
}
// Retrieve all the "admin" goals defined in the maven-embedded-glassfish-plugin.
private List getAdminCommandConfigurations() {
List deployments = new ArrayList();
Plugin embeddedPlugin = getPlugin("maven-embedded-glassfish-plugin");
List deployGoals = getGoals(embeddedPlugin, "admin");
for (PluginExecution pluginExecution : deployGoals) {
Properties configurations = getConfigurations(
pluginExecution, embeddedPlugin, "commands");
deployments.add(configurations);
}
return deployments;
}
// Retrieve all the "deploy" goals defined in the maven-embedded-glassfish-plugin.
private List getDeploymentConfigurations() {
List deployments = new ArrayList();
Plugin embeddedPlugin = getPlugin("maven-embedded-glassfish-plugin");
List deployGoals = getGoals(embeddedPlugin, "deploy");
for (PluginExecution pluginExecution : deployGoals) {
Properties configurations = getConfigurations(
pluginExecution, embeddedPlugin, "deploymentParams");
deployments.add(configurations);
}
return deployments;
}
/**
* From the maven project retrieve the plugin by given name.
*
* @param name Name of the plugin
* @return Plugin by given name defined in the maven project
*/
private Plugin getPlugin(String name) {
List plugins = project.getModel().getBuild().getPlugins();
for (Object plugin : plugins) {
if (((Plugin) plugin).getArtifactId().equals(name)) {
return (Plugin) plugin;
}
}
return null;
}
/**
* Get all the goals by given name in the plugin.
*
* @param plugin Plugin to which the goal belongs.
* @param goalName Name of the goals to be retrieved from the plugin
* @return List of goals by given name in the given plugin
*/
private List getGoals(Plugin plugin, String goalName) {
List executions = plugin.getExecutions();
List goals = new ArrayList();
for (Object execution : executions) {
PluginExecution pe = (PluginExecution) execution;
List allGoals = pe.getGoals();
for (Object goal : allGoals) {
if (((String) goal).equals(goalName)) {
goals.add(pe);
}
}
}
return goals;
}
private Properties getConfigurations(PluginExecution goal, Plugin plugin,
String... nonLeafNodeNames) {
Xpp3Dom config = (Xpp3Dom) plugin.getConfiguration();
// retrieve configuration options at the plugin level.
Properties configurations = getConfigurations(config);
if (nonLeafNodeNames != null) {
for (String nonLeafNodeName : nonLeafNodeNames) {
configurations.put(nonLeafNodeName, getConfigurationsAsList(
config.getChild(nonLeafNodeName)));
}
}
// retrieve configuration options at goal level.
config = (Xpp3Dom) goal.getConfiguration();
if (config != null) {
configurations.putAll(getConfigurations(config));
for (String nonLeafNodeName : nonLeafNodeNames) {
List value = (List) configurations.get(nonLeafNodeName);
value.addAll(getConfigurationsAsList(config.getChild(nonLeafNodeName)));
configurations.put(nonLeafNodeName, value);
}
}
return configurations;
}
/**
* Get all the leaf level i.e., string property-values in the given node.
*
* @param node node from which the property-values to be retrieved.
* @return all the leaf level i.e., string property-values of the given node.
*/
private Properties getConfigurations(Xpp3Dom node) {
Properties properties = new Properties();
if (node != null) {
Xpp3Dom[] configs = node.getChildren();
if (configs != null) {
for (Xpp3Dom config : configs) {
if (config.getValue() != null) { // The child is at the leaf level, so it has string prop-value.
properties.setProperty(config.getName(), config.getValue());
}
}
}
}
return properties;
}
/**
* Read the configurations that are like this:
*
*
* a=b
* x=y
*
*
* @param node Base node from where the configurations should be read.
* @return List of configurations.
*/
private List getConfigurationsAsList(Xpp3Dom node) {
List configurations = new ArrayList();
if (node != null) {
Xpp3Dom[] configs = node.getChildren();
if (configs != null) {
for (Xpp3Dom config : configs) {
if (config.getValue() != null) { // The child is at the leaf level, so it has string prop-value.
configurations.add(config.getValue());
}
}
}
}
return configurations;
}
public void runCommand(String serverId, ClassLoader cl,
String[] commandLines) throws Exception {
Class clazz = cl.loadClass(PluginUtil.class.getName());
Method m = clazz.getMethod("runCommand", new Class[]{
String.class, String[].class});
m.invoke(null, new Object[]{serverId, commandLines});
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy