Skip to content
This repository has been archived by the owner on Nov 17, 2017. It is now read-only.

RF-13220: Remove dual-branding and references to AS 7. Also clean up errors reported by QS tools #8

Merged
merged 1 commit into from
Jan 7, 2014
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
74 changes: 72 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,73 @@
richfaces-quickstarts:
======================
Red Hat JBoss Enterprise Application Platform (EAP) RichFaces Quickstarts
====================
Target Product: WFK
Product Versions: EAP 6.1, EAP 6.2, WFK 2.4

Summary: The quickstarts demonstrate Java EE 6, RichFaces 4.1, and a few additional technologies from the JBoss stack. They provide small, specific, working examples that can be used as a reference for your own project.

Introduction
------------

These quickstarts run on Red Hat JBoss Enterprise Application Platform 6.1 and WFK 2.4 or later. We recommend using the JBoss EAP ZIP file. This version uses the correct dependencies and ensures you test and compile against your runtime environment.

Available Quickstarts
---------------------

The list of all currently available quickstarts can be found here: <http://site-jdf.rhcloud.com/quickstarts/get-started/>. The table lists each quickstart name, the technologies it demonstrates, gives a brief description of the quickstart, and the level of experience required to set it up. For more detailed information about a quickstart, click on the quickstart name.

System Requirements
-------------------

The applications these projects produce are designed to be run on Red Hat JBoss Enterprise Application Platform 6.1 or later.

To run these quickstarts with the provided build scripts, you need the following:

1. Java 1.6, to run JBoss AS and Maven. You can choose from the following:
* OpenJDK
* Oracle Java SE
* Oracle JRockit

