org.netbeans.modules.tomcat5.TomcatFactory Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.netbeans.modules.tomcat5;
import org.netbeans.modules.tomcat5.deploy.TomcatManager;
import java.io.File;
import java.io.IOException;
import java.lang.reflect.Method;
import java.net.MalformedURLException;
import java.net.URL;
import java.net.URLClassLoader;
import java.util.Collections;
import java.util.HashSet;
import java.util.Set;
import java.util.WeakHashMap;
import java.util.jar.JarFile;
import java.util.jar.Manifest;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import javax.enterprise.deploy.shared.factories.DeploymentFactoryManager;
import javax.enterprise.deploy.spi.DeploymentManager;
import javax.enterprise.deploy.spi.exceptions.DeploymentManagerCreationException;
import javax.enterprise.deploy.spi.factories.DeploymentFactory;
import org.netbeans.api.annotations.common.CheckForNull;
import org.netbeans.api.annotations.common.NonNull;
import org.netbeans.modules.j2ee.deployment.plugins.api.InstanceProperties;
import org.netbeans.modules.tomcat5.deploy.TomcatManager.TomEEType;
import org.netbeans.modules.tomcat5.deploy.TomcatManager.TomEEVersion;
import org.netbeans.modules.tomcat5.deploy.TomcatManager.TomcatVersion;
import org.openide.util.NbBundle;
import org.openide.util.Utilities;
/**
* Factory capable to create DeploymentManager that can deploy to Tomcat and TomEE.
*
* Tomcat URI has following format:
* tomcat[90|100]:[home=<home_path>:[base=<base_path>:]]<manager_app_url>
* for example
* tomcat:http://localhost:8080/manager/
* where paths values will be used as CATALINA_HOME and CATALINA_BASE properties and manager_app_url
* denotes URL of manager application configured on this server and has to start with http:.
* @author Petr Hejl, Radim Kubacki
*/
public final class TomcatFactory implements DeploymentFactory {
public static final String SERVER_ID_50 = "Tomcat"; // NOI18N
public static final String SERVER_ID_55 = "Tomcat55"; // NOI18N
public static final String SERVER_ID_60 = "Tomcat60"; // NOI18N
public static final String SERVER_ID_70 = "Tomcat70"; // NOI18N
public static final String SERVER_ID_80 = "Tomcat80"; // NOI18N
public static final String SERVER_ID_90 = "Tomcat90"; // NOI18N
public static final String SERVER_ID_100 = "Tomcat100"; // NOI18N
public static final String SERVER_ID_101 = "Tomcat101"; // NOI18N
public static final String SERVER_ID_110 = "Tomcat110"; // NOI18N
public static final String TOMCAT_URI_PREFIX_50 = "tomcat:"; // NOI18N
public static final String TOMCAT_URI_PREFIX_55 = "tomcat55:"; // NOI18N
public static final String TOMCAT_URI_PREFIX_60 = "tomcat60:"; // NOI18N
public static final String TOMCAT_URI_PREFIX_70 = "tomcat70:"; // NOI18N
public static final String TOMCAT_URI_PREFIX_80 = "tomcat80:"; // NOI18N
public static final String TOMCAT_URI_PREFIX_90 = "tomcat90:"; // NOI18N
public static final String TOMCAT_URI_PREFIX_100 = "tomcat100:"; // NOI18N
public static final String TOMCAT_URI_PREFIX_101 = "tomcat101:"; // NOI18N
public static final String TOMCAT_URI_PREFIX_110 = "tomcat110:"; // NOI18N
public static final String TOMCAT_URI_HOME_PREFIX = "home="; // NOI18N
public static final String TOMCAT_URI_BASE_PREFIX = ":base="; // NOI18N
static final Pattern TOMEE_JAR_PATTERN = Pattern.compile("tomee-common-(\\d+(\\.\\d+)*).*\\.jar"); // NOI18N
static final Pattern TOMEE_WEBPROFILE_JAR_PATTERN = Pattern.compile("openejb-api-(\\d+(\\.\\d+)*).*\\.jar"); // NOI18N
static final Pattern TOMEE_JAXRS_JAR_PATTERN = Pattern.compile("jettison-(\\d+(\\.\\d+)*).*\\.jar"); // NOI18N
static final Pattern TOMEE_MICROPROFILE_JAR_PATTERN = Pattern.compile("microprofile-config-api-(\\d+(\\.\\d+)*).*\\.jar"); // NOI18N
static final Pattern TOMEE_PLUS_JAR_PATTERN = Pattern.compile("activemq-protobuf-(\\d+(\\.\\d+)*).*\\.jar"); // NOI18N
static final Pattern TOMEE_PLUME_JAR_PATTERN = Pattern.compile("eclipselink-(\\d+(\\.\\d+)*).*\\.jar"); // NOI18N
private static final String GENERIC_DISCONNECTED_URI_PREFIX = "tomcat-any:"; // NOI18N
private static final String GENERIC_DISCONNECTED_URI =
GENERIC_DISCONNECTED_URI_PREFIX + "jakarta-tomcat-generic"; // NOI18N
private static final String DISCONNECTED_URI_50 = TOMCAT_URI_PREFIX_50 + "jakarta-tomcat-5.0.x"; // NOI18N
private static final String DISCONNECTED_URI_55 = TOMCAT_URI_PREFIX_55 + "jakarta-tomcat-5.5.x"; // NOI18N
private static final String DISCONNECTED_URI_60 = TOMCAT_URI_PREFIX_60 + "apache-tomcat-6.0.x"; // NOI18N
private static final String DISCONNECTED_URI_70 = TOMCAT_URI_PREFIX_70 + "apache-tomcat-7.0.x"; // NOI18N
private static final String DISCONNECTED_URI_80 = TOMCAT_URI_PREFIX_80 + "apache-tomcat-8.0.x"; // NOI18N
private static final String DISCONNECTED_URI_90 = TOMCAT_URI_PREFIX_90 + "apache-tomcat-9.0.x"; // NOI18N
private static final String DISCONNECTED_URI_100 = TOMCAT_URI_PREFIX_100 + "apache-tomcat-10.0.x"; // NOI18N
private static final String DISCONNECTED_URI_101 = TOMCAT_URI_PREFIX_101 + "apache-tomcat-10.1.x"; // NOI18N
private static final String DISCONNECTED_URI_110 = TOMCAT_URI_PREFIX_110 + "apache-tomcat-11.0.x"; // NOI18N
private static final Set DISCONNECTED_URIS = new HashSet<>();
static {
Collections.addAll(DISCONNECTED_URIS, DISCONNECTED_URI_50,
DISCONNECTED_URI_55, DISCONNECTED_URI_60, DISCONNECTED_URI_70,
DISCONNECTED_URI_80, DISCONNECTED_URI_90, DISCONNECTED_URI_100,
DISCONNECTED_URI_101, DISCONNECTED_URI_110, GENERIC_DISCONNECTED_URI);
}
private static TomcatFactory instance;
private static final WeakHashMap managerCache = new WeakHashMap();
private static final Logger LOGGER = Logger.getLogger(TomcatFactory.class.getName()); // NOI18N
private TomcatFactory() {
super();
}
public static TomcatFactory create50() {
return getInstance();
}
public static synchronized TomcatFactory getInstance() {
if (instance == null) {
instance = new TomcatFactory();
DeploymentFactoryManager.getInstance().registerDeploymentFactory(instance);
}
return instance;
}
/** Factory method to create DeploymentManager.
* @param uri URL of configured manager application.
* @param uname user with granted manager role
* @param passwd user's password
* @throws DeploymentManagerCreationException
* @return {@link TomcatManager}
*/
@Override
public DeploymentManager getDeploymentManager(String uri, String uname, String passwd)
throws DeploymentManagerCreationException {
if (!handlesURI (uri)) {
throw new DeploymentManagerCreationException ("Invalid URI:" + uri); // NOI18N
}
// Lets reuse the same instance of TomcatManager for each server instance
// during the IDE session, j2eeserver does not ensure this. Without it,
// however, we could not rely on keeping data in the member variables.
InstanceProperties ip = InstanceProperties.getInstanceProperties(uri);
if (ip == null) {
// null ip either means that the instance is not registered, or that this is the disconnected URL
if (!DISCONNECTED_URIS.contains(uri)) {
throw new DeploymentManagerCreationException("Tomcat instance: " + uri + " is not registered in the IDE."); // NOI18N
}
}
synchronized (this) {
TomcatManager tm = (TomcatManager)managerCache.get(ip);
if (tm == null) {
try {
TomcatVersion version = getTomcatVersion(uri);
tm = new TomcatManager(true, stripUriPrefix(uri, version), version);
managerCache.put(ip, tm);
} catch (IllegalArgumentException iae) {
Throwable t = new DeploymentManagerCreationException("Cannot create deployment manager for Tomcat instance: " + uri + "."); // NOI18N
throw (DeploymentManagerCreationException)(t.initCause(iae));
}
}
return tm;
}
}
@Override
public DeploymentManager getDisconnectedDeploymentManager(String uri)
throws DeploymentManagerCreationException {
// no need to distinguish beetween the connected and disconnected DM for Tomcat
return getDeploymentManager(uri, null, null);
}
@Override
public String getDisplayName() {
return NbBundle.getMessage(TomcatFactory.class, "LBL_TomcatFactory");
}
@Override
public String getProductVersion() {
return NbBundle.getMessage(TomcatFactory.class, "LBL_TomcatFactoryVersion");
}
/**
* @param str
* @return true for URIs beggining with tomcat[55|60]: prefix
*/
@Override
public boolean handlesURI(String str) {
return str != null && (str.startsWith(TOMCAT_URI_PREFIX_50)
|| str.startsWith(TOMCAT_URI_PREFIX_55)
|| str.startsWith(TOMCAT_URI_PREFIX_60)
|| str.startsWith(TOMCAT_URI_PREFIX_70)
|| str.startsWith(TOMCAT_URI_PREFIX_80)
|| str.startsWith(TOMCAT_URI_PREFIX_90)
|| str.startsWith(TOMCAT_URI_PREFIX_100)
|| str.startsWith(TOMCAT_URI_PREFIX_101)
|| str.startsWith(TOMCAT_URI_PREFIX_110));
}
/**
* Retrieve the tomcat version e.g. '9.0.70'
*
* @throws IllegalStateException if the version information cannot be retrieved
*/
public static String getTomcatVersionString(File catalinaHome) throws IllegalStateException {
File catalinaJar = new File(catalinaHome, "lib/catalina.jar"); // NOI18N
File coyoteJar = new File(catalinaHome, "lib/tomcat-coyote.jar"); // NOI18N
if (!catalinaJar.exists()) {
// For Tomcat 5/5.5
catalinaJar = new File(catalinaHome, "server/lib/catalina.jar"); // NOI18N
coyoteJar = new File(catalinaHome, "server/lib/tomcat-coyote.jar"); // NOI18N
}
try {
URLClassLoader loader = new URLClassLoader(new URL[] {
Utilities.toURI(catalinaJar).toURL(), Utilities.toURI(coyoteJar).toURL() });
Class serverInfo = loader.loadClass("org.apache.catalina.util.ServerInfo"); // NOI18N
try {
Method method = serverInfo.getMethod("getServerNumber", new Class[] {}); // NOI18N
String version = (String) method.invoke(serverInfo, new Object[] {});
return version;
} catch (NoSuchMethodException ex) {
// try getServerInfo
}
Method method = serverInfo.getMethod("getServerInfo", new Class[] {}); // NOI18N
String version = (String) method.invoke(serverInfo, new Object[] {});
int idx = version.indexOf('/');
if (idx > 0) {
return version.substring(idx + 1);
}
throw new IllegalStateException("Cannot identify the version of the server."); // NOI18N
} catch (MalformedURLException | ReflectiveOperationException e) {
throw new IllegalStateException(e);
}
}
public static TomcatVersion getTomcatVersion(File catalinaHome) throws IllegalStateException {
String version = null;
try {
// TODO we might use fallback as primary check - it might be faster
// than loading jars and executing code in JVM
version = getTomcatVersionString(catalinaHome);
} catch (IllegalStateException | UnsupportedClassVersionError ex) {
LOGGER.log(Level.INFO, null, ex);
return getTomcatVersionFallback(catalinaHome);
}
return getTomcatVersion(version, TomcatVersion.TOMCAT_80);
}
private static TomcatVersion getTomcatVersionFallback(File catalinaHome) throws IllegalStateException {
File lib = new File(catalinaHome, "common" + File.separator + "lib"); // NOI18N
if (lib.isDirectory()) {
// 5 or 5.5
File tasks = new File(catalinaHome, "bin" + File.separator + "catalina-tasks.xml"); // NOI18N
if (tasks.isFile()) {
// 5.5
return TomcatVersion.TOMCAT_55;
}
return TomcatVersion.TOMCAT_50;
} else {
// 6 or 7 or 8
File bootstrapJar = new File(catalinaHome, "bin" + File.separator + "bootstrap.jar"); // NOI18N
if (!bootstrapJar.exists()) {
return null;
}
try (JarFile jar = new JarFile(bootstrapJar)) {
Manifest manifest = jar.getManifest();
String specificationVersion = null;
if (manifest != null) {
specificationVersion = manifest.getMainAttributes()
.getValue("Specification-Version"); // NOI18N
}
if (specificationVersion != null) { // NOI18N
specificationVersion = specificationVersion.trim();
return getTomcatVersion(specificationVersion, TomcatVersion.TOMCAT_55);
}
} catch (IOException e) {
LOGGER.log(Level.FINE, null, e);
}
}
return TomcatVersion.TOMCAT_50;
}
private static TomcatVersion getTomcatVersion(String version, TomcatVersion defaultVersion) throws IllegalStateException {
if (version.startsWith("5.0.")) { // NOI18N
return TomcatVersion.TOMCAT_50;
} else if (version.startsWith("5.5.")) { // NOI18N
return TomcatVersion.TOMCAT_55;
} else if (version.startsWith("6.")) { // NOI18N
return TomcatVersion.TOMCAT_60;
} else if (version.startsWith("7.")) { // NOI18N
return TomcatVersion.TOMCAT_70;
} else if (version.startsWith("8.")) { // NOI18N
return TomcatVersion.TOMCAT_80;
} else if (version.startsWith("9.")) { // NOI18N
return TomcatVersion.TOMCAT_90;
} else if (version.startsWith("10.0")) { // NOI18N
return TomcatVersion.TOMCAT_100;
} else if (version.startsWith("10.1")) { // NOI18N
return TomcatVersion.TOMCAT_101;
} else if (version.startsWith("11.")) { // NOI18N
return TomcatVersion.TOMCAT_110;
}
int dotIndex = version.indexOf('.');
if (dotIndex > 0) {
try {
int major = Integer.parseInt(version.substring(0, dotIndex));
// forward compatibility - handle any newer tomcat as Tomcat 9
if (major > 9) {
return TomcatVersion.TOMCAT_90;
}
} catch (NumberFormatException ex) {
// noop
}
}
return defaultVersion;
}
private static TomcatVersion getTomcatVersion(String uri) throws IllegalStateException {
if (uri.startsWith(TOMCAT_URI_PREFIX_110)) {
return TomcatVersion.TOMCAT_110;
} else if (uri.startsWith(TOMCAT_URI_PREFIX_101)) {
return TomcatVersion.TOMCAT_101;
} else if (uri.startsWith(TOMCAT_URI_PREFIX_100)) {
return TomcatVersion.TOMCAT_100;
} else if (uri.startsWith(TOMCAT_URI_PREFIX_90)) {
return TomcatVersion.TOMCAT_90;
} else if (uri.startsWith(TOMCAT_URI_PREFIX_80)) {
return TomcatVersion.TOMCAT_80;
} else if (uri.startsWith(TOMCAT_URI_PREFIX_70)) {
return TomcatVersion.TOMCAT_70;
} else if (uri.startsWith(TOMCAT_URI_PREFIX_60)) {
return TomcatVersion.TOMCAT_60;
} else if (uri.startsWith(TOMCAT_URI_PREFIX_55)) {
return TomcatVersion.TOMCAT_55;
}
return TomcatVersion.TOMCAT_50;
}
public static TomEEVersion getTomEEVersion(File catalinaHome, File catalinaBase)
throws IllegalStateException {
File tomee = getTomEEJar(catalinaHome);
return getTomEEVersion(tomee);
}
public static TomEEType getTomEEType(File catalinaHome, File catalinaBase)
throws IllegalStateException {
File tomee = getTomEEJar(catalinaHome);
return getTomEEType(tomee.getParentFile());
}
@NonNull
public static TomEEType getTomEEType(@NonNull File libFolder) {
File[] children = libFolder.listFiles();
TomEEType type = TomEEType.TOMEE_OPENEJB;
if (children != null) {
for (File file : children) {
if (TOMEE_PLUME_JAR_PATTERN.matcher(file.getName()).matches()) {
if(type.ordinal() < TomEEType.TOMEE_PLUME.ordinal()) {
return TomEEType.TOMEE_PLUME;
}
} else if (TOMEE_PLUS_JAR_PATTERN.matcher(file.getName()).matches()) {
if(type.ordinal() < TomEEType.TOMEE_PLUS.ordinal()) {
type = TomEEType.TOMEE_PLUS;
}
} else if (TOMEE_MICROPROFILE_JAR_PATTERN.matcher(file.getName()).matches()) {
if(type.ordinal() < TomEEType.TOMEE_MICROPROFILE.ordinal()) {
type = TomEEType.TOMEE_MICROPROFILE;
}
} else if (TOMEE_JAXRS_JAR_PATTERN.matcher(file.getName()).matches()) {
if(type.ordinal() < TomEEType.TOMEE_JAXRS.ordinal()) {
type = TomEEType.TOMEE_JAXRS;
}
} else if (TOMEE_JAR_PATTERN.matcher(file.getName()).matches()) {
if(type.ordinal() < TomEEType.TOMEE_WEBPROFILE.ordinal()) {
type = TomEEType.TOMEE_WEBPROFILE;
}
}
}
}
return type;
}
public static TomEEVersion getTomEEVersion(File tomeeJar) throws IllegalStateException {
if (tomeeJar != null) {
Matcher matcher = TOMEE_JAR_PATTERN.matcher(tomeeJar.getName());
if (matcher.matches()) {
String versionString = matcher.group(1);
return getTomEEVersion(versionString, TomEEVersion.TOMEE_15);
}
}
return null;
}
@CheckForNull
public static File getTomEEWebAppJar(File catalinaHome, File catalinaBase) {
// XXX this is not really accurate as when using basedir
// webapp from home may not be linked there we would have to check xml files
File ret = getTomEEWebAppJar(catalinaHome);
if (ret != null) {
return ret;
}
if (catalinaBase != null) {
return getTomEEWebAppJar(catalinaBase);
}
return null;
}
@CheckForNull
public static File getTomEEWebAppJar(File parent) {
File webApps = new File(parent, "webapps"); // NOI18N
File[] children = webApps.listFiles((File pathname) -> pathname.isDirectory());
if (children != null) {
for (File child : children) {
File jar = getTomEEJar(child);
if (jar != null) {
return jar;
}
}
}
return null;
}
private static File getTomEEJar(File parentDir) throws IllegalStateException {
File libDir = new File(parentDir, "lib"); // NOI18N
String[] names = libDir.list((File dir, String name) -> TOMEE_JAR_PATTERN.matcher(name).matches());
if (names != null && names.length > 0) {
// XXX based on filename we may improve it later
return new File(libDir, names[0]);
}
return null;
}
private static TomEEVersion getTomEEVersion(String version, TomEEVersion defaultVersion) throws IllegalStateException {
if (version.startsWith("1.5.")) { // NOI18N
return TomcatManager.TomEEVersion.TOMEE_15;
} else if (version.startsWith("1.6.")) { // NOI18N
return TomcatManager.TomEEVersion.TOMEE_16;
} else if (version.startsWith("1.7.")) { // NOI18N
return TomcatManager.TomEEVersion.TOMEE_17;
} else if (version.startsWith("7.")) { // NOI18N
return TomcatManager.TomEEVersion.TOMEE_70;
} else if (version.startsWith("7.1.")) { // NOI18N
return TomcatManager.TomEEVersion.TOMEE_71;
} else if (version.startsWith("8.")) { // NOI18N
return TomcatManager.TomEEVersion.TOMEE_80;
} else if (version.startsWith("9.")) { // NOI18N
return TomcatManager.TomEEVersion.TOMEE_90;
} else if (version.startsWith("10.")) { // NOI18N
return TomcatManager.TomEEVersion.TOMEE_100;
}
return defaultVersion;
}
private static String stripUriPrefix(String uri, TomcatVersion tomcatVersion) {
if (uri.startsWith(GENERIC_DISCONNECTED_URI_PREFIX)) {
return uri.substring(GENERIC_DISCONNECTED_URI_PREFIX.length());
}
switch (tomcatVersion) {
case TOMCAT_110:
return uri.substring(TomcatFactory.TOMCAT_URI_PREFIX_110.length());
case TOMCAT_101:
return uri.substring(TomcatFactory.TOMCAT_URI_PREFIX_101.length());
case TOMCAT_100:
return uri.substring(TomcatFactory.TOMCAT_URI_PREFIX_100.length());
case TOMCAT_90:
return uri.substring(TomcatFactory.TOMCAT_URI_PREFIX_90.length());
case TOMCAT_80:
return uri.substring(TomcatFactory.TOMCAT_URI_PREFIX_80.length());
case TOMCAT_70:
return uri.substring(TomcatFactory.TOMCAT_URI_PREFIX_70.length());
case TOMCAT_60:
return uri.substring(TomcatFactory.TOMCAT_URI_PREFIX_60.length());
case TOMCAT_55:
return uri.substring(TomcatFactory.TOMCAT_URI_PREFIX_55.length());
case TOMCAT_50:
default:
return uri.substring(TomcatFactory.TOMCAT_URI_PREFIX_50.length());
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy