Runnable Glassfish Embedded #25146

OndroMih · 2024-09-17T00:22:45Z

Allows running GlassFish Embedded from command line: java -jar glassfish-embedded.jar

Supports configuration via command line arguments and/or config files in the current directory:

set HTTP port
deploy applications passed as arguments
run arbitrary AsAdmin commands at boot

All GlassFish Embedded flavors are supported:

Standalone glassfish-embedded-all.jar, glassfish-embedded-web.jar, and glassfish-embedded-nucleus.jar
glassfish-embedded-static-shell.jar in the GlassFish Server installation

Includes fixes that made GlassFish Embedded Web usable. Includes fixes to the Static shell to make it equal to standalone GlassFish Embedded JAR files.

java -jar glassfish-embedded.jar --help prints the following info: glassfish.man.txt

Demo:

Runnable.GlassFish.Embedded.demo.mp4

Example of running an app from command line: java -jar glassfish-embedded-all.jar "set configs.config.server-config.network-config.network-listeners.network-listener.http-listener.enabled=true" "set configs.config.server-config.network-config.network-listeners.network-listener.http-listener.port=8080" app.war Example with root context: java -jar glassfish-embedded-all.jar "set configs.config.server-config.network-config.network-listeners.network-listener.http-listener.enabled=true" "set configs.config.server-config.network-config.network-listeners.network-listener.http-listener.port=8080" "deploy --contextroot=/ app.war"

Deploy app if the argument is a file or dir. If it's a single app, deploy to root context. Support --option=value arguments with values that set GlassFish properties Support several special options, like --port, --properties. Support loading properties from glassfish.properties in the current directory. Revert using FallbackStartupModule, was needed only for testing

Refactoring the API, so that UberMain can be configured and executed programmatically.

Like: Refactored to the kernel module which already contains the config-api dependency. Adding config-api to the bootstrap module caused a dependency cycle that failed the Maven build.

Add some missing dependencies that are outside of the default directory. This makes Static shell equal to GF Embedded - it can be added to the classpath or used as an executable JAR instead of GF Embedded JAR. Fix WebSockets in GF Static Shell

Added missing Jakarta APIs: - Validation is part of Web Profile - XML Binding is not part of Web Profile but JobManagerService depends on it Improvements in handling exceptions and logging messages.

...ore/kernel/src/main/java/org/glassfish/runnablejar/commandline/UnknownPropertyException.java

nucleus/core/kernel/src/main/java/org/glassfish/runnablejar/commandline/WordWrapper.java

pzygielo · 2024-09-17T08:21:32Z

nucleus/core/kernel/src/main/java/org/glassfish/runnablejar/commandline/WordWrapper.java

+
+    final int MAX_LINE_LENGTH;
+    final String HELP_LINE_INDENT;
+    int characterCount;


I'd rather have it as local.

This must be an instance field, not a local variable. It holds the state. I refactored this class into a direct collector. That should make it clear it's a stateful class and shouldn't be reused.

nucleus/core/kernel/src/main/java/org/glassfish/runnablejar/commandline/WordWrapper.java

Turned WordWraper into a direct collector WordWrapCollector. Moved the man page into the proper module and location. INFO level for output from admin commands

docs/embedded-server-guide/src/main/asciidoc/embedded-server-guide.adoc

dmatej · 2024-09-20T21:19:05Z

nucleus/hk2-config-generator/src/main/java/org/jvnet/hk2/config/ConfigParser.java

-            Logger.getAnonymousLogger().severe("Ignoring unrecognized element "+in.getLocalName() + " at " + in.getLocation());
+            logger.log(Level.WARNING, () -> "Ignoring unrecognized element " + in.getLocalName() + " at line #" + in.getLocation().getLineNumber());
+            logger.log(Level.FINE, () -> "Unrecognized element " + in.getLocalName() + " at "
+                    + in.getLocation().toString().replace("\n", ", "));


I am not sure if it is good to manipulate the location toString here, but ... or I will say it. It is wrong, but I have found that EventLocation (jaxb-osgi) really prints \n character after every value ... perhaps we could create a PR for them ;-)

