Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document GlassFish API in the Application Development guide #25090

Merged
merged 1 commit into from
Aug 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/application-development-guide/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,18 @@
<artifactId>application-development-guide</artifactId>
<packaging>jar</packaging>
<name>Eclipse GlassFish Application Development Guide, Release 7</name>
<build>
<plugins>
<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
<configuration>
<attributes>
<sectnums>true</sectnums>
<sectnumlevels>1</sectnumlevels>
</attributes>
</configuration>
</plugin>
</plugins>
</build>
</project>
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ prev=setting-up-dev-env.html
= Class Loaders

[[class-loaders]]
== 2 Class Loaders
== Class Loaders

Understanding {productName} class loaders can help you
determine where to place supporting JAR and resource files for your
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ prev=java-clients.html
= Developing Connectors

[[developing-connectors]]
== 11 Developing Connectors
== Developing Connectors

This chapter describes {productName} support for the Jakarta EE
Connector Architecture, also known as
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ prev=ejb.html
= Using Container-Managed Persistence

[[using-container-managed-persistence]]
== 9 Using Container-Managed Persistence
== Using Container-Managed Persistence

This chapter contains information on how EJB 2.1 container-managed
persistence (CMP) works in {productName}.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ prev=class-loaders.html
= Debugging Applications

[[debugging-applications]]
== 3 Debugging Applications
== Debugging Applications

This chapter gives guidelines for debugging applications in the {productName}.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ prev=webapps.html
= Using Enterprise JavaBeans Technology

[[using-enterprise-javabeans-technology]]
== 8 Using Enterprise JavaBeans Technology
== Using Enterprise JavaBeans Technology

This chapter describes how Enterprise JavaBeans ( EJB) technology is
supported in the {productName}.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
type=page
status=published
title=API for development
next=securing-apps.html
prev=part-apps-and-app-comps.html
~~~~~~

= API for development

[[api-for-dev]]
== API for development

{productName} provides several APIs to build applications and components:

* https://jakarta.ee[Jakarta EE API] - Platform or Web profile, depends on the {productName} distribution
* https://microprofile.io[MicroProfile API] - selected specifications, only avaiable in {productName} Full
* GlassFish API - to access other functionality provided by {productName}

GlassFish API is composed of a few sets of APIs:

* GlassFish API
* GlassFish EE API
* Simple GlassFish API

[[glassfish-api]]
### GlassFish API

Most of the functionality specific to {productName} is available in the GlassFish API. To compile applications or components, add the `glassfish-api.jar` to the compile classpath. You may also need `scattered-archive-api.jar`.

The `glassfish-api.jar` is located in the {productName} installation in as-install``/modules/glassfish-api.jar``.

In Maven project, you can add it as the following dependency:

```
<dependency>
<groupId>org.glassfish.main.common</groupId>
<artifactId>glassfish-api</artifactId>
</dependency>
```

This will already add `scattered-archive-api.jar` as a transitive dependency.

[[glassfish-ee-api]]
### GlassFish EE API

GlassFish EE API provides functionality related to Jakarta EE. To compile applications or components, add the `glassfish-ee-api.jar` to the compile classpath.

The `glassfish-ee-api.jar` is located in the {productName} installation in as-install``/modules/glassfish-ee-api.jar``.

In Maven project, you can add it as the following dependency:

```
<dependency>
<groupId>org.glassfish.main.common</groupId>
<artifactId>glassfish-ee-api</artifactId>
</dependency>
```

[[simple-glassfish-api]]
### Simple GlassFish API

Simple GlassFish API provides basic functionality to deploy applications and run admin commands. Mostly to use embedded {productName} programmatically. To compile applications or components, add the `simple-glassfish-api.jar` to the compile classpath.

The `simple-glassfish-api.jar` is located in the {productName} installation in as-install``/modules/simple-glassfish-api.jar``.

In Maven project, you can add it as the following dependency:

```
<dependency>
<groupId>org.glassfish.main.common</groupId>
<artifactId>simple-glassfish-api</artifactId>
</dependency>
```

Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ prev=container_managed-persistence.html
= Developing Java Clients

[[developing-java-clients]]
== 10 Developing Java Clients
== Developing Java Clients

This chapter describes how to develop, assemble, and deploy Java
clients.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ prev=part-services-and-apis.html
= Using the JDBC API for Database Access

[[using-the-jdbc-api-for-database-access]]
== 14 Using the JDBC API for Database Access
== Using the JDBC API for Database Access

