Skip to content

Commit

Permalink
Update standalone module dependencies for Tomcat 10, etc.
Browse files Browse the repository at this point in the history
  • Loading branch information
labkey-adam committed Feb 3, 2024
1 parent a30c9d5 commit 7a5c2a2
Show file tree
Hide file tree
Showing 8 changed files with 41 additions and 30 deletions.
6 changes: 3 additions & 3 deletions standalone/README.txt
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
A simple LabKey module to illustrate how to build outside of the LabKey enlistment.
A simple LabKey module to illustrate how to build outside the LabKey enlistment.

This simple module was created using LabKey's 'createModule' command and then
removing a few things. It does not include any JSP or XSD files. To include
removing a few things. It does not include any JSP or XSD files. To include
these, you may need additional tasks for creating additional Jar files, or you
can use the LabKey Gradle plugins. The file `withPlugins_build.gradle` provides
can use the LabKey Gradle plugins. The file `withPlugins_build.gradle` provides
an example of how to use the plugins with a standalone module.

For more details see:
Expand Down
7 changes: 3 additions & 4 deletions standalone/build.gradle
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
// This is a sample gradle file for creating a stand-alone Java module that can be deployed in a LabKey server
// instance. This file applies some of the LabKey Gradle plugins and thus assumes the module layout described
// in the LabKey documentation
// (https://labkey.org/Documentation/wiki-page.view?name=moduleDirectoryStructures)
// instance. This file applies some of the LabKey Gradle plugins and thus assumes the module layout described
// in the LabKey documentation (https://labkey.org/Documentation/wiki-page.view?name=moduleDirectoryStructures).
// For simplicity, the source code does not include JSP files that would be compiled and collected into a JSP jar file
// or XSD files that would be transformed into XMLBeans objects and include in the main jar.
//
// You can refer to the gradlePlugins source code (https://github.com/LabKey/gradlePlugin) for more details on the
// full build process implemented for modules within the LabKey source tree.
// full build process implemented for modules within the LabKey source tree.
//
// To build this module, run:
// ./gradlew module
Expand Down
16 changes: 8 additions & 8 deletions standalone/gradle.properties
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# Location of the repository for various artifacts used in the build
artifactory_contextUrl=https://labkey.jfrog.io/artifactory

# Exact version will vary based on the version of LabKey being built on
gradlePluginsVersion=1.42.1
# Exact version will vary based on the target LabKey version
gradlePluginsVersion=2.2.2

# versions of artifacts required as dependencies
#uncomment the version number and set to the desired labkeyVersion
#labkeyVersion=23.7-SNAPSHOT
labkeyClientApiVersion=5.3.0
#labkeyVersion=24.3-SNAPSHOT
labkeyClientApiVersion=6.0.0

# used by the LabKey Jsp Gradle plugin for declaring dependencies
apacheTomcatVersion=9.0.83
servletApiVersion=4.0.1
# used by the LabKey JSP Gradle plugin for declaring dependencies
apacheTomcatVersion=10.1.18
servletApiVersion=6.0.0

# Example external dependency used in build file
# Not actually used... just an example to show how to declare an external dependency in the build file
commonsBeanutilsVersion=1.9.4
Binary file modified standalone/gradle/wrapper/gradle-wrapper.jar
Binary file not shown.
4 changes: 3 additions & 1 deletion standalone/gradle/wrapper/gradle-wrapper.properties
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-8.0.1-bin.zip
distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip
networkTimeout=10000
validateDistributionUrl=true
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
35 changes: 22 additions & 13 deletions standalone/gradlew
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
# Darwin, MinGW, and NonStop.
#
# (3) This script is generated from the Groovy template
# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
# within the Gradle project.
#
# You can find Gradle at https://github.com/gradle/gradle/.
Expand All @@ -80,13 +80,11 @@ do
esac
done

APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit

APP_NAME="Gradle"
# This is normally unused
# shellcheck disable=SC2034
APP_BASE_NAME=${0##*/}

# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit

# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD=maximum
Expand Down Expand Up @@ -133,22 +131,29 @@ location of your Java installation."
fi
else
JAVACMD=java
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
if ! command -v java >/dev/null 2>&1
then
die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
fi

# Increase the maximum file descriptors if we can.
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
case $MAX_FD in #(
max*)
# In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
# shellcheck disable=SC2039,SC3045
MAX_FD=$( ulimit -H -n ) ||
warn "Could not query maximum file descriptor limit"
esac
case $MAX_FD in #(
'' | soft) :;; #(
*)
# In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
# shellcheck disable=SC2039,SC3045
ulimit -n "$MAX_FD" ||
warn "Could not set maximum file descriptor limit to $MAX_FD"
esac
Expand Down Expand Up @@ -193,11 +198,15 @@ if "$cygwin" || "$msys" ; then
done
fi

# Collect all arguments for the java command;
# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
# shell script including quotes and variable substitutions, so put them in
# double quotes to make sure that they get re-expanded; and
# * put everything else in single quotes, so that it's not re-expanded.

# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'

# Collect all arguments for the java command:
# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
# and any embedded shellness will be escaped.
# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
# treated as '${Hostname}' itself on the command line.

set -- \
"-Dorg.gradle.appname=$APP_BASE_NAME" \
Expand Down
1 change: 1 addition & 0 deletions standalone/gradlew.bat
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ if "%OS%"=="Windows_NT" setlocal

set DIRNAME=%~dp0
if "%DIRNAME%"=="" set DIRNAME=.
@rem This is normally unused
set APP_BASE_NAME=%~n0
set APP_HOME=%DIRNAME%

Expand Down
2 changes: 1 addition & 1 deletion standalone/module.properties
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
ModuleClass: org.labkey.standalone.StandaloneModule
RequiredServerVersion: 21.3
RequiredServerVersion: 24.3
Label: Example Standalone LabKey module
Description: A simple example of a module that can be built outside of a LabKey enlistment.
URL: http://example.com/FIXME
Expand Down

0 comments on commit 7a5c2a2

Please sign in to comment.