This section is currently a draft, and is subject to change.

This documentation and the accompanying materials are made available under the terms of the Eclipse Public License v. 2.0, which is available at

SPDX-License-Identifier: EPL-2.0

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

About this Tutorial

This tutorial explains how to use the features of the Jakarta EE Platform to build cloud-native applications, such as microservices, "right sized" services, and server-based web applications.


Jakarta EE applications use the Java Platform, and are usually written in the Java programming language. All the examples in this tutorial are written in Java. If you’re new to Java, spend some time getting up to speed on the language and platform; a good place to start is

Each topic in this tutorial provides some background information, but in general, we assume you have a basic understanding of the technologies each Jakarta EE feature works with. For example, in the Jakarta Persistence chapter, we assume you have a basic understanding of relational databases.


Throughout this tutorial, we use the following typographic conventions:

Convention Meaning Example


Boldface type indicates a term defined in text or graphical user interface elements associated with an action.

A cache is a copy stored locally.

From the File menu, choose Open Project.


Monospace type indicates the names of files and directories, commands within a paragraph, URLs, code in examples, text that appears on the screen, or text that you enter.

Edit your .login file.

Use ls -a to list all files.

machine_name% you have mail.


Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.

Read Chapter 6 in the User’s Guide.

Do not save the file.

The command to remove a file is rm filename.

Default Paths and File Names

We are working on a fresh, updated Jakarta EE Tutorial. This section hasn’t yet been updated.

The following table describes the default paths and file names that are used in this book.

Placeholder Description Default Value


Represents the base installation directory for GlassFish Server.

Installations on the Linux, UNIX, or macOS:


Windows, all installations:



Represents the parent of the base installation directory for GlassFish Server.

Installations on UNIX/Linux/macOS:





Represents the base installation directory for the Jakarta EE Tutorial examples project after you download or clone it.



Represents the directory in which a domain’s configuration is stored.