This chapter describes how to use the Java Database Connectivity (JDBC)
API for database access with the {productName}. This chapter
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ prev=jndi.html
= Using the Java Message Service

[[using-the-java-message-service]]
== 17 Using the Java Message Service
== Using the Java Message Service

This chapter describes how to use the Java Message Service (JMS) API.
The {productName} has a fully integrated JMS provider: the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ prev=transaction-service.html
= Using the Java Naming and Directory Interface

[[using-the-java-naming-and-directory-interface]]
== 16 Using the Java Naming and Directory Interface
== Using the Java Naming and Directory Interface

A naming service maintains a set of bindings, which relate names to
objects. The Jakarta EE naming service is based on the Java Naming and
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ prev=webservices.html
= Configuring the Java Persistence Provider

[[configuring-the-java-persistence-provider]]
== 6 Configuring the Java Persistence Provider
== Configuring the Java Persistence Provider

This chapter describes Oracle TopLink, the default persistence provider
in {productName}, and introduces how to use it.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ prev=connectors.html
= Developing Lifecycle Listeners

[[developing-lifecycle-listeners]]
== 12 Developing Lifecycle Listeners
== Developing Lifecycle Listeners

Lifecycle listener modules provide a means of running short or long
duration Java-based tasks within the {productName}
Expand All @@ -26,7 +26,7 @@ interface instead is recommended.


All lifecycle module classes and interfaces are in the
as-install``/modules/``glassfish-api.jar`` file.
`as-install/modules/glassfish-api.jar` file.

For Javadoc tool pages relevant to lifecycle modules, see the
`com.sun.appserv.server` package.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ prev=jms.html
= Using the Jakarta Mail API

[[using-the-jakarta-mail-api]]
== 18 Using the Jakarta Mail API
== Using the Jakarta Mail API

This chapter describes how to use the Jakarta Mail API, which provides a set
of abstract classes defining objects that comprise a mail system.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ prev=lifecycle-listeners.html
= Developing OSGi-enabled Jakarta EE Applications

[[developing-osgi-enabled-java-ee-applications]]
== 13 Developing OSGi-enabled Jakarta EE Applications
== Developing OSGi-enabled Jakarta EE Applications

This chapter describes the features and interfaces that {productName}
provides to develop OSGi-enabled enterprise applications. This chapter
Expand Down
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
type=page
status=published
title=Developing Applications and Application Components
next=securing-apps.html
next=glassfish-api.html
prev=debugging-apps.html
~~~~~~

= Developing Applications and Application Components

:sectnums!:
[[part-ii]]

== Part II

:sectnums:
[[developing-applications-and-application-components]]
== Developing Applications and Application Components

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,11 @@ prev=osgi.html

= Using Services and APIs

:sectnums!:
[[part-iii]]

== Part III

:sectnums:
[[using-services-and-apis]]
== Using Services and APIs

Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,11 @@ prev=preface.html

= Development Tasks and Tools

:sectnums!:
[[part-i]]

== Part I

:sectnums:
[[development-tasks-and-tools]]
== Development Tasks and Tools

Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@ type=page
status=published
title=Securing Applications
next=webservices.html
prev=part-apps-and-app-comps.html
prev=glassfish-api.html
~~~~~~

= Securing Applications

[[securing-applications]]
== 4 Securing Applications
== Securing Applications

This chapter describes how to write secure Jakarta EE applications, which
contain components that perform user authentication and access
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ prev=part-tasks-and-tools.html
= Setting Up a Development Environment

[[setting-up-a-development-environment]]
== 1 Setting Up a Development Environment
== Setting Up a Development Environment

This chapter gives guidelines for setting up an application development
environment in the {productName}. Setting up an environment
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ prev=jdbc.html
= Using the Transaction Service

[[using-the-transaction-service]]
== 15 Using the Transaction Service
== Using the Transaction Service

The Jakarta EE platform provides several abstractions that simplify
development of dependable transaction processing for applications. This
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ prev=jpa.html
= Developing Web Applications

[[developing-web-applications]]
== 7 Developing Web Applications
== Developing Web Applications

This chapter describes how web applications are supported in the {productName}.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ prev=securing-apps.html
= Developing Web Services

[[developing-web-services]]
== 5 Developing Web Services
== Developing Web Services

This chapter describes {productName} support for web services.
The following topics are addressed here:
Expand Down