* This class and it's dependencies must not use logging, which could cause recursion in class * loading. So don't extend GlassfishUrlClassLoader. Reproducer: TCK tests use this classloader. + *
+ * The name of this class must not be changed - it is explicitly used in the TCK Platform Test + * package. * * @author tjquinn + * @author David Matejcek */ public class ACCAgentClassLoader extends URLClassLoader { - private boolean isActive = true; + static { + registerAsParallelCapable(); + } /** - * This constructor is used by the VM to create a system class loader (as specified by -Djava.system.class.loader on the - * java command created from the appclient script). + * This constructor is used by the VM to create a system class loader (as specified by + * -Djava.system.class.loader on the java command created from the appclient script). + *
+ * This class loader ignores the parent and uses {@link GFDependenciesClassLoader}
+ * with the {@link ClassLoader#getPlatformClassLoader()} as its parent instead.
*/
public ACCAgentClassLoader(ClassLoader parent) {
- super(new URL[] {}, prepareLoader(parent));
- }
-
-
- private static URLClassLoader prepareLoader(ClassLoader parent) {
- PrivilegedAction
- * Note that we use the property acc._AS_INSTALL to find the installation.
+ * Note that we use the property acc.AS_INSTALL to find the installation.
*/
static class GlassFishInfo {
@@ -878,14 +847,14 @@ static class GlassFishInfo {
private static final String ACC_CONFIG_PREFIX = "domains/domain1/config";
GlassFishInfo() {
- String asInstallPath = System.getProperty(ENV_VAR_PROP_PREFIX + "_AS_INSTALL");
- if (asInstallPath == null || asInstallPath.length() == 0) {
- throw new IllegalArgumentException("_AS_INSTALL == null");
+ String asInstallPath = System.getProperty(ENV_VAR_PROP_PREFIX + "AS_INSTALL");
+ if (asInstallPath == null || asInstallPath.isEmpty()) {
+ throw new IllegalArgumentException("AS_INSTALL == null");
}
- this.home = new File(asInstallPath);
- modules = new File(home, "modules");
- lib = new File(home, "lib");
- libAppclient = new File(lib, "appclient");
+ this.home = new File(asInstallPath).toPath().normalize().toFile();
+ this.modules = new File(home, "modules");
+ this.lib = new File(home, "lib");
+ this.libAppclient = new File(lib, "appclient");
}
File home() {
@@ -900,6 +869,10 @@ File lib() {
return lib;
}
+ File libAppclient() {
+ return libAppclient;
+ }
+
File configxml() {
/*
* Try using glassfish-acc.xml. If that does not exist then the user might have done an in-place upgrade from an earlier
@@ -1017,7 +990,7 @@ class UserVMArgs {
private final List
@@ -114,425 +43,14 @@ public class AppClientFacade {
*/
public static void main(String[] args) {
try {
- if (appClientContainer == null) {
- /*
- * The facade JAR has been run directly, not via the appclient script and not via Java Web Start. So we have no agent
- * arguments and no instrumentation for registering transformations.
- *
- * Because the agent has not run, we prepare the ACC here. (The agent would have done so itself had it run.)
- */
- prepareACC(null, null);
- }
-
- /*
- * In any case, the ACC is now prepared. Launch the app client in the prepared ACC.
- */
- appClientContainer.launch(args);
- } catch (Exception ex) {
- ex.printStackTrace();
- System.exit(1);
+ ApplicationClientClassLoader loader = (ApplicationClientClassLoader) Thread.currentThread()
+ .getContextClassLoader();
+ loader.getApplicationClientContainer().launch(args);
} catch (UserError ue) {
ue.displayAndExit();
- }
- }
-
- public static AppClientContainer acc() {
- return appClientContainer;
- }
-
- public static void launch(String[] args) throws NoSuchMethodException, ClassNotFoundException, IllegalAccessException,
- IllegalArgumentException, InvocationTargetException, IOException, SAXException, InjectionException, UserError {
- appClientContainer.launch(args);
- }
-
- public static void prepareACC(String agentArgsText, Instrumentation inst) throws UserError, MalformedURLException, URISyntaxException,
- JAXBException, FileNotFoundException, ParserConfigurationException, SAXException, IOException, Exception {
- int version = Runtime.version().feature();
- if (version < 11) {
- throw new UserError(localStrings.getLocalString(stringsAnchor, "main.badVersion",
- "Current Java version {0} is too low; {1} or later required",
- new Object[] {System.getProperty("java.version"), "11"}));
- }
-
- /*
- * Analyze the agent argument string.
- */
- AgentArguments agentArgs = AgentArguments.newInstance(agentArgsText);
-
- /*
- * The agent arguments that correspond to the ones that we want to pass to the ACC are the ones with the "arg=" keyword
- * prefix. These will include arguments with meaning to the ACC (-textauth for example) as well as arguments to be
- * passed on to the client's main method.
- */
- appClientCommandArgs = AppclientCommandArguments.newInstance(agentArgs.namedValues("arg"));
-
- if (appClientCommandArgs.isUsage()) {
- usage(0);
- } else if (appClientCommandArgs.isHelp()) {
- help();
- }
-
- /*
- * Examine the agent arguments for settings about how to launch the client.
- */
- launchInfo = CommandLaunchInfo.newInstance(agentArgs);
- if (launchInfo.getClientLaunchType() == UNKNOWN) {
- usage(1);
- }
-
- /*
- * Handle the legacy env. variable APPCPATH.
- */
- ACCClassLoader loader = initClassLoader((inst == null));
- Thread.currentThread().setContextClassLoader(loader);
-
- /*
- * The installRoot property will be set by the ServerEnvironment initialization using the ACC start-up context. That
- * happens during the ACCModulesManager warm-up.
- */
-
- /*
- * Load the ACC configuration XML file.
- */
- ClientContainer clientContainer = readConfig(appClientCommandArgs.getConfigFilePath(), loader);
-
- /*
- * Decide what target servers to use. This combines any specified on the command line with any in the config file's
- * target-server elements as well as any set in the properties of the config file.
- */
- final TargetServer[] targetServers = TargetServerHelper.targetServers(clientContainer, appClientCommandArgs.getTargetServer());
-
- /*
- * Get the builder. Doing so correctly involves merging the configuration file data with some of the command line and
- * agent arguments.
- */
- final AppClientContainer.Builder builder = createBuilder(targetServers, clientContainer, appClientCommandArgs);
-
- /*
- * Create the ACC. Again, precisely how we create it depends on some of the command line arguments and agent arguments.
- */
- final AppClientContainer newACC = createContainer(builder, launchInfo, appClientCommandArgs);
-
- /*
- * Because the JMV might invoke the client's main class, the agent needs to prepare the container. (This is done as part
- * of the AppClientContainer.start() processing in the public API.
- */
- newACC.prepare(inst);
-
- appClientContainer = newACC;
- }
-
- private static void usage(final int exitStatus) {
- System.err.println(getUsage());
- System.exit(exitStatus);
- }
-
- private static void help() throws IOException {
- final InputStream is = AppClientFacade.class.getResourceAsStream(MAN_PAGE_PATH);
- if (is == null) {
- usage(0);
- }
-
- try (BufferedReader helpReader = new BufferedReader(new InputStreamReader(is))) {
- String line;
- while ((line = helpReader.readLine()) != null) {
- System.err.println(line);
- }
- } finally {
- System.exit(0);
- }
- }
-
- private static String getUsage() {
- return localStrings.getLocalString(stringsAnchor, "main.usage",
- "appclient [
+ * With the usage of JPMS it got yet bit more complicated as we had to keep some order
+ * between classes and class loaders and we also noticed an issue with Windows which limit
+ * the length of the command line; therefore we introduced another layer which automatically
+ * detects some GlassFish's jar files and we don't need to add them to the -classpath argument.
*
* @author tjquinn
+ * @author David Matejcek
*/
public class AppClientGroupFacade {
@@ -29,19 +42,14 @@ public class AppClientGroupFacade {
*/
public static void main(String[] args) {
try {
- if (AppClientFacade.acc() == null) {
- /*
- * The facade JAR has been run directly, not via the appclient script and not via Java Web Start. So we have no agent
- * arguments and no instrumentation for registering transformations.
- */
- AppClientFacade.prepareACC(null, null);
- }
- AppClientFacade.launch(args);
+ ApplicationClientClassLoader loader = (ApplicationClientClassLoader) Thread.currentThread()
+ .getContextClassLoader();
+ loader.getApplicationClientContainer().launch(args);
+ } catch (UserError ue) {
+ ue.displayAndExit();
} catch (Exception ex) {
ex.printStackTrace();
System.exit(1);
- } catch (UserError ue) {
- ue.displayAndExit();
}
}
}
diff --git a/appserver/appclient/client/acc/src/main/java/org/glassfish/appclient/client/JWSACCMaskingClassLoader.java b/appserver/appclient/client/acc/src/main/java/org/glassfish/appclient/client/JWSACCMaskingClassLoader.java
index b2b9e521c97..5e4368c827a 100644
--- a/appserver/appclient/client/acc/src/main/java/org/glassfish/appclient/client/JWSACCMaskingClassLoader.java
+++ b/appserver/appclient/client/acc/src/main/java/org/glassfish/appclient/client/JWSACCMaskingClassLoader.java
@@ -1,4 +1,5 @@
/*
+ * Copyright (c) 2024 Contributors to the Eclipse Foundation
* Copyright (c) 2011, 2021 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
@@ -42,7 +43,7 @@ class JWSACCMaskingClassLoader extends MaskingClassLoader {
private final Collection
- * Note that the calling program should not stop the ACC if there might be other threads running, such as the Swing
- * event dispatcher thread. Stopping the ACC can shut down various services that those continuing threads might try to
- * use.
+ * Note that the calling program should not stop the ACC if there might be other threads
+ * running, such as the Swing event dispatcher thread. Stopping the ACC can shut down various
+ * services that those continuing threads might try to use.
*
- * Also note that stopping the ACC will have no effect on any thread that the app client itself might have created. If
- * the calling program needs to control such threads it and the client code running in the threads should agree on how
- * they will communicate with each other. The ACC cannot help with this.
+ * Also note that stopping the ACC will have no effect on any thread that the app client itself
+ * might have created. If the calling program needs to control such threads it and the client
+ * code running in the threads should agree on how they will communicate with each other.
+ * The ACC cannot help with this.
*/
public void stop() {
- /*
- * Because stop can be invoked automatically at the end of launch, allow the developer's driver program to invoke stop
- * again without penalty.
- */
+ // Because stop can be invoked automatically at the end of launch, allow the developer's
+ // driver program to invoke stop again without penalty.
if (state == State.STOPPED) {
return;
}
- if (state != State.STARTED) {
- throw new IllegalStateException();
- }
cleanup.start();
state = State.STOPPED;
}
@@ -493,7 +438,7 @@ enum ClientMainClassSetting {
static String clientMainClassName;
static volatile Class clientMainClass;
- static boolean isInjected = false;
+ static boolean isInjected;
static ClientMainClassSetting set(final String name) {
clientMainClassName = name;
@@ -515,12 +460,11 @@ static Class getClientMainClass(final ClassLoader loader, InjectionManager injec
throw new IllegalStateException("neither client main class nor its class name has been set");
}
clientMainClass = Class.forName(clientMainClassName, true, loader);
- if (logger.isLoggable(Level.FINE)) {
- logger.log(Level.FINE, "Loaded client main class {0}", clientMainClassName);
- }
+ logger.log(Level.FINE, "Loaded client main class {0}", clientMainClassName);
}
- ComponentInvocation ci = new ComponentInvocation(componentId, ComponentInvocation.ComponentInvocationType.APP_CLIENT_INVOCATION,
- container, acDesc.getApplication().getAppName(), acDesc.getModuleName());
+ ComponentInvocation ci = new ComponentInvocation(componentId,
+ ComponentInvocation.ComponentInvocationType.APP_CLIENT_INVOCATION, container,
+ acDesc.getApplication().getAppName(), acDesc.getModuleName());
invocationManager.preInvoke(ci);
InjectionException injExc = null;
@@ -603,7 +547,7 @@ enum State {
* EAR that contains multiple app clients as submodules within it; the ACC needs the calling program to specify which of
* the possibly several app client modules is the one to execute.
*
- * @param mainClassName
+ * @param clientMainClassName
* @return
*/
public void setClientMainClassName(final String clientMainClassName) throws ClassNotFoundException {
@@ -621,22 +565,17 @@ void setClientMainClass(final Class clientMainClass) {
*/
private static void prepareURLStreamHandling() {
// Set the HTTPS URL stream handler.
- java.security.AccessController.doPrivileged(new java.security.PrivilegedAction() {
- @Override
- public Object run() {
- URL.setURLStreamHandlerFactory(new DirContextURLStreamHandlerFactory());
- return null;
- }
- });
+ PrivilegedAction
diff --git a/appserver/appclient/client/acc/src/main/java/org/glassfish/appclient/client/acc/CommandLaunchInfo.java b/appserver/appclient/client/acc/src/main/java/org/glassfish/appclient/client/acc/CommandLaunchInfo.java
index 5f036684141..16815de9a9e 100644
--- a/appserver/appclient/client/acc/src/main/java/org/glassfish/appclient/client/acc/CommandLaunchInfo.java
+++ b/appserver/appclient/client/acc/src/main/java/org/glassfish/appclient/client/acc/CommandLaunchInfo.java
@@ -1,4 +1,5 @@
/*
+ * Copyright (c) 2024 Contributors to the Eclipse Foundation
* Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
@@ -48,29 +49,16 @@ public class CommandLaunchInfo {
/* records the client JAR file path, directory path, class name, or class file path */
private String clientName;
- private String appcPath = null;
-
-// /**
-// * Creates and returns a new CommandLaunchInfo instance.
-// *
-// * Typically the caller is the agent which will pass the agent arguments
-// * it received when the VM invoked its premain method.
-// *
-// * @param agentArgs string of agent arguments
-// * @return new CommandLaunchInfo object
-// */
-// public static CommandLaunchInfo newInstance(final String agentArgs) throws UserError {
-// CommandLaunchInfo result = new CommandLaunchInfo(agentArgs);
-// return result;
-// }
-
- public static CommandLaunchInfo newInstance(final AgentArguments agentArgs) throws UserError {
+ private String appcPath;
+
+
+ public static CommandLaunchInfo newInstance(final AgentArguments agentArgs) {
final CommandLaunchInfo result = new CommandLaunchInfo(agentArgs);
return result;
}
- private CommandLaunchInfo(final AgentArguments agentArgs) throws UserError {
+ private CommandLaunchInfo(final AgentArguments agentArgs) {
clientLaunchType = saveArgInfo(agentArgs);
}
@@ -98,8 +86,7 @@ public String getAppcPath() {
return appcPath;
}
- private ClientLaunchType saveArgInfo(
- final AgentArguments agentArgs) throws UserError {
+ private ClientLaunchType saveArgInfo(final AgentArguments agentArgs) {
if (agentArgs == null){
return ClientLaunchType.UNKNOWN;
}
@@ -117,7 +104,7 @@ private ClientLaunchType saveArgInfo(
}
private String lastFromList(final Listprepare methods to initialize the ACC fully. All
- * that is left at that point is for the client's main method to be invoked.
- *
- */
- public void startClient(String[] args) throws Exception, UserError {
- prepare(null);
- launch(args);
+ private AppClientContainer() {
+ this.classLoader = (TransformingClassLoader) Thread.currentThread().getContextClassLoader();
+ this.state = State.INSTANTIATED;
}
void prepareSecurity(final TargetServer[] targetServers, final Listjava -jar theClient.jar launch.
- *
- * @throws java.lang.Exception
+ * @throws UserError
*/
- private void completePreparation(final Instrumentation inst) throws NamingException, IOException, InstantiationException,
- IllegalAccessException, InjectionException, ClassNotFoundException, SAXException, NoSuchMethodException, UserError {
+ private void completePreparation(final Instrumentation inst) throws Exception, UserError {
if (state != State.INSTANTIATED) {
- throw new IllegalStateException();
+ throw new IllegalStateException(
+ "Expected state was " + State.INSTANTIATED + ", but current state was " + state);
}
- /*
- * Attach any names defined in the app client. Validate the descriptor first, then use it to bind names in the app
- * client. This order is important - for example, to set up message destination refs correctly.
- */
+ // Attach any names defined in the app client. Validate the descriptor first, then use it to
+ // bind names in the app client. This order is important - for example, to set up message
+ // destination refs correctly.
client.validateDescriptor();
final ApplicationClientDescriptor desc = client.getDescriptor(classLoader);
componentId = componentEnvManager.bindToComponentNamespace(desc);
- /*
- * Arrange for cleanup now instead of during launch() because in some use cases the JVM will invoke the client's main
- * method itself and launch will be skipped.
- */
+ // Arrange for cleanup now instead of during launch() because in some use cases the JVM will
+ // invoke the client's main method itself and launch will be skipped.
cleanup = Cleanup.arrangeForShutdownCleanup(logger, habitat, desc);
- /*
- * Allow pre-destroy handling to work on the main class during clean-up.
- */
+ // Allow pre-destroy handling to work on the main class during clean-up.
cleanup.setInjectionManager(injectionManager, ClientMainClassSetting.clientMainClass);
- /*
- * If this app client contains persistence unit refs, then initialize the PU handling.
- */
+ // If this app client contains persistence unit refs, then initialize the PU handling.
Collection referencedPUs = desc.findReferencedPUs();
if (referencedPUs != null && !referencedPUs.isEmpty()) {
- ProviderContainerContractInfoImpl pcci = new ProviderContainerContractInfoImpl((ACCClassLoader) getClassLoader(), inst,
- client.getAnchorDir(), connectorRuntime);
+ ProviderContainerContractInfoImpl pcci = new ProviderContainerContractInfoImpl(
+ (TransformingClassLoader) getClassLoader(), inst, client.getAnchorDir(), connectorRuntime);
for (PersistenceUnitDescriptor puDesc : referencedPUs) {
PersistenceUnitLoader pul = new PersistenceUnitLoader(puDesc, pcci);
desc.addEntityManagerFactory(puDesc.getName(), pul.getEMF());
@@ -340,47 +310,45 @@ private void completePreparation(final Instrumentation inst) throws NamingExcept
managedBeanManager.loadManagedBeans(desc.getApplication());
cleanup.setManagedBeanManager(managedBeanManager);
- /**
- * We don't really need the main method here but we do need the side-effects.
- */
+ // We don't really need the main method here but we do need the side-effects.
getMainMethod();
state = State.PREPARED;
}
- public void launch(String[] args) throws NoSuchMethodException, ClassNotFoundException, IllegalAccessException,
- IllegalArgumentException, InvocationTargetException, IOException, SAXException, InjectionException, UserError {
+ public void launch(String[] args) throws UserError {
if (state != State.PREPARED) {
- throw new IllegalStateException();
- }
- Method mainMethod = getMainMethod();
- // build args to the main and call it
- Object params[] = new Object[1];
- params[0] = args;
-
- if (logger.isLoggable(Level.FINE)) {
- dumpLoaderURLs();
+ throw new IllegalStateException("Unexpected state. Expected " + State.PREPARED + ", actual is " + state);
+ }
+ Thread.currentThread().setContextClassLoader(classLoader);
+ try {
+ Method mainMethod = getMainMethod();
+ // build args to the main and call it
+ if (logger.isLoggable(Level.FINE)) {
+ logger.log(Level.FINE,
+ "Current thread's classloader: " + Thread.currentThread().getContextClassLoader());
+ }
+ mainMethod.invoke(null, new Object[] {args});
+ state = State.STARTED;
+ } catch (InvocationTargetException e) {
+ if (e.getCause() instanceof UserError) {
+ throw (UserError) e.getCause();
+ }
+ throw new IllegalStateException("Launch failed.", e.getCause());
+ } catch (Exception e) {
+ throw new IllegalStateException("Launch failed.", e);
+ } finally {
+ // We need to clean up when the EDT ends or, if there is no EDT, right away.
+ // In particular, JMS/MQ-related non-daemon threads might still be running due to open
+ // queueing connections.
+ cleanupWhenSafe();
}
- mainMethod.invoke(null, params);
- state = State.STARTED;
-
- /*
- * We need to clean up when the EDT ends or, if there is no EDT, right away. In particular, JMS/MQ-related non-daemon
- * threads might still be running due to open queueing connections.
- */
- cleanupWhenSafe();
}
private boolean isEDTRunning() {
- MapclientCredentials method. The ACC will use the
@@ -95,10 +97,6 @@ public class AppClientContainerBuilder implements AppClientContainer.Builder {
*/
private Properties containerProperties;
- AppClientContainerBuilder() {
-
- }
-
/**
* Creates a new builder with the specified target servers and client URI.
*
@@ -107,6 +105,7 @@ public class AppClientContainerBuilder implements AppClientContainer.Builder {
*/
AppClientContainerBuilder(final TargetServer[] targetServers) {
this.targetServers = targetServers;
+ this.classLoader = (URLClassLoader) Thread.currentThread().getContextClassLoader();
}
public AppClientContainer newContainer(final Class mainClass, final CallbackHandler callerSpecifiedCallbackHandler) throws Exception {
@@ -155,27 +154,27 @@ public AppClientContainer newContainer(final URI clientURI) throws Exception, Us
private AppClientContainer createContainer(final Launchable client, final CallbackHandler callerSuppliedCallbackHandler,
final boolean isTextAuth)
- throws BootException, URISyntaxException, ReflectiveOperationException, InjectionException, IOException, SAXException {
+ throws ReflectiveOperationException, InjectionException, IOException, SAXException {
AppClientContainer container = ACCModulesManager.getService(AppClientContainer.class);
// process the packaged permissions.xml
container.processPermissions();
container.setClient(client);
- container.setBuilder(this);
- CallbackHandler callbackHandler = (callerSuppliedCallbackHandler != null ? callerSuppliedCallbackHandler
- : getCallbackHandlerFromDescriptor(client.getDescriptor(classLoader).getCallbackHandler()));
- container.prepareSecurity(targetServers, messageSecurityConfigs, containerProperties, clientCredential, callbackHandler,
- classLoader, isTextAuth);
+ CallbackHandler callbackHandler = callerSuppliedCallbackHandler == null
+ ? getCallbackHandlerFromDescriptor(client.getDescriptor(classLoader).getCallbackHandler())
+ : callerSuppliedCallbackHandler;
+ container.prepareSecurity(targetServers, messageSecurityConfigs, containerProperties, clientCredential,
+ callbackHandler, isTextAuth);
return container;
}
private CallbackHandler getCallbackHandlerFromDescriptor(final String callbackHandlerName)
- throws ClassNotFoundException, InstantiationException, IllegalAccessException {
+ throws ClassNotFoundException, InstantiationException, IllegalAccessException, InvocationTargetException, NoSuchMethodException, SecurityException {
if (callbackHandlerName != null && !callbackHandlerName.equals("")) {
Class
Specifics: - *
Note: You can not get an Exception out of calling this code! If the String - * or the properties file does not exist, it will return the String that you gave - * in the first place as the argument. - *
Examples: - *
Specifics: - *
Note: You can not get an Exception out of calling this code! If the String - * or the properties file does not exist, it will return the String that you gave - * in the first place as the argument. - *
Example: - *
Specifics: + *
Note: You can not get an Exception out of calling this code! If the String + * or the properties file does not exist, it will return the String that you gave + * in the first place as the argument. + *
Example: + *
@@ -215,6 +219,7 @@ protected Enumeration
+ * It is the only way to send an object from the agent to the main class.
+ *
+ * {@link ClassLoader} is an abstract class and we don't want to introduce
+ * multiple inheritance, so this interface is added to chosen class loaders.
+ * The hierarchy in the appclient is strictly defined, so this is enough.
+ * Older implementations used principially same "trick", but this is bit more
+ * readable as you can always search usages of this interface.
+ */
+public interface ApplicationClientClassLoader {
+
+ /**
+ * Sets the container. Default implementation doesn't do anything.
+ *
+ * @param container
+ */
+ default void setApplicationClientContainer(ApplicationClientContainer container) {
+ // does nothing by default.
+ }
+
+ /**
+ * @return {@link ApplicationClientContainer}
+ */
+ ApplicationClientContainer getApplicationClientContainer();
+}
diff --git a/nucleus/common/simple-glassfish-api/src/main/java/org/glassfish/embeddable/client/ApplicationClientContainer.java b/nucleus/common/simple-glassfish-api/src/main/java/org/glassfish/embeddable/client/ApplicationClientContainer.java
new file mode 100644
index 00000000000..7033cad650f
--- /dev/null
+++ b/nucleus/common/simple-glassfish-api/src/main/java/org/glassfish/embeddable/client/ApplicationClientContainer.java
@@ -0,0 +1,32 @@
+/*
+ * Copyright (c) 2024 Contributors to the Eclipse Foundation
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0, which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the
+ * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
+ * version 2 with the GNU Classpath Exception, which is available at
+ * https://www.gnu.org/software/classpath/license.html.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ */
+
+package org.glassfish.embeddable.client;
+
+
+/**
+ * Shared interface required to avoid circular dependency of gf-client.jar and gf-client-module.jar
+ */
+public interface ApplicationClientContainer {
+
+ /**
+ * Executes the client. The implementation of this interface might require some preparation.
+ *
+ * @param args
+ * @throws UserError When user provided incorrect arguments or some requirements were not met.
+ */
+ void launch(String[] args) throws UserError;
+}
diff --git a/appserver/appclient/client/acc/src/main/java/org/glassfish/appclient/client/acc/UserError.java b/nucleus/common/simple-glassfish-api/src/main/java/org/glassfish/embeddable/client/UserError.java
similarity index 63%
rename from appserver/appclient/client/acc/src/main/java/org/glassfish/appclient/client/acc/UserError.java
rename to nucleus/common/simple-glassfish-api/src/main/java/org/glassfish/embeddable/client/UserError.java
index 7110d8dbdb8..2dabd757c1a 100644
--- a/appserver/appclient/client/acc/src/main/java/org/glassfish/appclient/client/acc/UserError.java
+++ b/nucleus/common/simple-glassfish-api/src/main/java/org/glassfish/embeddable/client/UserError.java
@@ -1,4 +1,5 @@
/*
+ * Copyright (c) 2024 Contributors to the Eclipse Foundation
* Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
@@ -14,33 +15,36 @@
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
-package org.glassfish.appclient.client.acc;
+package org.glassfish.embeddable.client;
import java.io.ByteArrayOutputStream;
import java.io.PrintStream;
import java.text.MessageFormat;
/**
- *Represents any user error, such as an invalid combination of command options,
- *or specifying a non-existent JAR file.
- *
- *Such errors should be user-correctable, provided the message is clear.
- *So no stack traces should be displayed when UserErrors are thrown.
+ * Represents any user error, such as an invalid combination of command options,
+ * or specifying a non-existent JAR file.
+ *
+ * Such errors should be user-correctable, provided the message is clear.
+ * So no stack traces should be displayed when UserErrors are thrown.
*
* @author tjquinn
*/
public class UserError extends Throwable {
+ private static final long serialVersionUID = 4171944609382558583L;
+
/** Allows user to turn on stack traces for user errors - normally off */
- private static final String SHOW_STACK_TRACES_PROPERTY_NAME =
- UserError.class.getPackage().getName() + ".showUserErrorStackTraces";
+ private static final String SHOW_STACK_TRACES_PROPERTY_NAME = UserError.class.getPackage().getName()
+ + ".showUserErrorStackTraces";
/**
* Creates a new UserError instance having formatted the message with the
* arguments provided.
- *@param message the message string, presumably containing argument placeholders
- *@param args 0 or more arguments for substitution for the placeholders in the message string
- *@return new UserError with message formatted as requested
+ *
+ * @param message the message string, presumably containing argument placeholders
+ * @param args 0 or more arguments for substitution for the placeholders in the message string
+ * @return new UserError with message formatted as requested
*/
public static UserError formatUserError(String message, String... args) {
String formattedMessage = MessageFormat.format(message, (Object[]) args);
@@ -49,7 +53,7 @@ public static UserError formatUserError(String message, String... args) {
}
/** xmlMessage implementation showed the usage message after the error */
- private String usage = null;
+ private String usage;
public UserError(String message) {
super(message);
@@ -63,24 +67,27 @@ public UserError(Throwable cause) {
super(cause);
}
+
/**
- *Sets whether or not the usage message should be displayed after the
- *error message is displayed to the user.
- *@param showUsage the new setting
+ * Sets whether or not the usage message should be displayed after the
+ * error message is displayed to the user.
+ *
+ * @param usage the new setting
*/
public void setUsage(String usage) {
this.usage = usage;
}
+
/**
- *Displays the user error message, and any messages along the exception
- *chain, if any, and then exits. If showUsage has been set to true, then
- *the usage message is displayed before exiting.
- *
- *Only the messages, and not the stack traces, are shown because these are
- *user errors that should be user-correctable. Stack traces are too
- *alarming and of minimal use to the user as he or she tries to understand
- *and fix the error.
+ * Displays the user error message, and any messages along the exception
+ * chain, if any, and then exits. If showUsage has been set to true, then
+ * the usage message is displayed before exiting.
+ *
+ * Only the messages, and not the stack traces, are shown because these are
+ * user errors that should be user-correctable. Stack traces are too
+ * alarming and of minimal use to the user as he or she tries to understand
+ * and fix the error.
*/
public void displayAndExit() {
display(System.err);
diff --git a/nucleus/common/simple-glassfish-api/src/main/java/org/glassfish/embeddable/spi/RuntimeBuilder.java b/nucleus/common/simple-glassfish-api/src/main/java/org/glassfish/embeddable/spi/RuntimeBuilder.java
index 41386c97726..9604e67f4c1 100644
--- a/nucleus/common/simple-glassfish-api/src/main/java/org/glassfish/embeddable/spi/RuntimeBuilder.java
+++ b/nucleus/common/simple-glassfish-api/src/main/java/org/glassfish/embeddable/spi/RuntimeBuilder.java
@@ -36,7 +36,13 @@ public interface RuntimeBuilder {
* @return
* @throws GlassFishException
*/
- GlassFishRuntime build(BootstrapProperties options) throws GlassFishException;
+ default GlassFishRuntime build(BootstrapProperties options) throws GlassFishException {
+ return build(options, getClass().getClassLoader());
+ }
+
+
+ GlassFishRuntime build(BootstrapProperties options, ClassLoader classloader) throws GlassFishException;
+
/**
* Returns true if this RuntimeBuilder is capable of creating a GlassFishRuntime
diff --git a/nucleus/core/bootstrap-osgi/pom.xml b/nucleus/core/bootstrap-osgi/pom.xml
new file mode 100755
index 00000000000..0654a9cf289
--- /dev/null
+++ b/nucleus/core/bootstrap-osgi/pom.xml
@@ -0,0 +1,112 @@
+
+
+
+Throwable.
+ *
+ * @param logger the Logger object to be used for logging the message.
+ * @param level the Level of the message to be logged.
+ * @param messageId the key in the resource bundle of the Logger containing the localized text.
+ * @param thrown the Throwable associated with the message to be logged.
+ * @param params the parameters to the localized text.
+ */
+ public static void log(Logger logger, Level level, String messageId, Throwable thrown, Object... params) {
+ LogRecord rec = new LogRecord(level, messageId);
+ rec.setLoggerName(logger.getName());
+ rec.setResourceBundleName(logger.getResourceBundleName());
+ rec.setResourceBundle(logger.getResourceBundle());
+ rec.setParameters(params);
+ rec.setThrown(thrown);
+ logger.log(rec);
+ }
+}
diff --git a/nucleus/core/bootstrap/src/main/java/com/sun/enterprise/glassfish/bootstrap/osgi/BundleProvisioner.java b/nucleus/core/bootstrap-osgi/src/main/java/org/glassfish/main/boot/osgi/BundleProvisioner.java
similarity index 99%
rename from nucleus/core/bootstrap/src/main/java/com/sun/enterprise/glassfish/bootstrap/osgi/BundleProvisioner.java
rename to nucleus/core/bootstrap-osgi/src/main/java/org/glassfish/main/boot/osgi/BundleProvisioner.java
index 9509601a45e..2100bd22149 100644
--- a/nucleus/core/bootstrap/src/main/java/com/sun/enterprise/glassfish/bootstrap/osgi/BundleProvisioner.java
+++ b/nucleus/core/bootstrap-osgi/src/main/java/org/glassfish/main/boot/osgi/BundleProvisioner.java
@@ -15,9 +15,7 @@
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
-package com.sun.enterprise.glassfish.bootstrap.osgi;
-
-import com.sun.enterprise.glassfish.bootstrap.log.LogFacade;
+package org.glassfish.main.boot.osgi;
import java.io.InputStream;
import java.net.URI;
@@ -31,6 +29,7 @@
import java.util.logging.Level;
import java.util.logging.Logger;
+import org.glassfish.main.boot.log.LogFacade;
import org.osgi.framework.Bundle;
import org.osgi.framework.BundleContext;
import org.osgi.framework.BundleException;
diff --git a/nucleus/core/bootstrap/src/main/java/com/sun/enterprise/glassfish/bootstrap/osgi/BundleProvisionerCustomizer.java b/nucleus/core/bootstrap-osgi/src/main/java/org/glassfish/main/boot/osgi/BundleProvisionerCustomizer.java
similarity index 97%
rename from nucleus/core/bootstrap/src/main/java/com/sun/enterprise/glassfish/bootstrap/osgi/BundleProvisionerCustomizer.java
rename to nucleus/core/bootstrap-osgi/src/main/java/org/glassfish/main/boot/osgi/BundleProvisionerCustomizer.java
index 4d8e20bc477..984f14dfbcb 100644
--- a/nucleus/core/bootstrap/src/main/java/com/sun/enterprise/glassfish/bootstrap/osgi/BundleProvisionerCustomizer.java
+++ b/nucleus/core/bootstrap-osgi/src/main/java/org/glassfish/main/boot/osgi/BundleProvisionerCustomizer.java
@@ -14,7 +14,7 @@
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
-package com.sun.enterprise.glassfish.bootstrap.osgi;
+package org.glassfish.main.boot.osgi;
import java.net.URI;
import java.util.List;
@@ -66,4 +66,4 @@ interface BundleProvisionerCustomizer {
* @return start level of this bundle. -1 if not known
*/
Integer getStartLevel(Jar jar);
-}
\ No newline at end of file
+}
diff --git a/nucleus/core/bootstrap/src/main/java/com/sun/enterprise/glassfish/bootstrap/osgi/DefaultBundleProvisionerCustomizer.java b/nucleus/core/bootstrap-osgi/src/main/java/org/glassfish/main/boot/osgi/DefaultBundleProvisionerCustomizer.java
similarity index 96%
rename from nucleus/core/bootstrap/src/main/java/com/sun/enterprise/glassfish/bootstrap/osgi/DefaultBundleProvisionerCustomizer.java
rename to nucleus/core/bootstrap-osgi/src/main/java/org/glassfish/main/boot/osgi/DefaultBundleProvisionerCustomizer.java
index 8e0c69401e6..dd013789f71 100644
--- a/nucleus/core/bootstrap/src/main/java/com/sun/enterprise/glassfish/bootstrap/osgi/DefaultBundleProvisionerCustomizer.java
+++ b/nucleus/core/bootstrap-osgi/src/main/java/org/glassfish/main/boot/osgi/DefaultBundleProvisionerCustomizer.java
@@ -14,9 +14,7 @@
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
-package com.sun.enterprise.glassfish.bootstrap.osgi;
-
-import com.sun.enterprise.glassfish.bootstrap.log.LogFacade;
+package org.glassfish.main.boot.osgi;
import java.io.File;
import java.io.FileFilter;
@@ -33,6 +31,7 @@
import java.util.stream.Collectors;
import java.util.stream.Stream;
+import org.glassfish.main.boot.log.LogFacade;
import org.osgi.framework.Bundle;
import static com.sun.enterprise.glassfish.bootstrap.cfg.BootstrapKeys.AUTO_INSTALL_PROP;
@@ -85,8 +84,11 @@ class DefaultBundleProvisionerCustomizer implements BundleProvisionerCustomizer
this.config = config;
// for optimization reasons, process these properties once and store their values
processAutoInstallLocations();
+ LOG.log(Level.CONFIG, () -> "autoInstallLocations:\n" + autoInstallLocations);
processAutoStartLocations();
+ LOG.log(Level.CONFIG, () -> "autoStartLocations:\n" + autoStartLocations);
processStartLevels();
+ LOG.log(Level.CONFIG, () -> "configuredAutoInstallLocations:\n" + configuredAutoInstallLocations);
}
diff --git a/nucleus/core/bootstrap/src/main/java/com/sun/enterprise/glassfish/bootstrap/osgi/EmbeddedOSGiGlassFishImpl.java b/nucleus/core/bootstrap-osgi/src/main/java/org/glassfish/main/boot/osgi/EmbeddedOSGiGlassFishImpl.java
similarity index 95%
rename from nucleus/core/bootstrap/src/main/java/com/sun/enterprise/glassfish/bootstrap/osgi/EmbeddedOSGiGlassFishImpl.java
rename to nucleus/core/bootstrap-osgi/src/main/java/org/glassfish/main/boot/osgi/EmbeddedOSGiGlassFishImpl.java
index ce1a19b2592..02fcc67eb13 100644
--- a/nucleus/core/bootstrap/src/main/java/com/sun/enterprise/glassfish/bootstrap/osgi/EmbeddedOSGiGlassFishImpl.java
+++ b/nucleus/core/bootstrap-osgi/src/main/java/org/glassfish/main/boot/osgi/EmbeddedOSGiGlassFishImpl.java
@@ -15,15 +15,14 @@
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
-package com.sun.enterprise.glassfish.bootstrap.osgi;
-
-import com.sun.enterprise.glassfish.bootstrap.log.LogFacade;
+package org.glassfish.main.boot.osgi;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.glassfish.embeddable.GlassFish;
import org.glassfish.embeddable.GlassFishException;
+import org.glassfish.main.boot.log.LogFacade;
import org.osgi.framework.BundleContext;
import org.osgi.framework.ServiceRegistration;
diff --git a/nucleus/core/bootstrap/src/main/java/com/sun/enterprise/glassfish/bootstrap/osgi/EmbeddedOSGiGlassFishRuntime.java b/nucleus/core/bootstrap-osgi/src/main/java/org/glassfish/main/boot/osgi/EmbeddedOSGiGlassFishRuntime.java
similarity index 87%
rename from nucleus/core/bootstrap/src/main/java/com/sun/enterprise/glassfish/bootstrap/osgi/EmbeddedOSGiGlassFishRuntime.java
rename to nucleus/core/bootstrap-osgi/src/main/java/org/glassfish/main/boot/osgi/EmbeddedOSGiGlassFishRuntime.java
index 3e3631c49ec..2f092f215fb 100644
--- a/nucleus/core/bootstrap/src/main/java/com/sun/enterprise/glassfish/bootstrap/osgi/EmbeddedOSGiGlassFishRuntime.java
+++ b/nucleus/core/bootstrap-osgi/src/main/java/org/glassfish/main/boot/osgi/EmbeddedOSGiGlassFishRuntime.java
@@ -15,11 +15,8 @@
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
-package com.sun.enterprise.glassfish.bootstrap.osgi;
+package org.glassfish.main.boot.osgi;
-import com.sun.enterprise.glassfish.bootstrap.GlassFishImpl;
-import com.sun.enterprise.glassfish.bootstrap.cfg.AsenvConf;
-import com.sun.enterprise.glassfish.bootstrap.cp.GlassfishBootstrapClassLoader;
import com.sun.enterprise.module.ModulesRegistry;
import com.sun.enterprise.module.bootstrap.BootException;
import com.sun.enterprise.module.bootstrap.Main;
@@ -37,17 +34,20 @@
import java.util.Arrays;
import java.util.Enumeration;
import java.util.List;
+import java.util.Map;
import java.util.Properties;
import java.util.logging.Logger;
import java.util.stream.Collectors;
-import org.glassfish.common.util.GlassfishUrlClassLoader;
import org.glassfish.embeddable.GlassFish;
import org.glassfish.embeddable.GlassFishException;
import org.glassfish.embeddable.GlassFishProperties;
import org.glassfish.embeddable.GlassFishRuntime;
import org.glassfish.hk2.api.MultiException;
import org.glassfish.hk2.api.ServiceLocator;
+import org.glassfish.main.boot.impl.GlassFishImpl;
+import org.glassfish.main.jdke.cl.GlassfishUrlClassLoader;
+import org.glassfish.main.jdke.props.EnvToPropsConverter;
import org.osgi.framework.Bundle;
import org.osgi.framework.BundleContext;
import org.osgi.framework.BundleException;
@@ -58,6 +58,13 @@
import static com.sun.enterprise.glassfish.bootstrap.cfg.BootstrapKeys.INSTALL_ROOT_URI_PROP_NAME;
import static com.sun.enterprise.glassfish.bootstrap.cfg.BootstrapKeys.INSTANCE_ROOT_PROP_NAME;
import static com.sun.enterprise.glassfish.bootstrap.cfg.BootstrapKeys.INSTANCE_ROOT_URI_PROP_NAME;
+import static com.sun.enterprise.util.SystemPropertyConstants.AGENT_ROOT_PROPERTY;
+import static com.sun.enterprise.util.SystemPropertyConstants.CONFIG_ROOT_PROPERTY;
+import static com.sun.enterprise.util.SystemPropertyConstants.DERBY_ROOT_PROPERTY;
+import static com.sun.enterprise.util.SystemPropertyConstants.DOMAINS_ROOT_PROPERTY;
+import static com.sun.enterprise.util.SystemPropertyConstants.IMQ_BIN_PROPERTY;
+import static com.sun.enterprise.util.SystemPropertyConstants.IMQ_LIB_PROPERTY;
+import static com.sun.enterprise.util.SystemPropertyConstants.JAVA_ROOT_PROPERTY_ASENV;
import static java.nio.charset.StandardCharsets.UTF_8;
import static java.util.logging.Level.FINEST;
import static org.glassfish.embeddable.GlassFish.Status.DISPOSED;
@@ -226,16 +233,25 @@ private void tryAddPomProperties(Bundle bundle, StringBuilder bundleBuilder) thr
private void setEnv(Properties bootstrapProperties) {
final String installRootValue = bootstrapProperties.getProperty(INSTALL_ROOT_PROP_NAME);
if (installRootValue != null && !installRootValue.isEmpty()) {
+ final Map
* List: *
Throwable.
- *
- * @param logger the Logger object to be used for logging the message.
- * @param level the Level of the message to be logged.
- * @param messageId the key in the resource bundle of the Logger containing the localized text.
- * @param thrown the Throwable associated with the message to be logged.
- * @param params the parameters to the localized text.
- */
- public static void log(Logger logger, Level level, String messageId, Throwable thrown, Object... params) {
- LogRecord rec = new LogRecord(level, messageId);
- rec.setLoggerName(logger.getName());
- rec.setResourceBundleName(logger.getResourceBundleName());
- rec.setResourceBundle(logger.getResourceBundle());
- rec.setParameters(params);
- rec.setThrown(thrown);
- logger.log(rec);
- }
}
diff --git a/nucleus/core/bootstrap/src/main/java/module-info.java b/nucleus/core/bootstrap/src/main/java/module-info.java
new file mode 100644
index 00000000000..6afb9821b50
--- /dev/null
+++ b/nucleus/core/bootstrap/src/main/java/module-info.java
@@ -0,0 +1,33 @@
+/*
+ * Copyright (c) 2024 Contributors to the Eclipse Foundation
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0, which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the
+ * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
+ * version 2 with the GNU Classpath Exception, which is available at
+ * https://www.gnu.org/software/classpath/license.html.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ */
+
+/**
+ * @author David Matejcek
+ */
+module org.glassfish.main.bootstrap {
+
+ requires java.base;
+ requires java.logging;
+
+ requires org.glassfish.main.api.simple;
+ requires org.glassfish.main.jdke;
+
+ requires static org.apache.felix.framework;
+ requires static org.glassfish.annotation.processing.logging;
+
+ exports com.sun.enterprise.glassfish.bootstrap.cfg;
+ exports com.sun.enterprise.glassfish.bootstrap.launch;
+}
diff --git a/nucleus/core/bootstrap/src/main/resources/META-INF/services/org.glassfish.embeddable.spi.RuntimeBuilder b/nucleus/core/bootstrap/src/main/resources/META-INF/services/org.glassfish.embeddable.spi.RuntimeBuilder
deleted file mode 100644
index 99bcf4338ed..00000000000
--- a/nucleus/core/bootstrap/src/main/resources/META-INF/services/org.glassfish.embeddable.spi.RuntimeBuilder
+++ /dev/null
@@ -1,3 +0,0 @@
-com.sun.enterprise.glassfish.bootstrap.osgi.OSGiGlassFishRuntimeBuilder
-com.sun.enterprise.glassfish.bootstrap.embedded.EmbeddedGlassFishRuntimeBuilder
-com.sun.enterprise.glassfish.bootstrap.osgi.EmbeddedOSGiGlassFishRuntimeBuilder
diff --git a/nucleus/core/bootstrap/src/main/resources/META-INF/services/org.glassfish.hk2.api.PopulatorPostProcessor b/nucleus/core/bootstrap/src/main/resources/META-INF/services/org.glassfish.hk2.api.PopulatorPostProcessor
deleted file mode 100644
index f1caf75c33c..00000000000
--- a/nucleus/core/bootstrap/src/main/resources/META-INF/services/org.glassfish.hk2.api.PopulatorPostProcessor
+++ /dev/null
@@ -1 +0,0 @@
-com.sun.enterprise.glassfish.bootstrap.embedded.EmbeddedInhabitantsParser
diff --git a/nucleus/core/bootstrap/src/test/java/com/sun/enterprise/glassfish/bootstrap/cfg/AsenvConfTest.java b/nucleus/core/bootstrap/src/test/java/com/sun/enterprise/glassfish/bootstrap/cfg/AsenvConfTest.java
deleted file mode 100644
index 5fd6d4bf0e3..00000000000
--- a/nucleus/core/bootstrap/src/test/java/com/sun/enterprise/glassfish/bootstrap/cfg/AsenvConfTest.java
+++ /dev/null
@@ -1,79 +0,0 @@
-/*
- * Copyright (c) 2024 Contributors to the Eclipse Foundation.
- *
- * This program and the accompanying materials are made available under the
- * terms of the Eclipse Public License v. 2.0, which is available at
- * http://www.eclipse.org/legal/epl-2.0.
- *
- * This Source Code may also be made available under the following Secondary
- * Licenses when the conditions for such availability set forth in the
- * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
- * version 2 with the GNU Classpath Exception, which is available at
- * https://www.gnu.org/software/classpath/license.html.
- *
- * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
- */
-
-package com.sun.enterprise.glassfish.bootstrap.cfg;
-
-import java.io.File;
-import java.io.PrintWriter;
-
-import org.junit.jupiter.api.Test;
-
-import static java.nio.charset.StandardCharsets.UTF_8;
-import static org.junit.jupiter.api.Assertions.assertEquals;
-
-public class AsenvConfTest {
-
- /**
- * This test is used to test the regex pattern of "parseAsEnv" method of "MainHelper.java".
- *