Skip to content

Commit

Permalink
Add processed .md files
Browse files Browse the repository at this point in the history
  • Loading branch information
ctomc committed Apr 18, 2017
1 parent a198601 commit 6583f6a
Show file tree
Hide file tree
Showing 94 changed files with 1,986 additions and 1,899 deletions.
5 changes: 0 additions & 5 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,6 @@ bin
*/.gitignore
.gitkeep
/helloworld-jsp
README.html
SERVICES.html
CHANGES.html
CONTRIBUTING.html
RELEASE_PROCEDURE.html
.errai
helloworld-gwt/src/main/gwt-unitCache
helloworld-gwt/src/main/webapp/HelloWorldApp
Expand Down
122 changes: 107 additions & 15 deletions README.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion RELEASE_PROCEDURE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Quickstarts Release Procedure
Testing the quickstarts
-----------------------

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:
Most of the quickstarts require starting Red Hat JBoss Enterprise Application Platform 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:

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

Expand Down
62 changes: 31 additions & 31 deletions app-client/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# app-client: Use the ${product.name} Application Client Container
# app-client: Use the JBoss EAP Application Client Container

Author: Wolf-Dieter Fink
Level: Intermediate
Technologies: EJB, EAR, AppClient
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.
Target Product: ${product.name}
Source: <${github.repo.url}>
Summary: The `app-client` quickstart demonstrates how to code and package a client app and use the JBoss EAP client container to start the client Main program.
Target Product: JBoss EAP
Source: <https://github.com/jbossas/eap-quickstarts/>


## What is it?

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.
The `app-client` quickstart demonstrates how to use the JBoss EAP client container to start the client `Main` program and provide Dependency Injections (DI) for client applications in Red Hat JBoss Enterprise Application Platform. It also shows you how to use Maven to package the application according to the JavaEE specification.


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

## System Requirements

The application this project produces is designed to be run on ${product.name.full} ${product.version} or later.
The application this project produces is designed to be run on Red Hat JBoss Enterprise Application Platform 7.1 or later.

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.
All you need to build this project is Java 8.0 (Java SDK 1.8) or later and Maven 3.2.5 or later. See [Configure Maven for JBoss EAP 7.1](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.


## Use of ${jboss.home.name}
## Use of EAP7_HOME

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).
In the following instructions, replace `EAP7_HOME` with the actual path to your JBoss EAP installation. The installation path is described in detail here: [Use of EAP7_HOME and JBOSS_HOME Variables](https://github.com/jboss-developer/jboss-developer-shared-resources/blob/master/guides/USE_OF_EAP7_HOME.md#use-of-eap_home-and-jboss_home-variables).


## Add the Application Users

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.
If the client and server are run on different hosts, you must add the following users to the JBoss EAP server side application. Be sure to use the names and passwords specified in the table as they are required to run this example.

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

For Linux:
${jboss.home.name}/bin/add-user.sh -u admin -p admin-123
${jboss.home.name}/bin/add-user.sh -a -u quickuser -p quick-123
EAP7_HOME/bin/add-user.sh -u admin -p admin-123
EAP7_HOME/bin/add-user.sh -a -u quickuser -p quick-123

For Windows:
${jboss.home.name}\bin\add-user.bat -u admin -p admin-123
${jboss.home.name}\bin\add-user.bat -a -u quickuser -p quick-123
EAP7_HOME\bin\add-user.bat -u admin -p admin-123
EAP7_HOME\bin\add-user.bat -a -u quickuser -p quick-123

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).


## Start the Server

1. Open a command prompt and navigate to the root of the ${product.name} directory.
1. Open a command prompt and navigate to the root of the JBoss EAP directory.
2. The following shows the command line to start the server:

For Linux: ${jboss.home.name}/bin/standalone.sh
For Windows: ${jboss.home.name}\bin\standalone.bat
For Linux: EAP7_HOME/bin/standalone.sh
For Windows: EAP7_HOME\bin\standalone.bat


## Build and Deploy the Quickstart

1. Make sure you have started the ${product.name} server as described above.
1. Make sure you have started the JBoss EAP server as described above.
2. Open a command prompt and navigate to the root directory of this quickstart.
3. Type this command to build the artifacts:

Expand All @@ -83,10 +83,10 @@ If you prefer, you can use the add-user utility interactively. For an example of
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.

