This repository has been archived by the owner on Nov 10, 2017. It is now read-only.
forked from richfaces4/showcase
-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.txt
170 lines (116 loc) · 6.47 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
========================================================================
RichFaces - Ajax enabled JSF 2.0 component library
RichFaces 4.0.0.Final SHOWCASE
http://richfaces.org
March 2011
This software is distributed under the terms of the
FSF Lesser Gnu Public License (see lgpl.txt)
========================================================================
RichFaces showcase is an application created to show RichFaces components
in action. It contains a set of small use-cases implemented using RichFaces
components.
The examples shown in the application were chosen from the most popular
questions at the user forum. You will find a lot of useful information on
how to implement RichFaces components and re-use the code to implement the
components in your own application.
This file explains how to build and execute the showcase application on
your own server.
BUILDING AND RUNNING THE APPLICATION
------------------------------------
1. Requirements
In order to build the Showcase application you will need:
- Maven 2.1.0 or later
- Servers: Apache Tomcat 6.0 or any JEE6 application server
(e.g. JBoss AS 6)
- JDK 1.6
Also optional Additional Software would make it easy for you to work
with the sources of the application:
- Eclipse IDE + JBoss Tools (to explore and run the application
in IDE). You're obviously free to use any other IDE you wish, but
JBoss Tools is recommended.
2. Build/Deploy
- Deploying on Tomcat
To build the project for Tomcat you need to navigate to the
/examples/richfaces-showcase and run:
mvn clean package
When you see the BUILD SUCCESSFUL message you can deploy the
application on the server. To deploy it on Tomcat, copy the .war
file from 'target' folder to TOMCAT_HOME/webapps folder. Then,
launch the startup.sh or startup.bat script from TOMCAT_HOME/bin/
directory to start the server.
- Deploying on JEE6 server (JBoss AS 6)
To build the project for a JEE6 server you need to navigate to the
/examples/richfaces-showcase and run
mvn clean package -Pjee6
When you see the BUILD SUCCESSFUL message you can deploy the
application on the server. To deploy it on the application server
copy the .war file from 'target' folder to the JBOSS_HOME/server/default/deploy
folder (or change "default/" to used profile folder). Then, launch
the run.sh or run.bat script from JBOSS_HOME/bin/ directory to start
the server.
After deploying the examples to your server open a browser and type
http://localhost:8080/richfaces-showcase to view the examples.
- Publishing to Google Application Engine (GAE)
We have completed a resource plugin which generates static resources
allowing us to create Google App Engine compatible applications
using RichFaces. This means deploying to and working with GAE is
a piece of cake. Here is how you can deploy your own RichFaces showcase
example:
* Update the GAE application name, and register it with google.
Do this by updating the /webapp-gae/WEB-INF/appengine-web.xml
following the GAE standard documentation.
* if using MyFaces: Configure the MyFaces encryption secret values
in the /webapp-gae/WEB-INF/web.xml. Replace the "-- Insert some secret here --"
with a base64 encoded password. This is important because
otherwise MyFaces will generate random keys, and this causes
issues in a cluster environment like GAE.
For more information on JSF encryption check:
MyFaces - http://wiki.apache.org/myfaces/Secure_Your_Applicatio
Mojarra - http://wikis.sun.com/display/GlassFish/JavaServerFacesRI#JavaServerFacesRI-HowcanIsecureviewstatewhenusingclientsidestatesaving%3F
* Build using: mvn clean package -Pgae
* Use GAE SDK and the appcfg script just as you would for any other
GAE application.
There are some additional changes that were made in order to make
richfaces-showcase GAE compatible:
* WebConfiguration class from com.sun.faces were patched removing
code which is not compatible with GAE
* web.xml with additional properties for GAE created and placed
at src\main\webapp-gae\WEB-INF\ (it replaces common one during
build with GAE profile)
* check pom.xml GAE profile section in order to check additional
dependencies for that configuration
SETTING UP ECLIPSE TO WORK WITH THE SHOWCASE
--------------------------------------------
In order to explore, run and deploy the Showcase using Eclipse IDE you can use
one of the following options:
- You could use JBoss Tools with m2eclipse plugin and just import
the examples as maven-based projects.
* Open Eclipse and go to File > Import
* Expand the project type named Maven and select Import Maven
Project
* Browse the directory in which you placed the examples, select
it and press OK.
* Press next on the import wizard to finish importing the
examples.
- Or if you are not using m2eclipse execute use Maven to convert the
project to an Eclipse project:
* Open a terminal inside the RichFaces examples directory
* execute mvn eclipse:ecllipse
* Open Eclipse and select File > Import
* Select Import as existing project into workspace after build
is complete.
* Follow the instructions on the import wizard.
You are now able to work with the Showcase within Eclipse.
MORE INFORMATION AND RESOURCES
------------------------------
For more information on RichFaces 4, please visit RichFaces
website at:
- http://richfaces.org
Or check the Wiki for more information on build instructions for the examples at:
- http://community.jboss.org/wiki/HowtoworkwithRichFaces4xexamplessources
To report or check the status of issues related to RichFaces Examples
use the project's Jira at:
- https://issues.jboss.org/browse/RF
Community support and help can be obtained from the RichFaces forums at:
- http://community.jboss.org/en/richfaces?view=discussions
###