Skip to content

Commit

Permalink
More readme cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
sgilda committed Apr 1, 2012
1 parent 8ddd885 commit 2222919
Show file tree
Hide file tree
Showing 43 changed files with 135 additions and 137 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,27 +170,27 @@ The JBoss server can be started a few different ways.
The README for each quickstart will specify which configuration is required to run the example.

<a id="startserverweb"></a>
#### Start JBoss Enterprise Application Platform 6 or JBoss Application Server 7 with the Web Profile
#### Start JBoss Enterprise Application Platform 6 or JBoss AS 7 with the Web Profile

1. Open a command line and navigate to the root of the JBoss directory.
1. Open a command line and navigate to the root of the JBoss server directory.
2. The following shows the command line to start the server with the web profile:

For Linux: JBOSS_HOME/bin/standalone.sh
For Windows: JBOSS_HOME\bin\standalone.bat

<a id="startserverfull"></a>
#### Start JBoss Enterprise Application Platform 6 or JBoss Application Server 7 with the Full Profile
#### Start JBoss Enterprise Application Platform 6 or JBoss AS 7 with the Full Profile

1. Open a command line and navigate to the root of the JBoss directory.
1. Open a command line and navigate to the root of the JBoss server directory.
2. The following shows the command line to start the server with the full profile:

For Linux: JBOSS_HOME/bin/standalone.sh -c standalone-full.xml
For Windows: JBOSS_HOME\bin\standalone.bat -c standalone-full.xml

<a id="startservercustom"></a>
#### Start JBoss Enterprise Application Platform 6 or JBoss Application Server 7 with Custom Configuration Options
#### Start JBoss Enterprise Application Platform 6 or JBoss AS 7 with Custom Configuration Options

1. Open a command line and navigate to the root of the JBoss directory.
1. Open a command line and navigate to the root of the JBoss server directory.
2. The following shows the command line to start the server. Replace the CUSTOM_OPTIONS with the custom optional parameters specified in the quickstart.

