Skip to content

Commit 7660217

Browse files
committed
Generated docs for WF11 Final
1 parent 3e18fa0 commit 7660217

File tree

107 files changed

+2273
-2165
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

107 files changed

+2273
-2165
lines changed

README.md

Lines changed: 123 additions & 15 deletions
Large diffs are not rendered by default.

RELEASE_PROCEDURE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Quickstarts Release Procedure
44
Testing the quickstarts
55
-----------------------
66

7-
Most of the quickstarts require starting ${product.name.full} in standalone mode. Some require the "standalone-full" profile, some require XTS, some require Postgres and some require other quickstarts to be deployed. Profiles are used in the root POM to separate out these groups, allowing you to test the quickstarts easily. For example, to run those that require only standalone mode:
7+
Most of the quickstarts require starting WildFly Application Server in standalone mode. Some require the "standalone-full" profile, some require XTS, some require Postgres and some require other quickstarts to be deployed. Profiles are used in the root POM to separate out these groups, allowing you to test the quickstarts easily. For example, to run those that require only standalone mode:
88

99
mvn clean verify wildfly:deploy wildfly:undeploy -Parq-remote -P-requires-postgres,-requires-full,-complex-dependencies,-requires-xts
1010

app-client/README.md

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
# app-client: Use the ${product.name} Application Client Container
1+
# app-client: Use the WildFly Application Client Container
22

33
Author: Wolf-Dieter Fink
44
Level: Intermediate
55
Technologies: EJB, EAR, AppClient
6-
Summary: The `app-client` quickstart demonstrates how to code and package a client app and use the ${product.name} client container to start the client Main program.
7-
Target Product: ${product.name}
8-
Source: <${github.repo.url}>
6+
Summary: The `app-client` quickstart demonstrates how to code and package a client app and use the WildFly client container to start the client Main program.
7+
Target Product: WildFly
8+
Source: <https://github.com/wildfly/quickstart/>
99

1010

1111
## What is it?
1212

13-
The `app-client` quickstart demonstrates how to use the ${product.name} client container to start the client `Main` program and provide Dependency Injections (DI) for client applications in ${product.name.full}. It also shows you how to use Maven to package the application according to the JavaEE specification.
13+
The `app-client` quickstart demonstrates how to use the WildFly client container to start the client `Main` program and provide Dependency Injections (DI) for client applications in WildFly Application Server. It also shows you how to use Maven to package the application according to the JavaEE specification.
1414

1515

1616
This example consists of the following Maven projects, each with a shared parent:
@@ -27,19 +27,19 @@ The root `pom.xml` file builds each of the subprojects in the appropriate order.
2727

2828
## System Requirements
2929

30-
The application this project produces is designed to be run on ${product.name.full} ${product.version} or later.
30+
The application this project produces is designed to be run on WildFly Application Server 11 or later.
3131

