Repository files navigation

This repository contains the Java source code forGoogle App Enginestandard environment, the production runtime, the App Engine APIs, and the local SDK.

jdk17, but using a JDK21 or JDK25 is also possible.

The shared codebase is also used for GAE Java 17, Java 21 and Java 25 build and test targets, using GitHub actions:

• Java 17/21/25 Continuous Integration

This repository is the open source mirror of the Google App Engine Java source code that was used to produce Maven artifacts and runtime jars.The open source release mechanism used with this GitHub repository is using the version starting at 3.0.x, compatible for Java 17 or above.

This repository is organized into several Maven modules. For a detailed description of each module, its dependencies, and how they relate to each other, seemodules.md.

Orange items are public modules artifacts and yellow are internal ones.Modules ending with * are only used on the production server side.

Source code for all public APIs for com.google.appengine.api.* packages.

• Public Documentation
• Latest javadoc.io API Javadocs from this repository
• Javadocs
• Source Code
• Source Code for repackaged API jar

Note that some App Engine APIs such as Blobstore and Taskqueues provide classes that depend on servlet APIs.The base packagescom.google.appengine.api.blobstore andcom.google.appengine.api.taskqueue contain classes that usejavax.servlet.* for EE6/EE8 compatibility.For EE10 and EE11 environments that use thejakarta.servlet.* namespace, use classes fromcom.google.appengine.api.blobstore.jakarta andcom.google.appengine.api.taskqueue.jakarta packages.The packagescom.google.appengine.api.blobstore.ee10 andcom.google.appengine.api.taskqueue.ee10 are deprecated starting from version 3.0.0.

• Maven pom.xml

  <packaging>war</packaging><!-- Servlet 3.1 WAR packaging-->...<dependencies>    <dependency>        <groupId>com.google.appengine</groupId>        <artifactId>appengine-api-1.0-sdk</artifactId>        <version>3.0.3</version><!-- or later-->    </dependency>    <dependency>      <groupId>javax.servlet</groupId>      <artifactId>javax.servlet-api</artifactId>      <version>3.1</version>      <scope>provided</scope></dependency>...

• Maven Java 21 with jakarta EE 10 support pom.xml

  <packaging>war</packaging><!-- Servlet 6.0 WAR packaging-->...<dependencies>    <dependency>        <groupId>com.google.appengine</groupId>        <artifactId>appengine-api-1.0-sdk</artifactId>        <version>3.0.3</version><!-- or later-->    </dependency>    <dependency>      <groupId>jakarta.servlet</groupId>      <artifactId>jakarta.servlet-api</artifactId>      <version>6.0.0</version>      <scope>provided</scope>    </dependency>...

• Maven Java 25 Alpha with jakarta EE 11 support pom.xml (EE10 is not supported in Java25, EE11 is fully compatible with EE10)

  <packaging>war</packaging><!-- Servlet 6.1 WAR packaging-->...<dependencies>    <dependency>        <groupId>com.google.appengine</groupId>        <artifactId>appengine-api-1.0-sdk</artifactId>        <version>3.0.3</version><!-- or later-->    </dependency>    <dependency>      <groupId>jakarta.servlet</groupId>      <artifactId>jakarta.servlet-api</artifactId>      <version>6.1.0</version>      <scope>provided</scope>    </dependency>...

• Java 21/25 with javax EE8 profile appengine-web.xml

  <?xml version="1.0" encoding="utf-8"?><appengine-web-app xmlns="http://appengine.google.com/ns/1.0">  <runtime>java21</runtime> <-- or java25 alpha-->  <app-engine-apis>true</app-engine-apis>  <!-- Add optionally:  <system-properties>    <property name="appengine.use.EE8" value="true"/></system-properties>If you want to keep javax.servlet APIs and not jakarta.servlet by default--></appengine-web-app>

• Public Java 17/21/25 Documentation
• How to upgrade to Java21/25

• Java 17 appengine-web.xml

  <?xml version="1.0" encoding="utf-8"?><appengine-web-app xmlns="http://appengine.google.com/ns/1.0">  <runtime>java17</runtime>  <app-engine-apis>true</app-engine-apis></appengine-web-app>

• Java 21 appengine-web.xml (will default to EE10, but EE8 possible)

  <?xml version="1.0" encoding="utf-8"?><appengine-web-app xmlns="http://appengine.google.com/ns/1.0">  <runtime>java21</runtime>  <app-engine-apis>true</app-engine-apis></appengine-web-app>

• Java 25 appengine-web.xml (will default to EE11, but EE8 possible) Alpha

  <?xml version="1.0" encoding="utf-8"?><appengine-web-app xmlns="http://appengine.google.com/ns/1.0">  <runtime>java25</runtime>  <app-engine-apis>true</app-engine-apis></appengine-web-app>

Source code for remote APIs for App Engine.

• Public Documentation
• Latest javadoc.io Javadocs from this repository
• Public Sample remote server
• Public Sample remote client
• Source Code

• Servlet web.xml

   <servlet>     <display-name>Remote API Servlet</display-name>     <servlet-name>RemoteApiServlet</servlet-name>     <servlet-class>com.google.apphosting.utils.remoteapi.RemoteApiServlet</servlet-class>     <load-on-startup>1</load-on-startup>   </servlet>   <servlet-mapping>     <servlet-name>RemoteApiServlet</servlet-name>     <url-pattern>/remote_api</url-pattern>   </servlet-mapping>