For Linux: JBOSS_HOME/bin/standalone.sh CUSTOM_OPTIONS
Expand Down Expand Up @@ -294,7 +294,7 @@ The quickstart README should tell you what you should expect to see in the conso
<a id="useeclipse"/>
Use JBoss Developer Studio or Eclipse to Run the Quickstarts
-------------------------------------
You can also deploy the quickstarts from Eclipse using JBoss tools. For more information on how to set up Maven and the JBoss tools, refer to the [Boss Enterprise Application Platform 6 Beta](http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Application_Platform/6/html/Beta_Documentation/HOME.html) documentation or the [Getting Started Developing Applications Guide](https://docs.jboss.org/author/display/AS71/Getting+Started+Developing+Applications+Guide "Getting Started Developing Applications Guide").
You can also deploy the quickstarts from Eclipse using JBoss tools. For more information on how to set up Maven and the JBoss tools, refer to the [JBoss Enterprise Application Platform 6 Beta](http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Application_Platform/6/html/Beta_Documentation/HOME.html) documentation or the [Getting Started Developing Applications Guide](https://docs.jboss.org/author/display/AS71/Getting+Started+Developing+Applications+Guide "Getting Started Developing Applications Guide").


<a id="optionalcomponents"></a>
Expand Down Expand Up @@ -332,13 +332,13 @@ The following procedures describe how to add a user with the appropriate permiss
b) Application User (application-users.properties)
(a):

At the prompt, press enter to take the default Management User
At the prompt, press enter to use the default Management User
4. You should see the following response:

Enter the details of the new user to add.
Realm (ManagementRealm) :

If the quickstart README specifies a realm, type it here. Otherwise, press enter to take the default `ManagementRealm`.
If the quickstart README specifies a realm, type it here. Otherwise, press enter to use the default `ManagementRealm`.
5. When prompted, enter the following

Username : admin
Expand Down Expand Up @@ -369,7 +369,7 @@ The following procedures describe how to add a user with the appropriate permiss
Enter the details of the new user to add.
Realm (ApplicationRealm) :

If the quickstart README specifies a realm, type it here. Otherwise, press enter to take the default `ApplicationRealm`.
If the quickstart README specifies a realm, type it here. Otherwise, press enter to use the default `ApplicationRealm`.
5. When prompted, enter the the Username and Passord. If the quickstart README specifies a Username nad Password, enter them here. Otherwise, use the default Username `quickstartUser` and Password `quickstartPassword`.

Username : quickstartUser
Expand Down
6 changes: 3 additions & 3 deletions bean-validation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ Configure Maven
If you have not yet done so, you must [Configure Maven](../README.html/#mavenconfiguration) before testing the quickstarts.


Start JBoss Enterprise Application Platform 6 or JBoss Application Server 7 with the Web Profile
Start JBoss Enterprise Application Platform 6 or JBoss AS 7 with the Web Profile
-------------------------

1. Open a command line and navigate to the root of the JBoss directory.
1. Open a command line and navigate to the root of the JBoss server directory.
2. The following shows the command line to start the server with the web profile:

For Linux: JBOSS_HOME/bin/standalone.sh
Expand Down Expand Up @@ -69,7 +69,7 @@ You can also check the server console output to verify that the Arquillian tests


Run the Quickstart in JBoss Developer Studio or Eclipse
Test the Quickstart in JBoss Developer Studio or Eclipse
-------------------------------------
You can also start the server and deploy the quickstarts from Eclipse using JBoss tools. For more information, see [Use JBoss Developer Studio or Eclipse to Run the Quickstarts](../README.html/#useeclipse)

Expand Down
4 changes: 2 additions & 2 deletions bmt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ Configure Maven
If you have not yet done so, you must [Configure Maven](../README.html/#mavenconfiguration) before testing the quickstarts.


Start JBoss Enterprise Application Platform 6 or JBoss Application Server 7 with the Web Profile
Start JBoss Enterprise Application Platform 6 or JBoss AS 7 with the Web Profile
-------------------------

1. Open a command line and navigate to the root of the JBoss directory.
1. Open a command line and navigate to the root of the JBoss server directory.
2. The following shows the command line to start the server with the web profile:

For Linux: JBOSS_HOME/bin/standalone.sh
Expand Down
6 changes: 3 additions & 3 deletions cdi-injection/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Author: Jason Porter
What is it?
-----------

This example demonstrates the use of *CDI 1.0 Injection and Qualifiers* in *JBoss AS 7* or *JBoss Enterprise Application Platform 6* with JSF as the front-end client.
This example demonstrates the use of *CDI 1.0 Injection and Qualifiers* in *JBoss Enterprise Application Platform 6* or *JBoss AS 7* with JSF as the front-end client.


System requirements
Expand All @@ -21,10 +21,10 @@ Configure Maven
If you have not yet done so, you must [Configure Maven](../README.html/#mavenconfiguration) before testing the quickstarts.


Start JBoss Enterprise Application Platform 6 or JBoss Application Server 7 with the Web Profile
Start JBoss Enterprise Application Platform 6 or JBoss AS 7 with the Web Profile
-------------------------

1. Open a command line and navigate to the root of the JBoss directory.
1. Open a command line and navigate to the root of the JBoss server directory.
2. The following shows the command line to start the server with the web profile:

For Linux: JBOSS_HOME/bin/standalone.sh
Expand Down
10 changes: 5 additions & 5 deletions cmt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ With CMT, the EJB container sets the boundaries of a transaction. This differs f

### What makes this an example of container managed transactions?

Take a look at <code>org.jboss.as.quickstarts.cmt.ejb.CustomerManagerEJBImpl</code>. You can see that this stateless session bean has been marked up with an @javax.ejb.TransactionAttribute annotation.
Take a look at <code>org.jboss.as.quickstarts.cmt.ejb.CustomerManagerEJBImpl</code>. You can see that this stateless session bean has been marked up with the @javax.ejb.TransactionAttribute annotation.

The available options for this annotation are as follows:

Expand All @@ -32,7 +32,7 @@ The available options for this annotation are as follows:
* Never - If the client has a transaction running and does not suspend it but calls a method annotated with Never then an EJB exception will be raised.


JBoss Enterprise Application Platform 6 and JBoss AS 7 ship with an H2 datasource by default. This example shows how to transactionally insert key value pairs into the H2 database and demonstrates the requirements on the developer with respect to the JPA Entity Manager.
JBoss Enterprise Application Platform 6 and JBoss AS 7 ship with H2, an in-memory database written in Java. This example shows how to transactionally insert key value pairs into the H2 database and demonstrates the requirements on the developer with respect to the JPA Entity Manager.


System requirements
Expand All @@ -49,10 +49,10 @@ Configure Maven
If you have not yet done so, you must [Configure Maven](../README.html/#mavenconfiguration) before testing the quickstarts.


Start JBoss Enterprise Application Platform 6 or JBoss Application Server 7 with the Full Profile
Start JBoss Enterprise Application Platform 6 or JBoss AS 7 with the Full Profile
---------------

1. Open a command line and navigate to the root of the JBoss directory.
1. Open a command line and navigate to the root of the JBoss server directory.
2. The following shows the command line to start the server with the full profile:

For Linux: JBOSS_HOME/bin/standalone.sh -c standalone-full.xml
Expand Down Expand Up @@ -91,7 +91,7 @@ The application will be running at the following URL: <http://localhost:8080/jb

You will be presented with a simple form for adding customers to a database.

After a user is successfully added to the database, a message is produced container the details of the user. An example MDB will dequeue this message and print the contents as such:
After a user is successfully added to the database, a message is produced containing the details of the user. An example MDB will dequeue this message and print the following contents:

Received Message: Created customer named: Tom with ID: 1

Expand Down
8 changes: 4 additions & 4 deletions ejb-in-ear/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,10 @@ Configure Maven
If you have not yet done so, you must [Configure Maven](../README.html/#mavenconfiguration) before testing the quickstarts.


Start JBoss Enterprise Application Platform 6 or JBoss Application Server 7 with the Web Profile
Start JBoss Enterprise Application Platform 6 or JBoss AS 7 with the Web Profile
-------------------------

1. Open a command line and navigate to the root of the JBoss directory.
1. Open a command line and navigate to the root of the JBoss server directory.
2. The following shows the command line to start the server with the web profile:

For Linux: JBOSS_HOME/bin/standalone.sh
Expand All @@ -62,7 +62,7 @@ _NOTE: The following build command assumes you have configured your Maven user s
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 jboss-as:deploy
mvn clean package jboss-as:deploy

4. This will deploy `target/jboss-as-ejb-in-ear.ear` to the running instance of the server.

Expand All @@ -72,7 +72,7 @@ _NOTE: The following build command assumes you have configured your Maven user s
2. Open a command line and navigate to the root directory of this quickstart.
3. Type this command to undeploy the archive:

mvn jboss-as:undeploy
mvn jboss-as:undeploy


Access the application
Expand Down
8 changes: 4 additions & 4 deletions ejb-in-war/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ The example follows the common "Hello World" pattern. These are the steps that o

1. A JSF page asks the user for their name.
2. On clicking submit, the name is sent to a managed bean namde `Greeter`.
3. On setting the name, the `Greeter` invokes the `GreeterEJB`, which was injected to the managed bean. Notice the field annotated with @EJB.
4. The response from invoking the `GreeterEJB` is stored in a field (message) of the managed bean.
3. On setting the name, the `Greeter` invokes the `GreeterEJB`, which was injected into the managed bean. Notice the field annotated with `@EJB`.
4. The response from invoking the `GreeterEJB` is stored in a field `message` of the managed bean.
5. The managed bean is annotated as `@SessionScoped`, so the same managed bean instance is used for the entire session. This ensures that the message is available when the page reloads and is displayed to the user.

System requirements
Expand All @@ -29,10 +29,10 @@ Configure Maven
If you have not yet done so, you must [Configure Maven](../README.html/#mavenconfiguration) before testing the quickstarts.


Start JBoss Enterprise Application Platform 6 or JBoss Application Server 7 with the Web Profile
Start JBoss Enterprise Application Platform 6 or JBoss AS 7 with the Web Profile
-------------------------

1. Open a command line and navigate to the root of the JBoss directory.
1. Open a command line and navigate to the root of the JBoss server directory.
2. The following shows the command line to start the server with the web profile:

For Linux: JBOSS_HOME/bin/standalone.sh
Expand Down
6 changes: 3 additions & 3 deletions ejb-remote/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ There are two components to this example:

1. A server side component:

The server component is comprised of a stateful and a stateless EJB. It provides both an EJB JAR that is deployed to the server and a JAR file containing the remote business interfaces required by the remote client application.
The server component is comprised of a stateful EJB and a stateless EJB. It provides both an EJB JAR that is deployed to the server and a JAR file containing the remote business interfaces required by the remote client application.
2. A remote client application that accesses the server component.

The remote client application depends on the remote business interfaces from the server component. This application looks up the stateless and stateful beans via JNDI and invokes a number of methods on them.
Expand All @@ -33,10 +33,10 @@ Configure Maven
If you have not yet done so, you must [Configure Maven](../README.html/#mavenconfiguration) before testing the quickstarts.


Start JBoss Enterprise Application Platform 6 or JBoss Application Server 7 with the Web Profile
Start JBoss Enterprise Application Platform 6 or JBoss AS 7 with the Web Profile
-------------------------

1. Open a command line and navigate to the root of the JBoss directory.
1. Open a command line and navigate to the root of the JBoss server directory.
2. The following shows the command line to start the server with the web profile:

For Linux: JBOSS_HOME/bin/standalone.sh
Expand Down
18 changes: 9 additions & 9 deletions ejb-security/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ Author: Sherif F. Makary
What is it?
-----------

This example demonstrates the use of JEE declarative security to control access to EJB 3 and Security in *JBoss Enterprise Application Platform 6* or *JBoss AS 7*.
This example demonstrates the use of Java EE declarative security to control access to EJB3 and Security in *JBoss Enterprise Application Platform 6* or *JBoss AS 7*.

The following are the steps required to implement EJB security:
This quickstart takes the following steps to implement EJB security:

1. Use the security domain `other` that is defined in the application server default `standalone.xml` configuration file.
2. Add the user `quickstartUser` with password `quickstartPassword`, belonging to the role `guest` and realm `ApplicationRealm`. The procedure for adding a user is described below.
3. A security domain reference for the `other` security domain is added to `WEB-INF/jboss-web.xml`.
4. A security constraint is added to `WEB-INF/web.xml` .
5. Security annotations are added to the EJB declaration.
1. Define a security domain in the `standalone.xml` configuration file.
2. Add an application user with access rights to the application.
3. Add a security domain reference to `WEB-INF/jboss-web.xml`.
4. Add a security constraint to the `WEB-INF/web.xml` .
5. Add a security annotation to the EJB declaration.

When you review the code, note the allowed user role `guest` in the annotation -`@RolesAllowed`- is the same as the user role defined in step 2 above.

Expand All @@ -38,10 +38,10 @@ Add an Application User
This quickstart uses a secured management interface and requires that you create an application user to access the running application. Instructions to set up an Application user can be found here: [Add an Application User](../README.html/#addapplicationuser)


Start JBoss Enterprise Application Platform 6 or JBoss Application Server 7 with the Web Profile
Start JBoss Enterprise Application Platform 6 or JBoss AS 7 with the Web Profile
-------------------------

1. Open a command line and navigate to the root of the JBoss directory.
1. Open a command line and navigate to the root of the JBoss server directory.
2. The following shows the command line to start the server with the web profile:

For Linux: JBOSS_HOME/bin/standalone.sh
Expand Down
4 changes: 2 additions & 2 deletions forge-from-scratch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,10 @@ After this command completes, look in your QUICKSTART_HOME/forge-from-scratch/ f
For a full description of what was generated by running this script and details on the structure of the application, visit the [Forge UI Scaffolding Guide](https://docs.jboss.org/author/display/FORGE/UI+Scaffolding)


Start JBoss Enterprise Application Platform 6 or JBoss Application Server 7 with the Web Profile
Start JBoss Enterprise Application Platform 6 or JBoss AS 7 with the Web Profile
-------------------------

1. Open a command line and navigate to the root of the JBoss directory.
1. Open a command line and navigate to the root of the JBoss server directory.
2. The following shows the command line to start the server with the web profile:

For Linux: JBOSS_HOME/bin/standalone.sh
Expand Down
4 changes: 2 additions & 2 deletions greeter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ Configure Maven
If you have not yet done so, you must [Configure Maven](../README.html/#mavenconfiguration) before testing the quickstarts.


Start JBoss Enterprise Application Platform 6 or JBoss Application Server 7 with the Web Profile
Start JBoss Enterprise Application Platform 6 or JBoss AS 7 with the Web Profile
-------------------------

1. Open a command line and navigate to the root of the JBoss directory.
1. Open a command line and navigate to the root of the JBoss server directory.
2. The following shows the command line to start the server with the web profile:

For Linux: JBOSS_HOME/bin/standalone.sh
Expand Down
6 changes: 0 additions & 6 deletions h2-console/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,6 @@ Configure Maven
If you have not yet done so, you must [Configure Maven](../README.html/#mavenconfiguration) before testing the quickstarts.


Additional requirements
-----------------------

You will need the H2 Console to run test this quickstart. You can download it from <http://www.h2database.com/html/download.html>. We recommend using the platform independent zip.


Prerequisites
-----------

Expand Down
4 changes: 2 additions & 2 deletions helloworld-errai/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ Configure Maven
If you have not yet done so, you must [Configure Maven](../README.html/#mavenconfiguration) before testing the quickstarts.


Start JBoss Enterprise Application Platform 6 or JBoss Application Server 7 with the Web Profile
Start JBoss Enterprise Application Platform 6 or JBoss AS 7 with the Web Profile
-------------------------

1. Open a command line and navigate to the root of the JBoss directory.
1. Open a command line and navigate to the root of the JBoss server directory.
2. The following shows the command line to start the server with the web profile:

For Linux: JBOSS_HOME/bin/standalone.sh
Expand Down
Loading

0 comments on commit 2222919

Please sign in to comment.