Skip to content

Commit

Permalink
Merge pull request #362 from emmartins/WFLY-12594
Browse files Browse the repository at this point in the history
[WFLY-12594] Updates Quickstarts docs, replacing references to Java E…
  • Loading branch information
emmartins committed Sep 26, 2019
2 parents ab3faee + 9dffc41 commit 3bd498b
Show file tree
Hide file tree
Showing 91 changed files with 147 additions and 158 deletions.
10 changes: 5 additions & 5 deletions CONTRIBUTING.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ To monitor and participate in the latest development discussions, join the JBoss

=== Purpose of the Quickstarts

. To demonstrate Java EE technologies.
. To demonstrate Jakarta EE technologies.
. To provide developers with working examples and instructions that are easy to follow.
. To provide code examples to be copied by developers and used as the basis for their own projects.

Expand Down Expand Up @@ -246,7 +246,7 @@ See the https://github.com/wildfly/quickstart/blob/11.x/pom.xml#L155[WildFly par
* Maven POM files must be used. No other build system is allowed unless the purpose of the quickstart is to show another build system in use. If using Maven it should:

** Not inherit from another POM except for the top-level parent POM.
** Maven POMs must use the Java EE spec BOM/POM imports
** Maven POMs must use the WildFly BOM/POM imports
** The POMs must be commented, with a comment each item in the POM
** Import the various BOMs defined in the xref:eap_maven_repositories[JBoss EAP repositories]. You should not declare dependencies directly. If you do need additional artifacts, contact the Quickstart team to get them added to a BOM.
** Use the WildFly Maven Plugin to deploy the example.
Expand All @@ -261,22 +261,22 @@ See the https://github.com/wildfly/quickstart/blob/11.x/pom.xml#L155[WildFly par

* Do not forget to add your quickstart to the `modules` section in the parent `pom.xml` file.

* The project must target Java EE 7 or Java EE 8.
* The project must target Jakarta EE 8.

** CDI should be used as the programming model
** Avoid using a `web.xml` file if possible. Use a `faces-config.xml` to activate JSF if needed.
** Any tests should use Arquillian.

* If the quickstart persists to a database, you must use a unique datasource JNDI name and connection URL for the application and for any Arquillian tests that it provides. Do not use the JNDI name `java:jboss/datasources/ExampleDS`. Failure to use unique names can result in a `DuplicateServiceException` when more than one quickstart is deployed to the same server.

* Be sure to test the quickstart in {JBDSProductName}, which strictly enforces Java EE coding rules!
* Be sure to test the quickstart in {JBDSProductName}, which strictly enforces Jakarta EE coding rules!

* If possible, create a cheat sheet for the quickstart to guide users and developers through the example. See xref:create_a_quickstart_cheat_sheet[Create a Quickstart Cheat Sheet] for more information.

[[kitchensink_variants]]
=== Kitchensink variants

There are multiple quickstarts based on the ``kitchensink` quickstarts example. Each showcases different technologies and techniques including pure Java EE, JSF, HTML5, and GWT.
There are multiple quickstarts based on the ``kitchensink` quickstarts example. Each showcases different technologies and techniques including pure Jakarta EE, JSF, HTML5, and GWT.

If you wish to contribute a kitchensink variant is it important that you follow the look and feel of the original so that useful comparisons can be made. This does not mean that variants can not expand, and showcase additional functionality. Multiple variants already do that. These include mobile interfaces, push updates, and more.

Expand Down
14 changes: 7 additions & 7 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ ifndef::ProductRelease,EAPCDRelease[]
[toc]

[abstract]
The quickstarts demonstrate Java EE 8 and a few additional technologies from the WildFly stack. They provide small, specific, working examples that can be used as a reference for your own project.
The quickstarts demonstrate Jakarta EE 8 and a few additional technologies from the WildFly stack. They provide small, specific, working examples that can be used as a reference for your own project.