32-
All you need to build this project is ${build.requirements}. See [Configure Maven for ${product.name} ${product.version}](https://github.com/jboss-developer/jboss-developer-shared-resources/blob/master/guides/CONFIGURE_MAVEN_JBOSS_EAP7.md#configure-maven-to-build-and-deploy-the-quickstarts) to make sure you are configured correctly for testing the quickstarts.
32+
All you need to build this project is Java 8.0 (Java SDK 1.8) or later and Maven 3.3.1 or later. See [Configure Maven for WildFly 11](https://github.com/jboss-developer/jboss-developer-shared-resources/blob/master/guides/CONFIGURE_MAVEN_JBOSS_EAP7.md#configure-maven-to-build-and-deploy-the-quickstarts) to make sure you are configured correctly for testing the quickstarts.
3333

3434

35-
## Use of ${jboss.home.name}
35+
## Use of WILDFLY_HOME
3636

37-
In the following instructions, replace `${jboss.home.name}` with the actual path to your ${product.name} installation. The installation path is described in detail here: [Use of ${jboss.home.name} and JBOSS_HOME Variables](https://github.com/jboss-developer/jboss-developer-shared-resources/blob/master/guides/USE_OF_${jboss.home.name}.md#use-of-eap_home-and-jboss_home-variables).
37+
In the following instructions, replace `WILDFLY_HOME` with the actual path to your WildFly installation. The installation path is described in detail here: [Use of WILDFLY_HOME and JBOSS_HOME Variables](https://github.com/jboss-developer/jboss-developer-shared-resources/blob/master/guides/USE_OF_WILDFLY_HOME.md#use-of-eap_home-and-jboss_home-variables).
3838

3939

4040
## Add the Application Users
4141

42-
If the client and server are run on different hosts, you must add the following users to the ${product.name} server side application. Be sure to use the names and passwords specified in the table as they are required to run this example.
42+
If the client and server are run on different hosts, you must add the following users to the WildFly server side application. Be sure to use the names and passwords specified in the table as they are required to run this example.
4343

4444
| **UserName** | **Realm** | **Password** | **Roles** |
4545
|:-----------|:-----------|:-----------|:-----------|
@@ -49,28 +49,28 @@ If the client and server are run on different hosts, you must add the following
4949
To add the users, open a command prompt and type the following commands:
5050

5151
For Linux:
52-
${jboss.home.name}/bin/add-user.sh -u admin -p admin-123
53-
${jboss.home.name}/bin/add-user.sh -a -u quickuser -p quick-123
52+
WILDFLY_HOME/bin/add-user.sh -u admin -p admin-123
53+
WILDFLY_HOME/bin/add-user.sh -a -u quickuser -p quick-123
5454

5555
For Windows:
56-
${jboss.home.name}\bin\add-user.bat -u admin -p admin-123
57-
${jboss.home.name}\bin\add-user.bat -a -u quickuser -p quick-123
56+
WILDFLY_HOME\bin\add-user.bat -u admin -p admin-123
57+
WILDFLY_HOME\bin\add-user.bat -a -u quickuser -p quick-123
5858

5959
If you prefer, you can use the add-user utility interactively. For an example of how to use the add-user utility, see the instructions located here: [Add an Application User](https://github.com/jboss-developer/jboss-developer-shared-resources/blob/master/guides/CREATE_USERS.md#add-an-application-user).
6060

6161

6262
## Start the Server
6363

64-
1. Open a command prompt and navigate to the root of the ${product.name} directory.
64+
1. Open a command prompt and navigate to the root of the WildFly directory.
6565
2. The following shows the command line to start the server:
6666

67-
For Linux: ${jboss.home.name}/bin/standalone.sh
68-
For Windows: ${jboss.home.name}\bin\standalone.bat
67+
For Linux: WILDFLY_HOME/bin/standalone.sh
68+
For Windows: WILDFLY_HOME\bin\standalone.bat
6969

7070

7171
## Build and Deploy the Quickstart
7272

73-
1. Make sure you have started the ${product.name} server as described above.
73+
1. Make sure you have started the WildFly server as described above.
7474
2. Open a command prompt and navigate to the root directory of this quickstart.
7575
3. Type this command to build the artifacts:
7676

@@ -83,10 +83,10 @@ If you prefer, you can use the add-user utility interactively. For an example of
8383
This example shows how to invoke an EJB from a remote standalone application on the same machine. Both the client and server are on the same machine, so the defaults are sufficient and no authentication is necessary.
8484

8585
1. Be sure the quickstart deployed successfully as described above.
86-
2. Navigate to the root directory of this quickstart and type the following command to run the application. Be sure to replace `${jboss.home.name}` with the path to your ${product.name} installation.
86+
2. Navigate to the root directory of this quickstart and type the following command to run the application. Be sure to replace `WILDFLY_HOME` with the path to your WildFly installation.
8787

88-
For Linux: ${jboss.home.name}/bin/appclient.sh ear/target/app-client.ear#simpleClient.jar Hello from command line
89-
For Windows: ${jboss.home.name}\bin\appclient.bat ear\target\app-client.ear#simpleClient.jar Hello from command line
88+
For Linux: WILDFLY_HOME/bin/appclient.sh ear/target/app-client.ear#simpleClient.jar Hello from command line
89+
For Windows: WILDFLY_HOME\bin\appclient.bat ear\target\app-client.ear#simpleClient.jar Hello from command line
9090

9191
3. Review the result. The client outputs the following information provided by the server application:
9292

@@ -108,17 +108,17 @@ This example shows how to invoke an EJB from a remote standalone Java EE applica
108108

109109
### Configure Machine_1 (Remote Server Machine)
110110

111-
1. Install ${product.name} on this machine.
112-
2. Add the application users to the ${product.name} server on this machine as described above.
113-
3. Start the ${product.name} server with the following command. Be sure to replace `MACHINE_1_IP_ADDRESS` with the IP address of this machine. These arguments make the server accessible to the network.
111+
1. Install WildFly on this machine.
112+
2. Add the application users to the WildFly server on this machine as described above.
113+
3. Start the WildFly server with the following command. Be sure to replace `MACHINE_1_IP_ADDRESS` with the IP address of this machine. These arguments make the server accessible to the network.
114114

115-
For Linux: ${jboss.home.name}/bin/standalone.sh -b MACHINE_1_IP_ADDRESS -bmanagement MACHINE_1_IP_ADDRESS
116-
For Windows: ${jboss.home.name}\bin\standalone.bat -b MACHINE_1_IP_ADDRESS -bmanagement MACHINE_1_IP_ADDRESS
115+
For Linux: WILDFLY_HOME/bin/standalone.sh -b MACHINE_1_IP_ADDRESS -bmanagement MACHINE_1_IP_ADDRESS
116+
For Windows: WILDFLY_HOME\bin\standalone.bat -b MACHINE_1_IP_ADDRESS -bmanagement MACHINE_1_IP_ADDRESS
117117

118118

119119
### Configure Machine_2 (Local Client Machine)
120120

121-
1. Install ${product.name} on this server. There is no need to add the application users to this server.
121+
1. Install WildFly on this server. There is no need to add the application users to this server.
122122
2. Download the `app-client` quickstart to this machine.
123123
3. Create a `jboss-ejb-client.properties` file. This file can be located anywhere in the file system, but for ease of demonstration, we create it in the root directory of this quickstart. Add the following content, replacing `MACHINE_1_IP_ADDRESS` with the IP address of `Machine_1`.
124124

@@ -137,8 +137,8 @@ This example shows how to invoke an EJB from a remote standalone Java EE applica
137137
6. Be sure that the quickstart deployed successfully and the server is running on `Machine_1` as described above.
138138
7. Type this command to run the `app-client` application:
139139

140-
For Linux: ${jboss.home.name}/bin/appclient.sh --ejb-client-properties=ejb-client.properties ear/target/app-client.ear#simpleClient.jar Hello from command line
141-
For Windows: ${jboss.home.name}\bin\appclient.bat --ejb-client-properties=ejb-client.properties ear\target\app-client.ear#simpleClient.jar Hello from command line
140+
For Linux: WILDFLY_HOME/bin/appclient.sh --ejb-client-properties=ejb-client.properties ear/target/app-client.ear#simpleClient.jar Hello from command line
141+
For Windows: WILDFLY_HOME\bin\appclient.bat --ejb-client-properties=ejb-client.properties ear\target\app-client.ear#simpleClient.jar Hello from command line
142142

143143
8. Review the result. The client outputs the following information, which was provided by the application:
144144

@@ -162,7 +162,7 @@ This example shows how to invoke an EJB from a remote standalone Java EE applica
162162

163163
Follow these instructions if you are testing the quickstart on the same machine.
164164

165-
1. Make sure you have started the ${product.name} server on the machine where the quickstart is deployed as described above.
165+
1. Make sure you have started the WildFly server on the machine where the quickstart is deployed as described above.
166166
2. Open a command prompt on that server and navigate to the root directory of this quickstart.
167167
3. When you are finished testing, type this command to undeploy the archive from the local machine.
168168

@@ -173,7 +173,7 @@ Follow these instructions if you are testing the quickstart on the same machine.
173173

174174
Follow these instructions if you are testing the quickstart on a different machine.
175175

176-
1. Make sure you have started the ${product.name} server on the remote server machine, `Machine_1`, where the quickstart is deployed as described above.
176+
1. Make sure you have started the WildFly server on the remote server machine, `Machine_1`, where the quickstart is deployed as described above.
177177
2. Open a command prompt on the local client machine, `Machine_2`, and navigate to the root directory of this quickstart.
178178
3. When you are finished testing, type this command to undeploy the archive from the remote server machine, `Machine_1`.
179179

batch-processing/README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ Author: Rafael Benevides
44
Level: Intermediate
55
Technologies: CDI, Batch 1.0, JSF
66
Summary: The `batch-processing` quickstart shows how to use chunk oriented batch jobs to import a file to a database.
7-
Target Product: ${product.name}
8-
Source: <${github.repo.url}>
7+
Target Product: WildFly
8+
Source: <https://github.com/wildfly/quickstart/>
99

1010

1111
## What is it?
@@ -19,46 +19,46 @@ The Job contains two steps (tasks):
1919

2020
The database schema defines that the column for name is unique. For that reason, any atempt to persist a duplicate value will throw an exception. On the second attempt to run the job, the `ChunkCheckpoint` will provide information to skip the Contacts that were already persisted.
2121

22-
_Note: This quickstart uses the H2 database included with ${product.name.full} ${product.version}. It is a lightweight, relational example datasource that is used for examples only. It is not robust or scalable, is not supported, and should NOT be used in a production environment!_
22+
_Note: This quickstart uses the H2 database included with WildFly Application Server 11. It is a lightweight, relational example datasource that is used for examples only. It is not robust or scalable, is not supported, and should NOT be used in a production environment!_
2323

24-
_Note: This quickstart uses a `*-ds.xml` datasource configuration file for convenience and ease of database configuration. These files are deprecated in ${product.name} and should not be used in a production environment. Instead, you should configure the datasource using the Management CLI or Management Console. Datasource configuration is documented in the [Configuration Guide](https://access.redhat.com/documentation/en/red-hat-jboss-enterprise-application-platform/) for ${product.name.full}._
24+
_Note: This quickstart uses a `*-ds.xml` datasource configuration file for convenience and ease of database configuration. These files are deprecated in WildFly and should not be used in a production environment. Instead, you should configure the datasource using the Management CLI or Management Console. Datasource configuration is documented in the [Configuration Guide](https://access.redhat.com/documentation/en/red-hat-jboss-enterprise-application-platform/) for WildFly Application Server._
2525

2626
## System Requirements
2727

28-
The application this project produces is designed to be run on ${product.name.full} ${product.version} or later.
28+
The application this project produces is designed to be run on WildFly Application Server 11 or later.
2929

30-
All you need to build this project is ${build.requirements}. See [Configure Maven for ${product.name} ${product.version}](https://github.com/jboss-developer/jboss-developer-shared-resources/blob/master/guides/CONFIGURE_MAVEN_JBOSS_EAP7.md#configure-maven-to-build-and-deploy-the-quickstarts) to make sure you are configured correctly for testing the quickstarts.
30+
All you need to build this project is Java 8.0 (Java SDK 1.8) or later and Maven 3.3.1 or later. See [Configure Maven for WildFly 11](https://github.com/jboss-developer/jboss-developer-shared-resources/blob/master/guides/CONFIGURE_MAVEN_JBOSS_EAP7.md#configure-maven-to-build-and-deploy-the-quickstarts) to make sure you are configured correctly for testing the quickstarts.
3131

3232

33-
## Use of ${jboss.home.name}
33+
## Use of WILDFLY_HOME
3434

35-
In the following instructions, replace `${jboss.home.name}` with the actual path to your ${product.name} installation. The installation path is described in detail here: [Use of ${jboss.home.name} and JBOSS_HOME Variables](https://github.com/jboss-developer/jboss-developer-shared-resources/blob/master/guides/USE_OF_${jboss.home.name}.md#use-of-eap_home-and-jboss_home-variables).
35+
In the following instructions, replace `WILDFLY_HOME` with the actual path to your WildFly installation. The installation path is described in detail here: [Use of WILDFLY_HOME and JBOSS_HOME Variables](https://github.com/jboss-developer/jboss-developer-shared-resources/blob/master/guides/USE_OF_WILDFLY_HOME.md#use-of-eap_home-and-jboss_home-variables).
3636

3737

3838

3939
## Start the Server
4040

4141

42-
1. Open a command line and navigate to the root of the ${product.name} directory.
42+
1. Open a command line and navigate to the root of the WildFly directory.
4343
2. The following shows the command line to start the server with the default profile:
4444

45-
For Linux: ${jboss.home.name}/bin/standalone.sh
46-
For Windows: ${jboss.home.name}\bin\standalone.bat
45+
For Linux: WILDFLY_HOME/bin/standalone.sh
46+
For Windows: WILDFLY_HOME\bin\standalone.bat
4747

4848

4949
## Build and Deploy the Quickstart
5050

51-
1. Make sure you have started the ${product.name} server as described above.
51+
1. Make sure you have started the WildFly server as described above.
5252
2. Open a command line and navigate to the root directory of this quickstart.
5353
3. Type this command to build and deploy the archive:
5454

5555
mvn clean package wildfly:deploy
56-
4. This will deploy `target/${project.artifactId}.war` to the running instance of the server.
56+
4. This will deploy `target/batch-processing.war` to the running instance of the server.
5757

5858

5959
## Access the Application
6060

61-
Access the running application in a browser at the following URL: <http://localhost:8080/${project.artifactId}/>
61+
Access the running application in a browser at the following URL: <http://localhost:8080/batch-processing/>
6262

6363
You are presented with a simple form that allows you to generate sample files to be imported.
6464

@@ -148,7 +148,7 @@ _Note:_ You will see the following warnings in the server log. You can ignore th
148148

149149
## Undeploy the Archive
150150

151-
1. Make sure you have started the ${product.name} server as described above.
151+
1. Make sure you have started the WildFly server as described above.
152152
2. Open a command prompt and navigate to the root directory of this quickstart.
153153
3. When you are finished testing, type this command to undeploy the archive:
154154

@@ -157,7 +157,7 @@ _Note:_ You will see the following warnings in the server log. You can ignore th
157157

158158
## Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse
159159

160-
You can also start the server and deploy the quickstarts or run the Arquillian tests from Eclipse using JBoss tools. For general information about how to import a quickstart, add a ${product.name} server, and build and deploy a quickstart, see [Use JBoss Developer Studio or Eclipse to Run the Quickstarts](${use.eclipse.url}).
160+
You can also start the server and deploy the quickstarts or run the Arquillian tests from Eclipse using JBoss tools. For general information about how to import a quickstart, add a WildFly server, and build and deploy a quickstart, see [Use JBoss Developer Studio or Eclipse to Run the Quickstarts](https://github.com/jboss-developer/jboss-developer-shared-resources/blob/master/guides/USE_JBDS.md#use-jboss-developer-studio-or-eclipse-to-run-the-quickstarts).
161161

162162

163163
## Debug the Application

0 commit comments

Comments
 (0)