• Servlet jakarta EE10 and EE11 web.xml

   <servlet>     <display-name>Remote API Servlet</display-name>     <servlet-name>RemoteApiServlet</servlet-name>     <servlet-class>com.google.apphosting.utils.remoteapi.JakartaRemoteApiServlet</servlet-class>     <load-on-startup>1</load-on-startup>   </servlet>   <servlet-mapping>     <servlet-name>RemoteApiServlet</servlet-name>     <url-pattern>/remote_api</url-pattern>   </servlet-mapping>

• Maven javax and jakarta API pom.xml

    <dependency>       <groupId>com.google.appengine</groupId>       <artifactId>appengine-remote-api</artifactId>       <version>3.0.3</version><!-- or later-->    </dependency>

We movedcom.google.appengine.api.memcache.stdimpl and its old dependencyjavax.cache fromappengine-api-1.0-sdk.jar to a new jarappengine-api-legacy.jar.

• Latest javadoc.io Javadocs from this repository

  Users who depend on themoved classes will need to also includeappengine-api-legacy.jar whenthey build/deploy. Separating these classes allowsappengine-api-1.0-sdk users to choose any version ofjavax.cacherather than being constrained by an obsolete included version.

  • Maven pom.xml

    <dependency>       <groupId>com.google.appengine</groupId>       <artifactId>appengine-api-legacy.jar/artifactId>       <version>3.0.3</version><!-- Or later-->    </dependency>

• Code Sample

• Latest javadoc.io Javadocs from this repository

  • Maven pom.xml

    <dependency>      <groupId>com.google.appengine</groupId>      <artifactId>appengine-testing</artifactId>      <version>3.0.3</version><!-- or later-->      <scope>test</scope>    </dependency>    <dependency>      <groupId>com.google.appengine</groupId>      <artifactId>appengine-api-stubs</artifactId>      <version>3.0.3</version><!-- or later-->      <scope>test</scope>    </dependency>    <dependency>      <groupId>com.google.appengine</groupId>      <artifactId>appengine-tools-sdk</artifactId>      <version>3.0.3</version><!-- or later-->      <scope>test</scope>    </dependency>

Implementation of all the App Engine APIs for local environment (devappserver)and local testing of an application before deployment.

• Public Documentation
• Source Code
• Source Code for repackaged APIs stubs jar

Source code for the App Engine local dev application server and local utilities.

• Public Documentation
• Source Code for tools APIs (appcfg)
• Source Code for XML validator (appcfg)
• Source Code for local devappserver
• Source Code for shared utilities (appcfg)
• Source Code for shared utilities (config)

Source code for the App Engine production application server and utilities. It is based on the Jetty9.4 Web Server.

• Public Documentation
• Source Code for the runtime implementation
• Source Code for the Java Main
• End-to-End test Web Applications
• End-to-End tests
• Source Code for runtime utilities

The Java 17, Java 21 and 25 runtimes can benefit from extra user configuration when starting the JVM for web apps.

The default entrypoint used to boot the JVM is generated by App Engine Buildpacks.Essentially, it is equivalent to define this entrypoint in theappengine-web.xml file. For example:

java --add-opens java.base/java.lang=ALL-UNNAMED  --add-opens java.base/java.nio.charset=ALL-UNNAMED -showversion -Xms32M -Xmx204M -XX:+UseG1GC -XX:+ParallelRefProcEnabled -XX:+PrintCommandLineFlags -Dclasspath.runtimebase=/base/java_runtime -Djava.class.path=/base/java_runtime/runtime-main.jar -Djava.library.path=/base/java_runtime: com/google/apphosting/runtime/JavaRuntimeMainWithDefaults --fixed_application_path=/workspace /base/java_runtime

We do not recommend changing this default entrypoint as the memory settings are calculated based on the instance type (F1, F2, F4) and memory available.

By default, we use--add-opens java.base/java.lang=ALL-UNNAMED --add-opens java.base/java.nio.charset=ALL-UNNAMED to open some necessary JDK APIs.

The entry point for the Java 17, Java 21, 25 runtimes can be customized with user-defined environment variables added in theappengine-web.xml configuration file.

The following table indicates the environment variables that can be used to enable/disable/configure features, and the default values if they are not set:

If not explicitly set,JAVA_OPTS is defaulted to:

JAVA_OPTS:=-showversion \           ${DBG_AGENT} \           ${PROFILER_AGENT} \           ${JAVA_HEAP_OPTS} \           ${JAVA_GC_OPTS} \           ${JAVA_USER_OPTS}

WhenCPROF_ENABLE is true, the default entrypoint adds thePROFILER_AGENT as:

-agentpath:/opt/cprof/profiler_java_agent.so=--logtostderr

For example, if your application code needs more-add-opens flags, you can use theJAVA_USER_OPTS environment variable defined in theappengine-web.xml file:

  <env-variables>     <env-var name="JAVA_USER_OPTS" value="--add-opens java.base/java.util=ALL-UNNAMED" />   </env-variables>

Note:

• Only one ofappengine.use.EE8,appengine.use.EE10, orappengine.use.EE11 can be set totrue at a time.
• Flags can be set inWEB-INF/appengine-web.xml or via Java system properties (e.g.,-Dappengine.use.EE10=true). System properties overrideappengine-web.xml.
• EE6 = Servlet 3.1 (javax.*), EE8 = Servlet 4.0 (javax.*), EE10 = Servlet 5.0 (jakarta.*), EE11 = Servlet 6.0 (jakarta.*).
• Jetty 12.1 should be fully backward compatible with Jetty 12.0 and EE11 version should also be backward compatible with EE10.
• EE8 should also be backward compatible with EE6.

Check out thecontributing guide to learn how you can report issues and help make changes.

Always be sure to follow theCode of Conduct.