[[introduction]]
== Introduction
Expand Down Expand Up @@ -443,7 +443,7 @@ NOTE: Some of these quickstarts use the H2 database included with WildFly. It is
| link:ejb-in-war/README{outfilesuffix}[ejb-in-war]|EJB, JSF, WAR | The `ejb-in-war` quickstart demonstrates how to package an EJB bean in a WAR archive and deploy it to {productName}. Arquillian tests are also provided. | Intermediate | _none_
| link:ejb-multi-server/README{outfilesuffix}[ejb-multi-server]|EJB, EAR | The `ejb-multi-server` quickstart shows how to communicate between multiple applications deployed to different servers using an EJB to log the invocation. | Advanced | _none_
| link:ejb-remote/README{outfilesuffix}[ejb-remote]|EJB, JNDI | The `ejb-remote` quickstart uses EJB and JNDI to demonstrate how to access an EJB, deployed to {productName}, from a remote Java client application. | Intermediate | _none_
| link:ejb-security/README{outfilesuffix}[ejb-security]|EJB, Security | The `ejb-security` quickstart demonstrates the use of Java EE declarative security to control access to EJBs in {productName}. | Intermediate | _none_
| link:ejb-security/README{outfilesuffix}[ejb-security]|EJB, Security | The `ejb-security` quickstart demonstrates the use of Jakarta EE declarative security to control access to EJBs in {productName}. | Intermediate | _none_
| link:ejb-security-context-propagation/README{outfilesuffix}[ejb-security-context-propagation]|EJB, Security | The `ejb-security-context-propagation` quickstart demonstrates how the security context can be propagated to a remote EJB using a remote outbound connection configuration | Advanced | _none_
| link:ejb-security-jaas/README{outfilesuffix}[ejb-security-jaas]|EJB, Security | The `ejb-security-jaas` quickstart demonstrates how legacy `JAAS` security domains can be used in conjunction with `Elytron` | Intermediate | _none_
| link:ejb-security-programmatic-auth/README{outfilesuffix}[ejb-security-programmatic-auth]|EJB, Security | The `ejb-security-programmatic-auth` quickstart demonstrates how to programmatically setup different identities when invoking a remote secured EJB. | Intermediate | _none_
Expand Down Expand Up @@ -490,7 +490,7 @@ NOTE: Some of these quickstarts use the H2 database included with WildFly. It is
| link:logging/README{outfilesuffix}[logging]|Logging | The `logging` quickstart demonstrates how to configure different logging levels in {productName}. It also includes an asynchronous logging example. | Intermediate | _none_
| link:logging-tools/README{outfilesuffix}[logging-tools]|JBoss Logging Tools | The `logging-tools` quickstart shows how to use JBoss Logging Tools to create internationalized loggers, exceptions, and messages and localize them. | Beginner | _none_
| link:mail/README{outfilesuffix}[mail]|JavaMail, CDI, JSF | The `mail` quickstart demonstrates how to send email using CDI and JSF and the default Mail provider that ships with {productName}. | Beginner | _none_
| link:managed-executor-service/README{outfilesuffix}[managed-executor-service]|EE Concurrency Utilities, JAX-RS, JAX-RS Client API | The `managed-executor-service` quickstart demonstrates how Java EE applications can submit tasks for asynchronous execution. | Beginner | _none_
| link:managed-executor-service/README{outfilesuffix}[managed-executor-service]|EE Concurrency Utilities, JAX-RS, JAX-RS Client API | The `managed-executor-service` quickstart demonstrates how Jakarta EE applications can submit tasks for asynchronous execution. | Beginner | _none_
| link:messaging-clustering/README{outfilesuffix}[messaging-clustering]|JMS, MDB | The `messaging-clustering` quickstart does not contain any code and instead uses the `helloworld-mdb` quickstart to demonstrate clustering using ActiveMQ Messaging. | Intermediate | link:helloworld-mdb/README.html[helloworld-mdb]
| link:messaging-clustering-singleton/README{outfilesuffix}[messaging-clustering-singleton]|JMS, MDB, Clustering | The `messaging-clustering-singleton` quickstart uses a JMS topic and a queue to demonstrate clustering using {productName} messaging with MDB singleton configuration where only one node in the cluster will be active. | Advanced | _none_
| link:numberguess/README{outfilesuffix}[numberguess]|CDI, JSF | The `numberguess` quickstart demonstrates the use of CDI (Contexts and Dependency Injection) and JSF (JavaServer Faces) in {productName}. | Beginner | _none_
Expand All @@ -499,7 +499,7 @@ NOTE: Some of these quickstarts use the H2 database included with WildFly. It is
| link:security-domain-to-domain/README{outfilesuffix}[security-domain-to-domain]|Servlet, EJB, Security | The `security-domain-to-domain` quickstart demonstrates the propagation of an identity across two different deployments using different security domains. | Advanced | _none_
| link:servlet-async/README{outfilesuffix}[servlet-async]|Asynchronous Servlet, CDI, EJB | The `servlet-async` quickstart demonstrates how to use asynchronous servlets to detach long-running tasks and free up the request processing thread. | Intermediate | _none_
| link:servlet-filterlistener/README{outfilesuffix}[servlet-filterlistener]|Servlet Filter, Servlet Listener | The `servlet-filterlistener` quickstart demonstrates how to use Servlet filters and listeners in an application. | Intermediate | _none_
| link:servlet-security/README{outfilesuffix}[servlet-security]|Servlet, Security | The `servlet-security` quickstart demonstrates the use of Java EE declarative security to control access to Servlets and Security in {productName}. | Intermediate | _none_
| link:servlet-security/README{outfilesuffix}[servlet-security]|Servlet, Security | The `servlet-security` quickstart demonstrates the use of Jakarta EE declarative security to control access to Servlets and Security in {productName}. | Intermediate | _none_
| link:shopping-cart/README{outfilesuffix}[shopping-cart]|SFSB EJB | The `shopping-cart` quickstart demonstrates how to deploy and run a simple {javaVersion} shopping cart application that uses a stateful session bean (SFSB). | Intermediate | _none_
| link:spring-greeter/README{outfilesuffix}[spring-greeter]|Spring MVC, JSP, JPA | The `spring-greeter` quickstart is based on the `greeter` quickstart, but differs in that it uses Spring MVC for Mapping `GET` and `POST` requests. | Beginner | _none_
| link:spring-kitchensink-basic/README{outfilesuffix}[spring-kitchensink-basic]|JSP, JPA, JSON, Spring, JUnit | The `spring-kitchensink-basic` quickstart is an example of a {javaVersion} application using JSP, JPA and Spring 4.x. | Intermediate | _none_
Expand All @@ -508,12 +508,12 @@ NOTE: Some of these quickstarts use the H2 database included with WildFly. It is
| link:tasks-jsf/README{outfilesuffix}[tasks-jsf]|JSF, JPA | The `tasks-jsf` quickstart demonstrates how to use JPA persistence with JSF as the view layer. | Intermediate | _none_
| link:tasks-rs/README{outfilesuffix}[tasks-rs]|JPA, JAX-RS | The `tasks-rs` quickstart demonstrates how to implement a JAX-RS service that uses JPA persistence. | Intermediate | _none_
| link:temperature-converter/README{outfilesuffix}[temperature-converter]|CDI, JSF, SLSB EJB | The `temperature-converter` quickstart does temperature conversion using an EJB Stateless Session Bean (SLSB), CDI, and a JSF front-end client. | Beginner | _none_
| link:thread-racing/README{outfilesuffix}[thread-racing]|Batch, CDI, EE Concurrency, JAX-RS, JMS, JPA, JSON, Web Sockets | A thread racing web application that demonstrates technologies introduced or updated in the latest Java EE specification. | Beginner | _none_
| link:thread-racing/README{outfilesuffix}[thread-racing]|Batch, CDI, EE Concurrency, JAX-RS, JMS, JPA, JSON, Web Sockets | A thread racing web application that demonstrates technologies introduced or updated in the latest Jakarta EE specification. | Beginner | _none_
| link:websocket-client/README{outfilesuffix}[websocket-client]|Web Socket, CDI Events, JSON, SSL | Demonstrates use of a Javascript WebSocket client, WebSocket configuration, programmatic binding, and secure WebSocket. | Intermediate | _none_
| link:websocket-endpoint/README{outfilesuffix}[websocket-endpoint]|CDI, WebSocket, JSON-P | Shows how to use WebSockets with JSON to broadcast information to all open WebSocket sessions in {productName}. | Beginner | _none_
| link:websocket-hello/README{outfilesuffix}[websocket-hello]|WebSocket, CDI, JSF | The `websocket-hello` quickstart demonstrates how to create a simple WebSocket application. | Beginner | _none_
| link:wicket-ear/README{outfilesuffix}[wicket-ear]|Apache Wicket, JPA | Demonstrates how to use the Wicket Framework 7.x with the JBoss server using the Wicket Java EE integration, packaged as an EAR | Intermediate | _none_
| link:wicket-war/README{outfilesuffix}[wicket-war]|Apache Wicket, JPA | Demonstrates how to use the Wicket Framework 7.x with the JBoss server using the Wicket Java EE integration packaged as a WAR | Intermediate | _none_
| link:wicket-ear/README{outfilesuffix}[wicket-ear]|Apache Wicket, JPA | Demonstrates how to use the Wicket Framework 7.x with the JBoss server using the Wicket Jakarta EE integration, packaged as an EAR | Intermediate | _none_
| link:wicket-war/README{outfilesuffix}[wicket-war]|Apache Wicket, JPA | Demonstrates how to use the Wicket Framework 7.x with the JBoss server using the Wicket Jakarta EE integration packaged as a WAR | Intermediate | _none_
| link:wsat-simple/README{outfilesuffix}[wsat-simple]|WS-AT, JAX-WS | The `wsat-simple` quickstart demonstrates a WS-AT (WS-AtomicTransaction) enabled JAX-WS Web service, bundled as a WAR, and deployed to {productName}. | Intermediate | _none_
| link:wsba-coordinator-completion-simple/README{outfilesuffix}[wsba-coordinator-completion-simple]|WS-BA, JAX-WS | The `wsba-coordinator-completion-simple` quickstart deploys a WS-BA (WS Business Activity) enabled JAX-WS Web service WAR (CoordinatorCompletion protocol). | Intermediate | _none_
| link:wsba-participant-completion-simple/README{outfilesuffix}[wsba-participant-completion-simple]|WS-BA, JAX-WS | The `wsba-participant-completion-simple` quickstart deploys a WS-BA (WS Business Activity) enabled JAX-WS Web service WAR (ParticipantCompletion Protocol). | Intermediate | _none_
Expand Down
4 changes: 2 additions & 2 deletions app-client/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The `app-client` quickstart demonstrates how to code and package a client app an