Example of running an app from command line: java -jar glassfish-embedded-all.jar "set configs.config.server-config.network-config.network-listeners.network-listener.http-listener.enabled=true" "set configs.config.server-config.network-config.network-listeners.network-listener.http-listener.port=8080" app.war Example with root context: java -jar glassfish-embedded-all.jar "set configs.config.server-config.network-config.network-listeners.network-listener.http-listener.enabled=true" "set configs.config.server-config.network-config.network-listeners.network-listener.http-listener.port=8080" "deploy --contextroot=/ app.war"

Deploy app if the argument is a file or dir. If it's a single app, deploy to root context. Support --option=value arguments with values that set GlassFish properties Support several special options, like --port, --properties. Support loading properties from glassfish.properties in the current directory. Revert using FallbackStartupModule, was needed only for testing

Refactoring the API, so that UberMain can be configured and executed programmatically.

Like: Refactored to the kernel module which already contains the config-api dependency. Adding config-api to the bootstrap module caused a dependency cycle that failed the Maven build.

Add some missing dependencies that are outside of the default directory. This makes Static shell equal to GF Embedded - it can be added to the classpath or used as an executable JAR instead of GF Embedded JAR. Fix WebSockets in GF Static Shell

Added missing Jakarta APIs: - Validation is part of Web Profile - XML Binding is not part of Web Profile but JobManagerService depends on it Improvements in handling exceptions and logging messages.

Turned WordWraper into a direct collector WordWrapCollector. Moved the man page into the proper module and location. INFO level for output from admin commands

dmatej · 2024-09-20T21:35:55Z

nucleus/core/kernel/src/main/java/org/glassfish/runnablejar/commandline/Option.java

+            setLogLevel(logLevel, arguments);
+        }
+    },
+    LOG_PROPERTIES("logProperties", "--logProperties=FILE",


This will cause issues, because JDK loads first and also starts using the logging configuration, the only reliable option is to use -Djava.util.logging.config.file on command line.

dmatej · 2024-09-20T22:01:25Z

nucleus/core/kernel/src/main/java/org/glassfish/runnablejar/commandline/Option.java

+        for (Handler handler : rootLogger.getHandlers()) {
+            handler.setLevel(level);
+        }
+        LogManager.getLogManager().getLoggerNames().asIterator()


Problem with this is that it returns just already initialized loggers. It would be better to retrieve current configuration from the logmanager, change it, and then call logManager.readConfiguration. Or just provide our own defaults generated using this parameter, set the root logger+handler level and just call logger.readConfiguration asap, even before main (in static init). It would be done just if user would not explicitly set the -Djava.util.logging.config.file or -Djava.util.logging.config.class.

In the video it seems that currently it uses JDK defaults.

dmatej · 2024-09-20T22:11:16Z

I have rebased the branch and resolved conflicts as it was conflicting with my changes in master - finally they were just minor.

…glassfish-embedded # Conflicts: # nucleus/core/kernel/src/main/java/org/glassfish/runnablejar/UberMain.java

These match the configuration in the default GlassFish server domain.xml. With this it's no longer needed to specify --add-opens and --add-exports on the command line.

OndroMih added 13 commits September 16, 2024 23:44

Runnable GF Embedded: Print help

ead5d74

Runnable GF Embedded: Commands in properties file

d112c9e

Runnable GF Embedded: Applications in properties file

95f9b65

Runnable GF Embedded: Autodeploy directory option

baa0203

Refactoring the API, so that UberMain can be configured and executed programmatically.

Runnable GF Embedded: Fixes in word wrapper for help output

a07afbe

Runnable GF Embedded: Default domain directory and config file

02e80b4

Runnable GF Embedded: Documentation

1cdab0e

Runnable GF Embedded: Logging configuration

a2e6589

Runnable GF Embedded: Print info after startup

66a57e5

Like: Refactored to the kernel module which already contains the config-api dependency. Adding config-api to the bootstrap module caused a dependency cycle that failed the Maven build.

Runnable GF Embedded: Fixes for Embedded Web edition

5896794

Added missing Jakarta APIs: - Validation is part of Web Profile - XML Binding is not part of Web Profile but JobManagerService depends on it Improvements in handling exceptions and logging messages.