-
Notifications
You must be signed in to change notification settings - Fork 0
/
params.json
6 lines (6 loc) · 13.4 KB
/
params.json
1
2
3
4
5
6
{
"name": "JoinFaces",
"tagline": "JSF Spring Boot Starters",
"body": "### What is JoinFaces?\r\n\r\nThis project enables [JSF](http://www.oracle.com/technetwork/java/javaee/javaserverfaces-139869.html) usage inside JAR packaged [Spring Boot](http://projects.spring.io/spring-boot/) Application. \r\n\r\nIt autoconfigures [PrimeFaces](http://primefaces.org/), [PrimeFaces Extensions](http://primefaces-extensions.github.io/), [BootsFaces](http://bootsfaces.net/), [ButterFaces](http://butterfaces.org/), [OmniFaces](http://omnifaces.org/), [AngularFaces](http://angularfaces.net/), [Mojarra](https://javaserverfaces.java.net/) and [MyFaces](http://myfaces.apache.org/) libraries to run at embedded [Tomcat](http://tomcat.apache.org/), [Jetty](http://www.eclipse.org/jetty) or [Undertow](http://undertow.io) servlet containers.\r\n\r\nIt also aims to solve [JSF](http://www.oracle.com/technetwork/java/javaee/javaserverfaces-139869.html) and [Spring Boot](http://projects.spring.io/spring-boot/) integration features. Current version includes [JSF](http://www.oracle.com/technetwork/java/javaee/javaserverfaces-139869.html) and [CDI](http://www.cdi-spec.org/) annotations support and [Spring Security](http://projects.spring.io/spring-security/) JSF Facelet Tag support.\r\n\r\n\r\n\r\n## How to use\r\n\r\n[JoinFaces Example](https://github.com/joinfaces/joinfaces-example) shows JSF Spring Boot Starter usage. It may help you to choose the JSF Spring Boot Starter that fits your needs.\r\n\r\nYou can find more examples [here.](https://github.com/joinfaces/joinfaces/wiki/Some-examples-of-JSF-Spring-Boot-Starter-usage)\r\n\r\n## Key Features\r\n\r\n### Eighteen JSF Spring Boot Starters available\r\n\r\nStarter | Servlet Container | JSF Implementation | JSF Libraries\r\n------------ | ------------- | ------------- | -------------\r\njsf-spring-boot-starter | [Tomcat](http://tomcat.apache.org/) | [Mojarra](https://javaserverfaces.java.net/) | [PrimeFaces 6.0](http://primefaces.org), [PrimeFaces Extensions 6.0.0](http://primefaces-extensions.github.io/)\r\njsf-bootsfaces-spring-boot-starter | [Tomcat](http://tomcat.apache.org/) | [Mojarra](https://javaserverfaces.java.net/) | [BootsFaces 0.9.1](http://bootsfaces.net), [AngularFaces 2.1.3](http://angularfaces.net), [PrimeFaces 6.0](http://primefaces.org), [PrimeFaces Extensions 6.0.0](http://primefaces-extensions.github.io/)\r\njsf-butterfaces-spring-boot-starter | [Tomcat](http://tomcat.apache.org/) | [Mojarra](https://javaserverfaces.java.net/) | [ButterFaces 2.1.9](http://butterfaces.org), [BootsFaces 0.9.1](http://bootsfaces.net), [PrimeFaces 6.0](http://primefaces.org), [PrimeFaces Extensions 6.0.0](http://primefaces-extensions.github.io/)\r\njsf-myfaces-spring-boot-starter | [Tomcat](http://tomcat.apache.org/) | [MyFaces](http://myfaces.apache.org/) | [PrimeFaces 6.0](http://primefaces.org), [PrimeFaces Extensions 6.0.0](http://primefaces-extensions.github.io/)\r\njsf-myfaces-bootsfaces-spring-boot-starter | [Tomcat](http://tomcat.apache.org/) | [MyFaces](http://myfaces.apache.org/) | [BootsFaces 0.9.1](http://bootsfaces.net), [AngularFaces 2.1.3](http://angularfaces.net), [PrimeFaces 6.0](http://primefaces.org), [PrimeFaces Extensions 6.0.0](http://primefaces-extensions.github.io/)\r\njsf-myfaces-butterfaces-spring-boot-starter | [Tomcat](http://tomcat.apache.org/) | [MyFaces](http://myfaces.apache.org/) | [ButterFaces 2.1.9](http://butterfaces.org), [BootsFaces 0.9.1](http://bootsfaces.net), [PrimeFaces 6.0](http://primefaces.org), [PrimeFaces Extensions 6.0.0](http://primefaces-extensions.github.io/)\r\njsf-jetty-spring-boot-starter | [Jetty](http://www.eclipse.org/jetty) | [Mojarra](https://javaserverfaces.java.net/) | [PrimeFaces 6.0](http://primefaces.org), [PrimeFaces Extensions 6.0.0](http://primefaces-extensions.github.io/)\r\njsf-jetty-bootsfaces-spring-boot-starter | [Jetty](http://www.eclipse.org/jetty) | [Mojarra](https://javaserverfaces.java.net/) | [BootsFaces 0.9.1](http://bootsfaces.net), [AngularFaces 2.1.3](http://angularfaces.net), [PrimeFaces 6.0](http://primefaces.org), [PrimeFaces Extensions 6.0.0](http://primefaces-extensions.github.io/)\r\njsf-jetty-butterfaces-spring-boot-starter | [Jetty](http://www.eclipse.org/jetty) | [Mojarra](https://javaserverfaces.java.net/) | [ButterFaces 2.1.9](http://butterfaces.org), [BootsFaces 0.9.1](http://bootsfaces.net), [PrimeFaces 6.0](http://primefaces.org), [PrimeFaces Extensions 6.0.0](http://primefaces-extensions.github.io/)\r\njsf-jetty-myfaces-spring-boot-starter | [Jetty](http://www.eclipse.org/jetty) | [MyFaces](http://myfaces.apache.org/) | [PrimeFaces 6.0](http://primefaces.org), [PrimeFaces Extensions 6.0.0](http://primefaces-extensions.github.io/)\r\njsf-jetty-myfaces-bootsfaces-spring-boot-starter | [Jetty](http://www.eclipse.org/jetty) | [MyFaces](http://myfaces.apache.org/) | [BootsFaces 0.9.1](http://bootsfaces.net), [AngularFaces 2.1.3](http://angularfaces.net), [PrimeFaces 6.0](http://primefaces.org), [PrimeFaces Extensions 6.0.0](http://primefaces-extensions.github.io/)\r\njsf-jetty-myfaces-butterfaces-spring-boot-starter | [Jetty](http://www.eclipse.org/jetty) | [MyFaces](http://myfaces.apache.org/) | [ButterFaces 2.1.9](http://butterfaces.org), [BootsFaces 0.9.1](http://bootsfaces.net), [PrimeFaces 6.0](http://primefaces.org), [PrimeFaces Extensions 6.0.0](http://primefaces-extensions.github.io/)\r\njsf-undertow-spring-boot-starter | [Undertow](http://undertow.io) | [Mojarra](https://javaserverfaces.java.net/) | [PrimeFaces 6.0](http://primefaces.org), [PrimeFaces Extensions 6.0.0](http://primefaces-extensions.github.io/)\r\njsf-undertow-bootsfaces-spring-boot-starter | [Undertow](http://undertow.io) | [Mojarra](https://javaserverfaces.java.net/) | [BootsFaces 0.9.1](http://bootsfaces.net), [AngularFaces 2.1.3](http://angularfaces.net), [PrimeFaces 6.0](http://primefaces.org), [PrimeFaces Extensions 6.0.0](http://primefaces-extensions.github.io/)\r\njsf-undertow-butterfaces-spring-boot-starter | [Undertow](http://undertow.io) | [Mojarra](https://javaserverfaces.java.net/) | [ButterFaces 2.1.9](http://butterfaces.org), [BootsFaces 0.9.1](http://bootsfaces.net), [PrimeFaces 6.0](http://primefaces.org), [PrimeFaces Extensions 6.0.0](http://primefaces-extensions.github.io/)\r\njsf-undertow-myfaces-spring-boot-starter | [Undertow](http://undertow.io) | [MyFaces](http://myfaces.apache.org/) | [PrimeFaces 6.0](http://primefaces.org), [PrimeFaces Extensions 6.0.0](http://primefaces-extensions.github.io/)\r\njsf-undertow-myfaces-bootsfaces-spring-boot-starter | [Undertow](http://undertow.io) | [MyFaces](http://myfaces.apache.org/) | [BootsFaces 0.9.1](http://bootsfaces.net), [AngularFaces 2.1.3](http://angularfaces.net), [PrimeFaces 6.0] (http://primefaces.org), [PrimeFaces Extensions 6.0.0](http://primefaces-extensions.github.io/)\r\njsf-undertow-myfaces-bootsfaces-spring-boot-starter | [Undertow](http://undertow.io) | [MyFaces](http://myfaces.apache.org/) | [ButterFaces 2.1.9](http://butterfaces.org), [BootsFaces 0.9.1](http://bootsfaces.net), [PrimeFaces 6.0] (http://primefaces.org), [PrimeFaces Extensions 6.0.0](http://primefaces-extensions.github.io/)\r\n\r\nNote that all starters include the following libraries\r\n\r\nLibrary | Dependency | Description\r\n------------ | ------------- | -------------\r\n[primefaces-all-themes](http://primefaces.org/) | [1.0.8](http://search.maven.org/#artifactdetails\\|org.primefaces.extensions\\|all-themes\\|1.0.8\\|jar) | Themes for primefaces\r\n[omnifaces](http://omnifaces.org/) | [1.14](http://search.maven.org/#artifactdetails\\|org.omnifaces\\|omnifaces\\|1.14\\|jar) | Utility library for JSF 2\r\n[cdi-api](http://www.cdi-spec.org/) | [1.2](http://search.maven.org/#artifactdetails\\|javax.enterprise\\|cdi-api\\|1.2\\|jar) | Api of CDI (Contexts and Dependency Injection)\r\n\r\n### JSF properties configuration via application.properties or application.yml\r\n\r\nLibrary | Namespace | Example | Full Example\r\n------------ | ------------- | --------- | ---------\r\nstandard (javax.faces) | jsf | jsf.PROJECT_STAGE: Development | [application.yml](https://github.com/joinfaces/joinfaces/blob/master/jsf-spring-boot-autoconfigures/jsf-spring-boot-autoconfigure/src/test/resources/application.yml)\r\n[primefaces](http://primefaces.org/) | jsf.primefaces | jsf.primefaces.theme: overcast | [application.yml](https://github.com/joinfaces/joinfaces/blob/master/jsf-spring-boot-autoconfigures/jsf-primefaces-spring-boot-autoconfigure/src/test/resources/application.yml)\r\n[bootsfaces](http://bootsfaces.net/) | jsf.bootsfaces | jsf.bootsfaces.USETHEME: true | [application.yml](https://github.com/joinfaces/joinfaces/blob/master/jsf-spring-boot-autoconfigures/jsf-bootsfaces-spring-boot-autoconfigure/src/test/resources/application.yml)\r\n[butterfaces](http://butterfaces.org/) | jsf.butterfaces | jsf.butterfaces.provideJQuery: true | [application.yml](https://github.com/joinfaces/joinfaces/blob/master/jsf-spring-boot-autoconfigures/jsf-butterfaces-spring-boot-autoconfigure/src/test/resources/application.yml)\r\n[omnifaces](http://omnifaces.org/) | jsf.omnifaces | jsf.omnifaces.FACES_VIEWS_ENABLED: true | [application.yml](https://github.com/joinfaces/joinfaces/blob/master/jsf-spring-boot-autoconfigures/jsf-omnifaces-spring-boot-autoconfigure/src/test/resources/application.yml)\r\n[angularfaces](http://angularfaces.net/) | jsf.angularfaces | jsf.angularfaces.addLabels: true | [application.yml](https://github.com/joinfaces/joinfaces/blob/master/jsf-spring-boot-autoconfigures/jsf-angularfaces-spring-boot-autoconfigure/src/test/resources/application.yml)\r\n[mojarra](https://javaserverfaces.java.net/) | jsf.mojarra | jsf.mojarra.preferXHTML: true | [application.yml](https://github.com/joinfaces/joinfaces/blob/master/jsf-spring-boot-autoconfigures/jsf-mojarra-spring-boot-autoconfigure/src/test/resources/application.yml)\r\n[myfaces](http://myfaces.apache.org/) | jsf.myfaces | jsf.myfaces.PRETTY_HTML: true | [application.yml](https://github.com/joinfaces/joinfaces/blob/master/jsf-spring-boot-autoconfigures/jsf-myfaces-spring-boot-autoconfigure/src/test/resources/application.yml)\r\n[jetty](http://www.eclipse.org/jetty) | jsf.jetty | jsf.jetty.classPathResource: META-INF/resources | [application.yml](https://github.com/joinfaces/joinfaces/blob/master/jsf-spring-boot-autoconfigures/jsf-jetty-spring-boot-autoconfigure/src/test/resources/application.yml)\r\n[undertow](http://undertow.io) | jsf.undertow | jsf.undertow.classPathResource: META-INF/resources | [application.yml](https://github.com/joinfaces/joinfaces/blob/master/jsf-spring-boot-autoconfigures/jsf-undertow-spring-boot-autoconfigure/src/test/resources/application.yml)\r\n\r\nAdditional information in [#22](https://github.com/joinfaces/joinfaces/issues/22)\r\n\r\n### JSF and CDI annotations support automatically\r\n\r\nAnnotation |\r\n------- | ----\r\n[@NoneScoped](http://docs.oracle.com/javaee/7/api/javax/faces/bean/NoneScoped.html) |\r\n[@RequestScoped](http://docs.oracle.com/javaee/7/api/javax/enterprise/context/RequestScoped.html) |\r\n[@ViewScoped](http://docs.oracle.com/javaee/7/api/javax/faces/view/ViewScoped.html) |\r\n[@SessionScoped](http://docs.oracle.com/javaee/7/api/javax/enterprise/context/SessionScoped.html) |\r\n[@ApplicationScoped](http://docs.oracle.com/javaee/7/api/javax/enterprise/context/ApplicationScoped.html) |\r\n\r\n### Spring Security JSF Facelet Tag support \r\n\r\nNamespace: **http://www.springframework.org/security/tags**\r\n\r\nTag | Description\r\n------------ | -------------\r\nauthorize | perform Spring Security authorization decisions, using attributes: ifAnyGranted, ifAllGranted, ifNotGranted, access, url, method, var.\r\nanonymous | verify if the user is anonymous.\r\nauthenticated | verify if the user is not anonymous.\r\nfullyAuthenticated | verify if the is not an anonymous or a remember-me user.\r\n\r\nFunction | Description\r\n------------ | -------------\r\nareAllGranted | returns true if the user has all of of the given authorities.\r\nareAnyGranted | returns true if the user has any of the given authorities.\r\nareNotGranted | returns true if the user does not have any of the given authorities.\r\nisAllowed | returns true if the user is allowed to access the given URL and HTTP method combination.\r\nisAnonymous | returns true if user is anonymous.\r\nisAuthenticated | returns true if the user is not anonymous.\r\nisFullyAuthenticated | returns true if the is not an anonymous or a remember-me user.\r\n\r\nAdditional information in [#29](https://github.com/joinfaces/joinfaces/issues/29)\r\n\r\n## System Requirements\r\n\r\nBy default, JSF Spring Boot Starter requires [Java 7](http://java.com) and [Spring Boot 1.3.6](http://projects.spring.io/spring-boot/) or above.\r\n\r\n## Getting Help\r\n\r\n* Report questions and bugs at [github.com/joinfaces/joinfaces/issues](https://github.com/joinfaces/joinfaces/issues).\r\n\r\n## Contributing\r\n\r\n* Report documentation, features, enhancement and bugs at [github.com/joinfaces/joinfaces/issues](https://github.com/joinfaces/joinfaces/issues).\r\n* Pull requests are welcome.\r\n\r\n## Structure\r\n\r\nThis software is multi module [Maven](http://maven.apache.org) project and follows [Spring Boot Reference](http://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-developing-auto-configuration.html) to create JSF Auto Configuration. [See what's inside each submodule.](https://github.com/joinfaces/joinfaces/wiki/Structure-of-the-software)\r\n",
"note": "Don't delete this file! It's used internally to help with page regeneration."
}