org.glassfish.maven.AbstractServerMojo Maven / Gradle / Ivy
/*
* 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.artifact.Artifact;
import org.apache.maven.artifact.factory.ArtifactFactory;
import org.apache.maven.artifact.metadata.ArtifactMetadataSource;
import org.apache.maven.artifact.metadata.ResolutionGroup;
import org.apache.maven.artifact.repository.ArtifactRepository;
import org.apache.maven.artifact.resolver.ArtifactNotFoundException;
import org.apache.maven.artifact.resolver.ArtifactResolutionException;
import org.apache.maven.artifact.resolver.ArtifactResolver;
import org.apache.maven.model.Dependency;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.project.MavenProject;
import org.apache.maven.project.MavenProjectBuilder;
import java.io.File;
import java.io.FileInputStream;
import java.io.StringReader;
import java.net.URI;
import java.net.URL;
import java.net.URLClassLoader;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Properties;
/**
* @author [email protected]
*/
public abstract class AbstractServerMojo extends AbstractMojo {
// Only PluginUtil has access to org.glassfish.simpleglassfishapi.Constants
// Hence declare the param names here.
public final static String PLATFORM_KEY = "GlassFish_Platform";
public final static String INSTANCE_ROOT_PROP_NAME = "com.sun.aas.instanceRoot";
public static final String INSTALL_ROOT_PROP_NAME = "com.sun.aas.installRoot";
public static final String CONFIG_FILE_URI_PROP_NAME = "com.sun.aas.configFileURI";
private static final String NETWORK_LISTENER_KEY = "embedded-glassfish-config." +
"server.network-config.network-listeners.network-listener.%s";
public static String thisArtifactId = "org.glassfish:maven-embedded-glassfish-plugin";
private static String SHELL_JAR = "lib/embedded/glassfish-embedded-static-shell.jar";
private static String FELIX_JAR = "osgi/felix/bin/felix.jar";
private static final String EMBEDDED_GROUP_ID = "org.glassfish.extras";
private static final String EMBEDDED_ALL = "glassfish-embedded-all";
private static final String EMBEDDED_ARTIFACT_PREFIX = "glassfish-embedded-";
private static final String GF_API_GROUP_ID = "org.glassfish";
private static final String GF_API_ARTIFACT_ID = "simple-glassfish-api";
private static final String DEFAULT_GF_VERSION = "3.1-b35";
private static String gfVersion;
// private static final String UBER_JAR_URI = "org.glassfish.embedded.osgimain.jarURI";
// public static final String AUTO_START_BUNDLES =
// "org.glassfish.embedded.osgimain.autostartBundles";
/**
* The remote repositories where artifacts are located
*
* @parameter expression="${project.remoteArtifactRepositories}"
*/
protected List remoteRepositories;
/**
* @parameter expression="${serverID}" default-value="maven"
*/
protected String serverID;
/**
* @parameter expression="${port}" default-value="-1"
*/
protected int port;
/**
* @parameter expression="${installRoot}"
*/
protected String installRoot;
/**
* @parameter expression="${instanceRoot}"
*/
protected String instanceRoot;
/**
* @parameter expression="${configFile}"
*/
protected String configFile;
/**
* @parameter
*/
protected Map ports;
/**
* @parameter
*/
protected List bootstrapProperties;
/**
* @parameter
*/
protected File bootstrapPropertiesFile;
/**
* @parameter
*/
protected List glassfishProperties;
/**
* @parameter
*/
protected File glassfishPropertiesFile;
/**
* @parameter
*/
protected List systemProperties;
/**
* @parameter
*/
protected File systemPropertiesFile;
/**
* @parameter expression="${autoDelete}"
*/
protected Boolean autoDelete;
/**
* The maven project.
*
* @parameter expression="${project}"
* @required
* @readonly
*/
protected MavenProject project;
/**
* @parameter default-value="${plugin.artifacts}"
*/
private java.util.List artifacts; // pluginDependencies
/**
* @component
*/
protected MavenProjectBuilder projectBuilder;
/**
* @parameter expression="${localRepository}"
* @required
*/
protected ArtifactRepository localRepository;
/**
* @component
*/
protected ArtifactResolver resolver;
/**
* Used to construct artifacts for deletion/resolution...
*
* @component
*/
protected ArtifactFactory factory;
/**
* @parameter expression="${containerType}" default-value="all"
*/
protected String containerType;
// protected GlassFish gf;
// HashMap with Key=serverId, Value=Bootstrap ClassLoader
protected static HashMap classLoaders = new HashMap();
private static URLClassLoader classLoader;
/**
* @component
*/
private ArtifactMetadataSource artifactMetadataSource;
public abstract void execute() throws MojoExecutionException, MojoFailureException;
protected URLClassLoader getClassLoader() throws MojoExecutionException {
/*
URLClassLoader classLoader = classLoaders.get(serverID);
if (classLoader != null) {
printClassPaths("Using Existing Bootstrap ClassLoader. ServerId = " + serverID +
", ClassPaths = ", classLoader);
return classLoader;
}
try {
classLoader = hasGlassFishInstallation() ? getInstalledGFClassLoader() : getUberGFClassLoader();
classLoaders.put(serverID, classLoader);
printClassPaths("Created New Bootstrap ClassLoader. ServerId = " + serverID
+ ", ClassPaths = ", classLoader);
return classLoader;
} catch (Exception ex) {
throw new MojoExecutionException(ex.getMessage(), ex);
}
*/
try {
if (classLoader != null) {
return classLoader;
} else {
classLoader = hasGlassFishInstallation() ? getInstalledGFClassLoader() : getUberGFClassLoader();
printClassPaths("Created New Bootstrap ClassLoader. ServerId = " + serverID
+ ", ClassPaths = ", classLoader);
}
return classLoader;
} catch (Exception ex) {
throw new MojoExecutionException(ex.getMessage(), ex);
}
}
protected void cleanupClassLoader(String serverId) {
URLClassLoader cl = classLoaders.remove(serverID);
if (cl != null) {
System.out.println("Cleaned up ClassLoader for ServerID " + serverID);
}
}
private void printClassPaths(String msg, URLClassLoader classLoader) {
System.out.println(msg);
for (URL u : classLoader.getURLs()) {
System.out.println("ClassPath Element : " + u);
}
}
// checks if the glassfish installation is present in the specified installRoot
private boolean hasGlassFishInstallation() {
return installRoot != null ? new File(installRoot, SHELL_JAR).exists()
&& new File(installRoot, FELIX_JAR).exists() : false;
}
private URLClassLoader getInstalledGFClassLoader() throws Exception {
File gfJar = new File(installRoot, SHELL_JAR);
File felixJar = new File(installRoot, FELIX_JAR);
Artifact gfMvnPlugin = (Artifact) project.getPluginArtifactMap().get(thisArtifactId);
resolver.resolve(gfMvnPlugin, remoteRepositories, localRepository);
URLClassLoader classLoader = new URLClassLoader(
new URL[]{gfJar.toURI().toURL(), felixJar.toURI().toURL(), gfMvnPlugin.getFile().toURI().toURL()});
return classLoader;
}
private Artifact getUberFromSpecifiedDependency() {
if (artifacts != null) {
for (Artifact artifact : artifacts) {
if (EMBEDDED_GROUP_ID.equals(artifact.getGroupId())) {
if (artifact.getArtifactId().startsWith(EMBEDDED_ARTIFACT_PREFIX)) {
return artifact;
}
}
}
}
return null;
}
// GlassFish should be of same version as simple-glassfish-api as defined in plugin's pom.
private String getGlassfishVersion(Artifact gfMvnPlugin) throws Exception {
if(gfVersion != null) {
return gfVersion;
}
ResolutionGroup resGroup = artifactMetadataSource.retrieve(
gfMvnPlugin, localRepository, remoteRepositories);
MavenProject pomProject = projectBuilder.buildFromRepository(resGroup.getPomArtifact(),
remoteRepositories, localRepository);
List dependencies = pomProject.getOriginalModel().getDependencies();
for(Dependency dependency : dependencies) {
if(GF_API_GROUP_ID.equals(dependency.getGroupId()) &&
GF_API_ARTIFACT_ID.equals(dependency.getArtifactId())) {
gfVersion = dependency.getVersion();
}
}
gfVersion = gfVersion != null ? gfVersion : DEFAULT_GF_VERSION;
return gfVersion;
}
private URLClassLoader getUberGFClassLoader() throws Exception {
// Use the version user has configured in the plugin.
Artifact gfMvnPlugin = (Artifact) project.getPluginArtifactMap().get(thisArtifactId);
Artifact gfUber = getUberFromSpecifiedDependency();
String gfVersion = getGlassfishVersion(gfMvnPlugin);
if (gfUber == null) {
gfUber = factory.createArtifact(EMBEDDED_GROUP_ID, EMBEDDED_ALL,
gfVersion, "compile", "jar");
}
resolver.resolve(gfUber, remoteRepositories, localRepository);
try {
resolver.resolve(gfMvnPlugin, remoteRepositories, localRepository);
} catch (ArtifactResolutionException e) {
e.printStackTrace();
} catch (ArtifactNotFoundException e) {
e.printStackTrace();
}
URLClassLoader classLoader = new URLClassLoader(
new URL[]{gfUber.getFile().toURI().toURL(), gfMvnPlugin.getFile().toURI().toURL()});/* {
@Override
public Class loadClass(String name, boolean resolve) throws ClassNotFoundException {
if ("org.glassfish.maven.Util".equals(name)) {
InputStream is = getResourceAsStream(name.replace('.', '/')+".class");
byte[] buf = new byte[8192];
int count = 0;
try {
count=is.read(buf); // TODO :: read the entire class file.
} catch (IOException e) {
throw ClassNotFoundException(e.getMessage());
}
return defineClass(name, buf , 0, count);
} else {
return super.loadClass(name, resolve);
}
}
};*/
return classLoader;
}
protected Properties getGlassFishProperties() {
Properties props = new Properties();
if (instanceRoot != null) {
props.setProperty(INSTANCE_ROOT_PROP_NAME,
new File(instanceRoot).getAbsolutePath());
}
if (configFile != null) {
try {
// if it is a java.net.URI pointing to file: or jar: or http: then use it as is.
props.setProperty(CONFIG_FILE_URI_PROP_NAME, URI.create(configFile).toString());
} catch (Exception ex) {
// if the supplied parameter is not a java.net.URI, assume it is a file.
props.setProperty(CONFIG_FILE_URI_PROP_NAME, new File(configFile).toURI().toString());
}
}
if (port != -1 && configFile == null) {
String httpListener = String.format(NETWORK_LISTENER_KEY, "http-listener");
props.setProperty(httpListener + ".port", String.valueOf(port));
props.setProperty(httpListener + ".enabled", "true");
}
if (ports != null) {
for (String listenerName : ports.keySet()) {
String portNumber = ports.get(listenerName);
if (portNumber != null && portNumber.trim().length() > 0) {
String networkListener = String.format(NETWORK_LISTENER_KEY, listenerName);
props.setProperty(networkListener + ".port", portNumber);
props.setProperty(networkListener + ".enabled", "true");
}
}
}
load(glassfishPropertiesFile, props);
load(glassfishProperties, props);
return props;
}
protected Properties getBootStrapProperties() {
setSystemProperties();
Properties props = new Properties();
props.setProperty(PLATFORM_KEY, "Static");
if (installRoot != null) {
props.setProperty(INSTALL_ROOT_PROP_NAME,
new File(installRoot).getAbsolutePath());
}
load(bootstrapPropertiesFile, props);
load(bootstrapProperties, props);
return props;
}
private void load(List stringList, Properties p) {
if (p == null || stringList == null) {
return;
}
for (String prop : stringList) {
try {
p.load(new StringReader(prop));
} catch (Exception ex) {
System.err.println(ex);
}
}
}
private void load(File propertiesFile, Properties p) {
if (propertiesFile == null || p == null) {
return;
}
FileInputStream stream = null;
try {
stream = new FileInputStream(propertiesFile);
p.load(stream);
} catch (Exception ex) {
System.err.println(ex);
} finally {
if (stream != null) {
try {
stream.close();
} catch (Exception ex) {
System.err.println(ex);
}
}
}
}
private void setSystemProperties() {
Properties sysProps = new Properties();
load(systemPropertiesFile, sysProps);
load(systemProperties, sysProps);
for (Object obj : sysProps.keySet()) {
String key = (String) obj;
String currentVal = System.getProperty(key);
if (currentVal == null) {
String value = sysProps.getProperty(key);
if (value != null && value.trim().length() > 0) {
System.setProperty(key, value);
System.out.println("Set system property [" + key + " = " + value + "]");
}
}
}
}
// private String getDefaultInstallRoot() {
// Artifact gfMvnPlugin = (Artifact) project.getPluginArtifactMap().get(thisArtifactId);
// String userDir = System.getProperty("user.home");
// String fs = File.separator;
// return new File(userDir, "." + gfMvnPlugin.getArtifactId() + fs +
// gfMvnPlugin.getVersion()).getAbsolutePath();
// }
//
// private String getDefaultInstanceRoot(String installRoot) {
// String fs = File.separator;
// return new File(installRoot, "domains" + fs + "domain1").getAbsolutePath();
// }
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy