-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
269 lines (236 loc) · 11.4 KB
/
index.html
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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
<!DOCTYPE html>
<html lang="en-us">
<head>
<meta charset="UTF-8">
<title>JoinFaces</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="shortcut icon" href="/favicon.ico" rel="icon" type="image/x-icon" />
<link rel="stylesheet" type="text/css" href="stylesheets/normalize.css" media="screen">
<link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" type="text/css" href="stylesheets/stylesheet.css" media="screen">
<link rel="stylesheet" type="text/css" href="stylesheets/github-light.css" media="screen">
</head>
<body>
<section class="page-header">
<h1 class="project-name">JoinFaces</h1>
<h2 class="project-tagline">JSF Spring Boot Starters</h2>
<a href="https://github.com/joinfaces/joinfaces" class="btn">Fork me on GitHub</a>
<a href="https://github.com/joinfaces/joinfaces/wiki" class="btn">Documentation</a>
<a href="https://github.com/joinfaces/joinfaces/issues" class="btn">Issues</a>
<a href="https://github.com/joinfaces/joinfaces/releases" class="btn">Releases</a>
<a href="https://twitter.com/joinfaces" class="btn">Twitter</a>
<a href="https://www.facebook.com/groups/joinfaces" class="btn">Facebook</a>
</section>
<section class="main-content">
<h2>
<a id="what-is-joinfaces" class="anchor" href="#what-is-joinfaces" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>What is JoinFaces?</h2>
<p>This project enables <a href="http://www.oracle.com/technetwork/java/javaee/javaserverfaces-139869.html">JSF</a> usage inside <a href="http://projects.spring.io/spring-boot/">Spring Boot</a> Application. </p>
<p>It autoconfigures <a href="http://primefaces.org/">PrimeFaces</a>, <a href="http://primefaces-extensions.github.io/">PrimeFaces Extensions</a>, <a href="https://adminfaces.github.io/site/">AdminFaces</a>, <a href="http://bootsfaces.net/">BootsFaces</a>, <a href="http://butterfaces.org/">ButterFaces</a>, <a href="http://www.icesoft.org/java/projects/ICEfaces/overview.jsf">IceFaces</a>, <a href="https://github.com/richfaces/richfaces">RichFaces</a>, <a href="https://github.com/stephanrauh/AngularFaces">AngularFaces</a>, <a href="http://omnifaces.org/">OmniFaces</a>, <a href="https://javaserverfaces.java.net/">Mojarra</a> and <a href="http://myfaces.apache.org/">MyFaces</a> libraries to run at embedded <a href="http://tomcat.apache.org/">Tomcat</a>, <a href="http://www.eclipse.org/jetty">Jetty</a> or <a href="http://undertow.io">Undertow</a> servlet containers. It autoconfigures <a href="http://weld.cdi-spec.org">Weld</a> and <a href="https://www.ocpsoft.org/rewrite/">Rewrite</a> too.</p>
<p>It also aims to solve <a href="http://www.oracle.com/technetwork/java/javaee/javaserverfaces-139869.html">JSF</a> and <a href="http://projects.spring.io/spring-boot/">Spring Boot</a> integration features. Current version includes <a href="http://www.oracle.com/technetwork/java/javaee/javaserverfaces-139869.html">JSF</a> and <a href="http://www.cdi-spec.org/">CDI</a> annotations support and <a href="http://projects.spring.io/spring-security/">Spring Security</a> JSF Facelet Tag support.</p>
<h2>
<a id="how-to-use" class="anchor" href="#how-to-use" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>How to use</h2>
<p><a href="https://github.com/joinfaces/joinfaces-maven-jar-example">JoinFaces Example</a> shows JoinFaces Starter usage. It may help you to choose the JoinFaces Starter that fits your needs.</p>
<p>You can find more examples <a href="https://github.com/joinfaces/joinfaces/wiki/Examples-of-JoinFaces-usage">here.</a></p>
<h2>
<a id="key-features" class="anchor" href="#key-features" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Key Features</h2>
<h3>
<a id="many-jsf-spring-boot-starters-available" class="anchor" href="#many-jsf-spring-boot-starters-available" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Many JoinFaces Starters available</h3>
<p>There are many JSF Spring Boot Starters available.</p>
<p>See detailed starters <a href="https://github.com/joinfaces/joinfaces/wiki/Joinfaces-Starters-3.x">here.</a></p>
<h3>
<a id="jsf-properties-configuration-via-applicationproperties-or-applicationyml" class="anchor" href="#jsf-properties-configuration-via-applicationproperties-or-applicationyml" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>JSF properties configuration via application.properties or application.yml</h3>
<table>
<thead>
<tr>
<th>Library</th>
<th>Namespace</th>
<th>Example</th>
</tr>
</thead>
<tbody>
<tr>
<td>standard (javax.faces)</td>
<td>jsf</td>
<td>jsf.PROJECT_STAGE: Development</td>
</tr>
<tr>
<td><a href="http://primefaces.org/">primefaces</a></td>
<td>jsf.primefaces</td>
<td>jsf.primefaces.theme: overcast</td>
</tr>
<tr>
<td><a href="http://bootsfaces.net/">bootsfaces</a></td>
<td>jsf.bootsfaces</td>
<td>jsf.bootsfaces.USETHEME: true</td>
</tr>
<tr>
<td><a href="http://butterfaces.org/">butterfaces</a></td>
<td>jsf.butterfaces</td>
<td>jsf.butterfaces.provideJQuery: true</td>
</tr>
<tr>
<td><a href="https://adminfaces.github.io/site/">adminfaces</a></td>
<td>jsf.adminfaces</td>
<td>jsf.adminfaces.skin: skin-blue</td>
</tr>
<tr>
<td><a href="http://icefaces.org/">icefaces</a></td>
<td>jsf.icefaces</td>
<td>jsf.icefaces.compressDOM: true</td>
</tr>
<tr>
<td><a href="http://richfaces.org/">richfaces</a></td>
<td>jsf.richfaces</td>
<td>jsf.richfaces.resourceDefaultTTL: 68400</td>
</tr>
<td><a href="https://github.com/stephanrauh/AngularFaces">angularfaces</a></td>
<td>jsf.angularfaces</td>
<td>jsf.angularfaces.addLabels: true</td>
</tr>
<tr>
<td><a href="http://omnifaces.org/">omnifaces</a></td>
<td>jsf.omnifaces</td>
<td>jsf.omnifaces.FACES_VIEWS_ENABLED: true</td>
</tr>
<tr>
<td><a href="https://javaserverfaces.java.net/">mojarra</a></td>
<td>jsf.mojarra</td>
<td>jsf.mojarra.preferXHTML: true</td>
</tr>
<tr>
<td><a href="http://myfaces.apache.org/">myfaces</a></td>
<td>jsf.myfaces</td>
<td>jsf.myfaces.PRETTY_HTML: true</td>
</tr>
<tr>
<td><a href="http://www.eclipse.org/jetty">jetty</a></td>
<td>jsf.jetty</td>
<td>jsf.jetty.classPathResource: META-INF/resources</td>
</tr>
<tr>
<td><a href="http://undertow.io">undertow</a></td>
<td>jsf.undertow</td>
<td>jsf.undertow.classPathResource: META-INF/resources</td>
</tr>
</tbody>
</table>
<p>Look full <a href="https://github.com/joinfaces/joinfaces/blob/master/joinfaces-autoconfigure/src/test/resources/application-propertyTest.yml">application.yml</a> example.</p>
<p>Additional information in <a href="https://github.com/joinfaces/joinfaces/issues/22">#22</a></p>
<h3>
<a id="jsf-and-cdi-annotations-support-automatically" class="anchor" href="#jsf-and-cdi-annotations-support-automatically" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>JSF and CDI annotations support automatically</h3>
<table>
<thead>
<tr>
<th>Annotation</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="http://docs.oracle.com/javaee/7/api/javax/faces/bean/NoneScoped.html">@NoneScoped</a></td>
</tr>
<tr>
<td><a href="http://docs.oracle.com/javaee/7/api/javax/enterprise/context/RequestScoped.html">@RequestScoped</a></td>
</tr>
<tr>
<td><a href="http://docs.oracle.com/javaee/7/api/javax/faces/view/ViewScoped.html">@ViewScoped</a></td>
</tr>
<tr>
<td><a href="http://docs.oracle.com/javaee/7/api/javax/enterprise/context/SessionScoped.html">@SessionScoped</a></td>
</tr>
<tr>
<td><a href="http://docs.oracle.com/javaee/7/api/javax/enterprise/context/ApplicationScoped.html">@ApplicationScoped</a></td>
</tr>
</tbody>
</table>
<h3>
<a id="spring-security-jsf-facelet-tag-support" class="anchor" href="#spring-security-jsf-facelet-tag-support" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Spring Security JSF Facelet Tag support</h3>
<p>Namespace: <strong><a href="http://www.springframework.org/security/tags">http://www.springframework.org/security/tags</a></strong></p>
<table>
<thead>
<tr>
<th>Tag</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>authorize</td>
<td>perform Spring Security authorization decisions, using attributes: ifAnyGranted, ifAllGranted, ifNotGranted, access, url, method, var.</td>
</tr>
<tr>
<td>anonymous</td>
<td>verify if the user is anonymous.</td>
</tr>
<tr>
<td>authenticated</td>
<td>verify if the user is not anonymous.</td>
</tr>
<tr>
<td>fullyAuthenticated</td>
<td>verify if the is not an anonymous or a remember-me user.</td>
</tr>
</tbody>
</table>
<table>
<thead>
<tr>
<th>Function</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>areAllGranted</td>
<td>returns true if the user has all of of the given authorities.</td>
</tr>
<tr>
<td>areAnyGranted</td>
<td>returns true if the user has any of the given authorities.</td>
</tr>
<tr>
<td>areNotGranted</td>
<td>returns true if the user does not have any of the given authorities.</td>
</tr>
<tr>
<td>isAllowed</td>
<td>returns true if the user is allowed to access the given URL and HTTP method combination.</td>
</tr>
<tr>
<td>isAnonymous</td>
<td>returns true if user is anonymous.</td>
</tr>
<tr>
<td>isAuthenticated</td>
<td>returns true if the user is not anonymous.</td>
</tr>
<tr>
<td>isFullyAuthenticated</td>
<td>returns true if the is not an anonymous or a remember-me user.</td>
</tr>
</tbody>
</table>
<p>Additional information in <a href="https://github.com/joinfaces/joinfaces/issues/29">#29</a></p>
<h2>
<a id="system-requirements" class="anchor" href="#system-requirements" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>System Requirements</h2>
<p>By default, JSF Spring Boot Starter requires <a href="http://java.com">Java 8</a> and <a href="http://projects.spring.io/spring-boot/">Spring Boot 2.x</a> and <a href="https://javaserverfaces.github.io/">JSF 2.x</a>.</p>
<h2>
<a id="getting-help" class="anchor" href="#getting-help" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Getting Help</h2>
<ul>
<li>Take a look at <a href="https://github.com/joinfaces/joinfaces/wiki">github.com/joinfaces/joinfaces/wiki</a>.</li>
<li>Report questions and bugs at <a href="https://github.com/joinfaces/joinfaces/issues">github.com/joinfaces/joinfaces/issues</a>.</li>
</ul>
<h2>
<a id="contributing" class="anchor" href="#contributing" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Contributing</h2>
<ul>
<li>Report documentation, features, enhancement and bugs at <a href="https://github.com/joinfaces/joinfaces/issues">github.com/joinfaces/joinfaces/issues</a>.</li>
<li>Pull requests are welcome.</li>
</ul>
<h2>
<a id="structure" class="anchor" href="#structure" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Structure</h2>
<p>This software is multi module <a href="http://maven.apache.org">Maven</a> project and follows <a href="http://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-developing-auto-configuration.html">Spring Boot Reference</a> to create JSF Auto Configuration. <a href="https://github.com/joinfaces/joinfaces/wiki/Structure-of-the-software">See what's inside each submodule.</a></p>
<footer class="site-footer">
<span class="site-footer-credits">This page was generated by <a href="https://pages.github.com">GitHub Pages.</a></span>
</footer>
</section>
</body>
</html>