== What is it?

The `app-client` quickstart demonstrates how to use the {productName} client container to start the client `Main` program and provide Dependency Injections (DI) for client applications in {productNameFull}. It also shows you how to use Maven to package the application according to the Java EE specification.
The `app-client` quickstart demonstrates how to use the {productName} client container to start the client `Main` program and provide Dependency Injections (DI) for client applications in {productNameFull}. It also shows you how to use Maven to package the application according to the Jakarta EE specification.

This example consists of the following Maven projects, each with a shared parent.

Expand Down Expand Up @@ -80,7 +80,7 @@ ClientContext is here = {Client =dev84, jboss.source-address=localhost/127.0.0.1

== Access the Remote Client Application from a Different Machine

This example shows how to invoke an EJB from a remote standalone Java EE application on a different machine. In this case, the client needs to define a properties file to define properties to connect and authenticate to the server. The properties file is passed on the command line using the `--ejb-client-properties` argument.
This example shows how to invoke an EJB from a remote standalone Jakarta EE application on a different machine. In this case, the client needs to define a properties file to define properties to connect and authenticate to the server. The properties file is passed on the command line using the `--ejb-client-properties` argument.

=== Configure Machine_1 (Remote Server Machine)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
import javax.persistence.PersistenceContext;

/**
* This class uses CDI to alias Java EE resources, such as the persistence context, to CDI beans
* This class uses CDI to alias Jakarta EE resources, such as the persistence context, to CDI beans
*
* <p>
* Example injection on a managed bean field:
Expand Down
2 changes: 1 addition & 1 deletion bmt/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The `bmt` quickstart demonstrates Bean-Managed Transactions (BMT), showing how t
The `bmt` quickstart demonstrates how to manually manage transaction demarcation while accessing JPA entities in {productNameFull}.
On occasion, the application developer requires finer grained control over the lifecycle of JTA transactions and JPA Entity Managers than the defaults provided by the Java EE container. This example shows how the developer can override these defaults and take control of aspects of the lifecycle of JPA and transactions.
On occasion, the application developer requires finer grained control over the lifecycle of JTA transactions and JPA Entity Managers than the defaults provided by the Jakarta EE container. This example shows how the developer can override these defaults and take control of aspects of the lifecycle of JPA and transactions.
When you run this example, you are presented with a *Use bean managed Entity Managers* checkbox.
Expand Down
2 changes: 1 addition & 1 deletion contacts-jquerymobile/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
<artifactId>contacts-jquerymobile</artifactId>
<packaging>war</packaging>
<name>Quickstart: contacts-jquerymobile</name>
<description>A Java EE HTML5 mobile web application for use with JBoss EAP</description>
<description>A Jakarta EE HTML5 mobile web application for use with JBoss EAP</description>

<licenses>
<license>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
import javax.ws.rs.core.Application;

/**
* A class extending {@link Application} and annotated with @ApplicationPath is the Java EE 7 "no XML" approach to activating
* A class extending {@link Application} and annotated with @ApplicationPath is the Jakarta EE "no XML" approach to activating
* JAX-RS.
* <p>
* <p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
import javax.persistence.PersistenceContext;

/**
* This class uses CDI to alias Java EE resources, such as the persistence context, to CDI beans
* This class uses CDI to alias Jakarta EE resources, such as the persistence context, to CDI beans
*
* <p>
* Example injection on a managed bean field:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
import javax.inject.Named;

/**
* This class uses CDI to alias Java EE resources, such as the persistence context, to CDI beans
* This class uses CDI to alias Jakarta EE resources, such as the persistence context, to CDI beans
*
*/
public class Resources {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
import javax.persistence.PersistenceContext;

/**
* This class uses CDI to alias Java EE resources, such as the persistence context, to CDI beans
* This class uses CDI to alias Jakarta EE resources, such as the persistence context, to CDI beans
*
* <p>
* Example injection on a managed bean field:
Expand Down
4 changes: 2 additions & 2 deletions ejb-in-ear/ear/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,9 @@
<artifactId>maven-ear-plugin</artifactId>
<!-- configuring the EAR plug-in -->
<configuration>
<!-- Tell Maven we are using Java EE -->
<!-- Tell Maven we are using Jakarta EE -->
<version>7</version>
<!-- Use Java EE ear libraries as needed. Java EE ear libraries
<!-- Use Jakarta EE ear libraries as needed. Jakarta EE ear libraries
are in easy way to package any libraries needed in the ear, and automatically
have any modules (EJB-JARs and WARs) use them -->
<defaultLibBundleDir>lib</defaultLibBundleDir>
Expand Down
2 changes: 1 addition & 1 deletion ejb-multi-server/app-main/web/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-war-plugin</artifactId>
<configuration>
<!-- Java EE doesn't require web.xml, Maven needs to catch up! -->
<!-- Jakarta EE doesn't require web.xml, Maven needs to catch up! -->
<failOnMissingWebXml>false</failOnMissingWebXml>
<archive>
<addMavenDescriptor>false</addMavenDescriptor>
Expand Down

0 comments on commit 3bd498b

Please sign in to comment.