joinfaces/joinfaces

JoinFaces: JSF Spring Boot Starters - JSF inside Spring Boot Application

JoinFaces

This project enables JSF usage inside Spring Boot Application.

It autoconfigures PrimeFaces, PrimeFaces Extensions, Apache MyFaces Tobago, OmniFaces, AdminFaces, Mojarra and MyFaces libraries to run at embedded Tomcat, Jetty or Undertow servlet containers. It autoconfigures Weld, Apache OpenWebBeans, and Rewrite too.

It also aims to solve JSF and Spring Boot integration features. Current version includes JSF and CDI annotations support and Spring Security JSF Facelet Tag support.

How to use

JoinFaces Example shows JSF Spring Boot Starter usage. It may help you to choose the JSF Spring Boot Starter that fits your needs.

Official example projects

Build tool \ packaging	jar	war
Maven	maven-jar-example	maven-war-example
Gradle	gradle-jar-example	gradle-war-example

Key Features

Take a look at Reference Guide to see JoinFaces features: Starters, Servlet-Context Init Parameters, JSF and CDI scope-annotations support and Spring Security JSF Facelet Tag support.

System Requirements

Joinfaces	Java	Spring Boot	JSF / Faces
2.x	1.6 to 1.8	1.x	2.0 to 2.2
3.0 to 3.2	1.8	2.0	2.0 to 2.3
4.0.x	1.8 to 11	2.1	2.0 to 2.3
4.1.x	1.8 to 12	2.2	2.0 to 2.3
4.3.x	1.8 to 14	2.3	2.0 to 2.3
4.4.x	1.8 to 15	2.4	2.0 to 2.3
4.5.x	1.8 to 16	2.5	2.0 to 2.3
4.6.x	1.8 to 16	2.6	2.0 to 2.3
4.7.x	1.8 to 17	2.7	2.0 to 2.3
5.0.x	17 to 19	3.0	3.0 to 4.0
5.1.x	17 to 20	3.1	3.0 to 4.0
5.2.x	17 to 21	3.2	3.0 to 4.0
5.3.x	17 to 21	3.3	3.0 to 4.0

This are the combinations we have tested and expect to work, but depending on the features you are using, other combinations might work, too. When using Java 9 or higher, make sure to use JoinFaces only on the classpath and not on the modulepath.

Getting Help

• Take a look at wiki.
• Report questions and bugs at github.com/joinfaces/joinfaces/issues.

Contributing

• Report documentation, features, enhancement and bugs at github.com/joinfaces/joinfaces/issues.
• Pull requests are welcome.

joinfaces's Issues

Create jsf-jetty-myfaces-spring-boot-starter

Configure faces-config.xml

Create .gitignore

Spring Security support

Would you consider to add support Spring Security as well? What I have done before is stripping necessary components from spring-webflow and put inside our project. Using directly spring-webflow is bringing other dependencies that is why we are not using directly using them.

Here is the relevant part of it:

https://github.com/spring-projects/spring-webflow/tree/ae25f24443a1756b1149a95200bbe9f04a24f911/spring-faces/src/main/java/org/springframework/faces/security

Create UndertowSpringBootAutoConfiguration

Create Myfaces Spring Boot Auto Configuration

Fix ConditionalOnClass of JettySpringBootAutoConfiguration

Change project version to 1.1.0-SNAPSHOT

Create Empty class to force javadoc jar generation

It facilitates Maven Central Repository requirements.

Configure spring.factories

Jetty and Undertow support?

Hey,

We are considering to move your project but seems a notice in homepage about tomcat. Is this library working only Tomcat? Ideally a Spring Boot starter would be run with Jetty and Undertow as well.

Thanks for sharing.

Create Mojarra Spring Boot Auto Configuration

Create jsf-myfaces-spring-boot-starter

Create Myfaces Properties

Add ViewScope Spring Implementation

Create jsf-myfaces-spring-boot-autoconfigure module

Move PrimefacesCaptchaProperties to PrimefacesProperties

Create JavaxFaces Properties

Create JettySpringBootAutoConfiguration

Remove RequestContextListener definition from MojarraSpringBootAutoConfiguration

RequestContextListener bean definition blocks WebMvcAutoConfigurations RequestContextFilter bean to be defined.

https://github.com/spring-projects/spring-boot/blob/v1.3.5.RELEASE/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/WebMvcAutoConfiguration.java#L184

Hence ServletRequestAttributes is not set appropriately (ie. HttpServletResponse is not set).

The very same configuration is present for MyFaces also.

Create jsf-springboot-integration module

The JSF Spring Boot Integration module should include code related to integration JSF and Spring Boot.
For example, JSF and CDI annotations to spring scope solution should migrate to it.

Configure pom.xml to enable distribution to maven central

Add debug information about ConfigurationProperties

All of Properties are used to configure ServletContext.
Debug information when ServletContext would be useful.

Create UndertowProperties

Create Servlet Context Configurer Abstraction

Create Omnifaces Properties

Change main package to com.github.persapiens.jsfboot

Create jsf-jetty-spring-boot-starter

Organize submodules pom.xml properties

Create JavaxFaces Spring Boot Auto Configuration

Create Primefaces Properties

Add CdiScopeResolver to support cdi and jsf annotations

Create jsf-undertow-spring-boot-starter

Fix ConditionalOnClass of UndertowSpringBootAutoConfiguration

Update maven-jar-plugin version to 3.0.0

Add JsfCdiToSpringTest

Fix starter pom.xml version

Move OmnifacesCacheProperties to OmnifacesProperties

configure project structure to enable milestone 1.2.0

serializeStateServer property of JavaxFacesProperties should be serializeServerState

Original property is javax.faces.SERIALIZE_SERVER_STATE.

Support JSF and CDI annotations automatically

CdiScopeResolver should not be necessary in client applications anymore.

Add .travisci

Rationalize configuration properties

I had a quick look at the code and I can see a lot of different prefixes for the configuration. A few thoughts:

• Maybe it would be nicer if all options were gathered under a common prefix (something like jsf if that makes sense?)
• If splitting the configuration by components is a good thing, maybe we should use the name of the component rather than a package name. This is a bit unusual compared to other libraries.

What do you think?

Create JettyProperties

Create Mojarra Properties

Create jsf-undertow-myfaces-spring-boot-starter

Create Primefaces Spring Boot Auto Configuration

ClassCastException when HandlerWrappers are added via spring-boot for jetty starter

Referring to https://github.com/spring-projects/spring-boot/blob/50e0bb2d9ca3d4d649ec55d135381102c6b6737d/spring-boot/src/main/java/org/springframework/boot/context/embedded/jetty/JettyEmbeddedServletContainerFactory.java#L166

If either of server header or gzip compression is enabled, HandlerWrappers are added and this line breaks throwing ClassCastException. Server.getHandler() does not return WebAppContext anymore.

My first reaction was adding @Order to JettySpringBootAutoConfiguration but it did not work. Solution would be like;

          Handler[] childHandlersByClass = server.getChildHandlersByClass(WebAppContext.class);
           WebAppContext webAppContext = (WebAppContext) childHandlersByClass[0];

Keep up good work btw! Thanks!

Create project structure with pom.xml

Create Omnifaces Spring Boot Auto Configuration