1. Be sure the quickstart deployed successfully as described above.
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.
2. Navigate to the root directory of this quickstart and type the following command to run the application. Be sure to replace `EAP7_HOME` with the path to your JBoss EAP installation.

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

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

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

### Configure Machine_1 (Remote Server Machine)

1. Install ${product.name} on this machine.
2. Add the application users to the ${product.name} server on this machine as described above.
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.
1. Install JBoss EAP on this machine.
2. Add the application users to the JBoss EAP server on this machine as described above.
3. Start the JBoss EAP 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.

For Linux: ${jboss.home.name}/bin/standalone.sh -b MACHINE_1_IP_ADDRESS -bmanagement MACHINE_1_IP_ADDRESS
For Windows: ${jboss.home.name}\bin\standalone.bat -b MACHINE_1_IP_ADDRESS -bmanagement MACHINE_1_IP_ADDRESS
For Linux: EAP7_HOME/bin/standalone.sh -b MACHINE_1_IP_ADDRESS -bmanagement MACHINE_1_IP_ADDRESS
For Windows: EAP7_HOME\bin\standalone.bat -b MACHINE_1_IP_ADDRESS -bmanagement MACHINE_1_IP_ADDRESS


### Configure Machine_2 (Local Client Machine)

1. Install ${product.name} on this server. There is no need to add the application users to this server.
1. Install JBoss EAP on this server. There is no need to add the application users to this server.
2. Download the `app-client` quickstart to this machine.
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`.

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

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
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
For Linux: EAP7_HOME/bin/appclient.sh --ejb-client-properties=ejb-client.properties ear/target/app-client.ear#simpleClient.jar Hello from command line
For Windows: EAP7_HOME\bin\appclient.bat --ejb-client-properties=ejb-client.properties ear\target\app-client.ear#simpleClient.jar Hello from command line

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

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

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

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

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

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

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.
1. Make sure you have started the JBoss EAP server on the remote server machine, `Machine_1`, where the quickstart is deployed as described above.
2. Open a command prompt on the local client machine, `Machine_2`, and navigate to the root directory of this quickstart.
3. When you are finished testing, type this command to undeploy the archive from the remote server machine, `Machine_1`.

Expand Down
32 changes: 16 additions & 16 deletions batch-processing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ Author: Rafael Benevides
Level: Intermediate
Technologies: CDI, Batch 1.0, JSF
Summary: The `batch-processing` quickstart shows how to use chunk oriented batch jobs to import a file to a database.
Target Product: ${product.name}
Source: <${github.repo.url}>
Target Product: JBoss EAP
Source: <https://github.com/jbossas/eap-quickstarts/>


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

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.

_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!_
_Note: This quickstart uses the H2 database included with Red Hat JBoss Enterprise Application Platform 7.1. 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!_

_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}._
_Note: This quickstart uses a `*-ds.xml` datasource configuration file for convenience and ease of database configuration. These files are deprecated in JBoss EAP 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 Red Hat JBoss Enterprise Application Platform._

## System Requirements

The application this project produces is designed to be run on ${product.name.full} ${product.version} or later.
The application this project produces is designed to be run on Red Hat JBoss Enterprise Application Platform 7.1 or later.

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.
All you need to build this project is Java 8.0 (Java SDK 1.8) or later and Maven 3.2.5 or later. See [Configure Maven for JBoss EAP 7.1](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.


## Use of ${jboss.home.name}
## Use of EAP7_HOME

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).
In the following instructions, replace `EAP7_HOME` with the actual path to your JBoss EAP installation. The installation path is described in detail here: [Use of EAP7_HOME and JBOSS_HOME Variables](https://github.com/jboss-developer/jboss-developer-shared-resources/blob/master/guides/USE_OF_EAP7_HOME.md#use-of-eap_home-and-jboss_home-variables).



## Start the Server


1. Open a command line and navigate to the root of the ${product.name} directory.
1. Open a command line and navigate to the root of the JBoss EAP directory.
2. The following shows the command line to start the server with the default profile:

For Linux: ${jboss.home.name}/bin/standalone.sh
For Windows: ${jboss.home.name}\bin\standalone.bat
For Linux: EAP7_HOME/bin/standalone.sh
For Windows: EAP7_HOME\bin\standalone.bat


## Build and Deploy the Quickstart

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

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


## Access the Application

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

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

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

## Undeploy the Archive

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

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

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

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}).
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 JBoss EAP 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).


## Debug the Application
Expand Down
Loading

0 comments on commit 6583f6a

Please sign in to comment.