2. Maven 3.0.0 or newer, to build and deploy the examples
* If you have not yet installed Maven, see the [Maven Getting Started Guide](http://maven.apache.org/guides/getting-started/index.html) for details.
* If you have installed Maven, you can check the version by typing the following in a command prompt:

mvn --version

3. The JBoss EAP distribution ZIP.
* For information on how to install and run JBoss, refer to the product documentation.

4. You can also use [JBoss Developer Studio or Eclipse](#use-jboss-developer-studio-or-eclipse-to-run-the-quickstarts) to run the quickstarts.



Configure Maven
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section on configuring maven and the associated profiles is unnecessary for the RichFaces quickstarts, as they are designed to be built from maven central.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added that section because each of the individual quickstart README files has a link to a Configure Maven in the parent README and there wasn't one. So the README files had broken links. See: https://github.com/richfaces/jdf-quickstarts/blob/master/helloworld-rf/README.md#configure-maven

Won't they need those instructions when the quickstart is merged in with the WFK quickstarts?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The instructions will be required for the WFK qucikstarts. Is the script that @rafabene runs able to add them?

---------------

The quickstarts in the RichFaces project are designed to use artifacts in Maven Central. There is no need to configure Maven before you build and deploy the quickstarts.


Run the Quickstarts
-------------------

The root folder of each individual quickstart contains a README file with specific details on how to build and run the example. In most cases you do the following:

* [Start the JBoss server](#start-the-jboss-server)
* [Build and deploy the quickstarts](#build-and-deploy-the-quickstarts)


### Start the JBoss Server

Before you deploy a quickstart, in most cases you need a running JBoss EAP server. To start the JBoss EAP server with the default profile:

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

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


### Build and Deploy the Quickstarts

See the README file in each individual quickstart folder for specific details and information on how to run and access the example.


19 changes: 10 additions & 9 deletions helloworld-rf/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
helloworld-rf: Helloworld with a JSF (JavaServer Faces) Front End
==================================================================
Author: Brian Leathem
Level: Beginner
Technologies: CDI, JSF, RichFaces
Summary: Similar to the helloworld quickstart, but with a JSF and RichFaces front end
Target Product: WFK
Source: <https://github.com/richfaces/as-quickstarts>
Author: Brian Leathem
Level: Beginner
Technologies: CDI, JSF, RichFaces
Summary: Similar to the helloworld quickstart, but with a JSF and RichFaces front end
Target Product: WFK
Product Versions: EAP 6.1, EAP 6.2, WFK 2.4
Source: <https://github.com/richfaces/jdf-quickstarts>

What is it?
-----------
Expand All @@ -20,7 +21,7 @@ System requirements

All you need to build this project is Java 6.0 (Java SDK 1.6) or better, Maven 3.0 or better.

The application this project produces is designed to be run on JBoss Enterprise Application Platform 6 or JBoss AS 7.
The application this project produces is designed to be run on Red Hat JBoss Enterprise Application Platform (EAP) 6.1 or later.


Configure Maven
Expand All @@ -29,11 +30,11 @@ Configure Maven
If you have not yet done so, you must [Configure Maven](../README.md#configure-maven) before testing the quickstarts.


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

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:
2. The following shows the command line to start the server with the default profile:

For Linux: JBOSS_HOME/bin/standalone.sh
For Windows: JBOSS_HOME\bin\standalone.bat
Expand Down
9 changes: 4 additions & 5 deletions helloworld-rf/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,7 @@
a collection) of artifacts. We use this here so that we always get the correct
versions of artifacts. Here we use the jboss-javaee-6.0 stack (you can
read this as the JBoss stack of the Java EE 6 APIs). You can actually
use this stack with any version of JBoss AS that implements Java EE 6, not
just JBoss AS 7! -->
use this stack with any version of JBoss EAP that implements Java EE 6. -->
<dependency>
<groupId>org.jboss.spec</groupId>
<artifactId>jboss-javaee-6.0</artifactId>
Expand All @@ -89,22 +88,22 @@

<dependencies>

<!-- Import the CDI API, we use provided scope as the API is included in JBoss AS 7 -->
<!-- Import the CDI API, we use provided scope as the API is included in JBoss EAP -->
<dependency>
<groupId>javax.enterprise</groupId>
<artifactId>cdi-api</artifactId>
<scope>provided</scope>
</dependency>

<!-- Import the Common Annotations API (JSR-250), we use provided scope
as the API is included in JBoss AS 7 -->
as the API is included in JBoss EAP -->
<dependency>
<groupId>org.jboss.spec.javax.annotation</groupId>
<artifactId>jboss-annotations-api_1.1_spec</artifactId>
<scope>provided</scope>
</dependency>

<!-- Import the JSF API, we use provided scope as the API is included in JBoss AS 7 -->
<!-- Import the JSF API, we use provided scope as the API is included in JBoss EAP -->
<dependency>
<groupId>org.jboss.spec.javax.faces</groupId>
<artifactId>jboss-jsf-api_2.1_spec</artifactId>
Expand Down
6 changes: 3 additions & 3 deletions kitchensink-rf/.cheatsheet.xml
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@
directory of the example) —<b>persistence.xml</b>,
which sets up JPA, and
<b>import.sql</b>
which Hibernate, the JPA provider in JBoss AS 7,
which Hibernate, the JPA provider in JBoss EAP,
will use to load the initial users into the application when the application starts.
We discussed both of these files in detail in The<b>greeter example in depth</b>, and these are largely the
same.
Expand Down Expand Up @@ -687,7 +687,7 @@
serialization="org.jboss.tools.project.examples.cheatsheet.openFileInEditor(path=/${currentProject}/src/main/java/org/jboss/as/quickstarts/kitchensinkrf/rest/MemberResourceRESTService.java,fromLine=65)"/>
</subitem>
<subitem
label="The listAllMembers() method is called when the raw endpoint is accessed and offers up a list of endpoints. Notice that the object is automatically marshalled to JSON by RESTEasy (the JAX-RS implementation included in JBoss Enterprise Application Platform 6 and JBoss AS 7)."
label="The listAllMembers() method is called when the raw endpoint is accessed and offers up a list of endpoints. Notice that the object is automatically marshalled to JSON by RESTEasy (the JAX-RS implementation included in JBoss Enterprise Application Platform 6)."
skip="true">
<command
required="false"
Expand Down Expand Up @@ -760,7 +760,7 @@
<br/>
<br/>
Arquillian provides all the boiler plate for running your test inside JBoss Enterprise Application Platform
6 or JBoss AS 7,
6,
allowing you to concentrate on testing your application.
In order to do that, it utilizes Shrinkwrap, a fluent API for defining packaging,
to create an archive to deploy.
Expand Down
23 changes: 11 additions & 12 deletions kitchensink-rf/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
kitchensink-rf: Example Using Multiple Java EE 6 Technologies with RichFaces
========================
Author: Pete Muir, Brian Leathem
Level: Intermediate
Technologies: CDI, JSF, JPA, EJB, JPA, JAX-RS, BV, RichFaces
Summary: The canonical JSF kitchensink quickstart implemented with JSF and RichFaces
Target Product: WFK
Source: <https://github.com/richfaces/as-quickstarts>
Author: Pete Muir, Brian Leathem
Level: Intermediate
Technologies: CDI, JSF, JPA, EJB, JPA, JAX-RS, BV, RichFaces
Summary: The canonical JSF kitchensink quickstart implemented with JSF and RichFaces
Target Product: WFK
Product Versions: EAP 6.1, EAP 6.2, WFK 2.4
Source: <https://github.com/richfaces/jdf-quickstarts>

What is it?
-----------

This is your project! It is a sample, deployable Maven 3 project to help you get your foot in the door developing with Java EE 6 on JBoss Enterprise Application Platform 6 or JBoss AS 7.
This is your project! It is a sample, deployable Maven 3 project to help you get your foot in the door developing with Java EE 6 on JBoss Enterprise Application Platform (EAP) 6.1 or later.

This project is setup to allow you to create a compliant Java EE 6 application using JSF 2.0 with RichFaces 4, CDI 1.0, EJB 3.1, JPA 2.0 and Bean Validation 1.0. It includes a persistence unit and some sample persistence and transaction code to introduce you to database access in enterprise Java.

Expand All @@ -35,7 +36,7 @@ System requirements

All you need to build this project is Java 6.0 (Java SDK 1.6) or better, Maven 3.0 or better, and the RichFaces library.

The application this project produces is designed to be run on JBoss Enterprise Application Platform 6 or JBoss AS 7.
The application this project produces is designed to be run on Red Hat JBoss Enterprise Application Platform (EAP) 6.1 or later.


Configure Maven
Expand All @@ -44,11 +45,11 @@ Configure Maven
If you have not yet done so, you must [Configure Maven](../README.md#configure-maven) before testing the quickstarts.


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

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:
2. The following shows the command line to start the server with the default profile:

For Linux: JBOSS_HOME/bin/standalone.sh
For Windows: JBOSS_HOME\bin\standalone.bat
Expand All @@ -57,8 +58,6 @@ Start JBoss Enterprise Application Platform 6 or JBoss AS 7 with the Web Profile
Build and Deploy the Quickstart
-------------------------

_NOTE: The following build command assumes you have configured your Maven user settings. If you have not, you must include Maven setting arguments on the command line. See [Build and Deploy the Quickstarts](../README.md#build-and-deploy-the-quickstarts) for complete instructions and additional options._

1. Make sure you have started the JBoss 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:
Expand Down
21 changes: 10 additions & 11 deletions kitchensink-rf/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,7 @@
<!-- Define the version of the JBoss BOMs we want to import to specify tested stacks. -->
<version.jboss.bom.eap>1.0.7.Final</version.jboss.bom.eap>
<version.jboss.bom.wfk>1.0.7.Final</version.jboss.bom.wfk>



<version.richfaces>4.3.4.Final</version.richfaces>

<!-- other plugin versions -->
Expand Down Expand Up @@ -102,38 +101,38 @@
<dependencies>

<!-- First declare the APIs we depend on and need for compilation.
All of them are provided by JBoss AS 7 -->
All of them are provided by JBoss EAP -->

<!-- Import the CDI API, we use provided scope as the API is included in JBoss AS 7 -->
<!-- Import the CDI API, we use provided scope as the API is included in JBoss EAP -->
<dependency>
<groupId>javax.enterprise</groupId>
<artifactId>cdi-api</artifactId>
<scope>provided</scope>
</dependency>

<!-- Import the Common Annotations API (JSR-250), we use provided
scope as the API is included in JBoss AS 7 -->
scope as the API is included in JBoss EAP -->
<dependency>
<groupId>org.jboss.spec.javax.annotation</groupId>
<artifactId>jboss-annotations-api_1.1_spec</artifactId>
<scope>provided</scope>
</dependency>

<!-- Import the JAX-RS API, we use provided scope as the API is included in JBoss AS 7 -->
<!-- Import the JAX-RS API, we use provided scope as the API is included in JBoss EAP -->
<dependency>
<groupId>org.jboss.spec.javax.ws.rs</groupId>
<artifactId>jboss-jaxrs-api_1.1_spec</artifactId>
<scope>provided</scope>
</dependency>

<!-- Import the JPA API, we use provided scope as the API is included in JBoss AS 7 -->
<!-- Import the JPA API, we use provided scope as the API is included in JBoss EAP -->
<dependency>
<groupId>org.hibernate.javax.persistence</groupId>
<artifactId>hibernate-jpa-2.0-api</artifactId>
<scope>provided</scope>
</dependency>

<!-- Import the EJB API, we use provided scope as the API is included in JBoss AS 7 -->
<!-- Import the EJB API, we use provided scope as the API is included in JBoss EAP -->
<dependency>
<groupId>org.jboss.spec.javax.ejb</groupId>
<artifactId>jboss-ejb-api_3.1_spec</artifactId>
Expand All @@ -142,7 +141,7 @@

<!-- JSR-303 (Bean Validation) Implementation -->
<!-- Provides portable constraints such as @Email -->
<!-- Hibernate Validator is shipped in JBoss AS 7 -->
<!-- Hibernate Validator is shipped in JBoss EAP -->
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
Expand All @@ -155,14 +154,14 @@
</exclusions>
</dependency>

<!-- Import the JSF API, we use provided scope as the API is included in JBoss AS 7 -->
<!-- Import the JSF API, we use provided scope as the API is included in JBoss EAP -->
<dependency>
<groupId>org.jboss.spec.javax.faces</groupId>
<artifactId>jboss-jsf-api_2.1_spec</artifactId>
<scope>provided</scope>
</dependency>

<!-- Import the Servlet API, we use provided scope as the API is included in JBoss AS 7 -->
<!-- Import the Servlet API, we use provided scope as the API is included in JBoss EAP -->
<dependency>
<groupId>org.jboss.spec.javax.servlet</groupId>
<artifactId>jboss-servlet-api_3.0_spec</artifactId>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
<h:body>
<div id="container">
<div class="dualbrand">
<h:graphicImage name="dualbrand_logo.png" library="gfx"/>
<h:graphicImage name="rhjb_eap_logo.png" library="gfx"/>
</div>
<div id="content">
<ui:insert name="content">
Expand Down
3 changes: 0 additions & 3 deletions kitchensink-rf/src/main/webapp/index.xhtml
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,6 @@

<div>
<p>You have successfully deployed a RichFaces web application.</p>

<h3>Your application can run on:</h3>
<h:graphicImage library="gfx" name="dualbrand_as7eap.png"/>
</div>

<h:form id="reg">
Expand Down
9 changes: 4 additions & 5 deletions kitchensink-rf/src/main/webapp/mobile/home.xhtml
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,11 @@
<h:panelGroup id="homePanel" layout="block">
<rich:panelMenu activeItem="#{demoNavigator.currentDemo.id}">
<div class="mobileContent">
<h1>Welcome to JBoss AS 7!</h1>
<h1>Welcome to Red Hat JBoss Enterprise Application Platform!</h1>

<p>
You have successfully deployed a RichFaces web application on JBoss AS 7, and are viewing it via
your mobile
device.
You have successfully deployed a RichFaces web application on JBoss EAP, and are viewing it via
your mobile device.
</p>

<p>
Expand All @@ -50,4 +49,4 @@
</h:panelGroup>
</ui:composition>

</html>
</html>
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 2 additions & 8 deletions kitchensink-rf/src/main/webapp/resources/includes/about.xhtml
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,9 @@
<ui:composition>
<p>Learn more about JBoss Enterprise Application Platform 6.</p>
<ul>
<li><a href="https://access.redhat.com/knowledge/docs/JBoss_Enterprise_Application_Platform/">Documentation</a></li>
<li><a href="https://access.redhat.com/site/documentation/JBoss_Enterprise_Application_Platform/">Documentation</a></li>
<li><a href="http://red.ht/jbeap-6">Product Information</a></li>
</ul>
<p>Learn more about JBoss AS 7.</p>
<ul>
<li><a href="http://www.jboss.org/jdf/quickstarts/jboss-as-quickstart/guide/Introduction">Getting
Started Developing Applications Guide</a></li>
<li><a href="http://jboss.org/jbossas">Community Project Information</a></li>
</ul>
<p>Explore JavaServer Faces (JSF), and RichFaces - the component set built on top of JSF 2.</p>
<ul>
<li><a href="http://www.richfaces.org">RichFaces project</a></li>
Expand All @@ -43,4 +37,4 @@
</ul>
</ui:composition>

</html>
</html>