JoinFaces Example

This SAP (Single Page Application) illustrates JSF usage inside JAR packaged Spring Boot Application.

JoinFaces autoconfigures PrimeFaces, BootsFaces, ButterFaces, OmniFaces, AngularFaces, Mojarra and MyFaces libraries to run at embedded Tomcat, Jetty or Undertow.

See Example Application in the cloud

1- Access starter.jsf page at https://joinfaces-example.herokuapp.com/index.jsf. This page can help you to choose the JSF Spring Boot Starter that fits your needs. You may login with credentials

User	Password	Roles
persapiens	123	ROLE_ADMIN
nyilmaz	qwe	ROLE_USER

Run Example Application locally

1- Clone this project

git clone https://github.com/joinfaces/joinfaces-maven-jar-example.git

2- Build

mvn clean install

3- Run

java -jar target/joinfaces-example-3.0.0-SNAPSHOT.jar

4- Access starter page at http://localhost:8080/index.jsf

Key Files

pom.xml

Includes joinfaces starter dependency. All other jsf dependencies are included transitively.

<parent>
    <groupId>org.joinfaces</groupId>
    <artifactId>joinfaces-parent</artifactId>
    <version>3.0.0-SNAPSHOT</version>
    <relativePath/>
</parent>

<dependencies>
    <dependency>
      <groupId>org.joinfaces</groupId>
      <artifactId>jsf-spring-boot-starter</artifactId>
    </dependency>
</dependencies>

If you prefer Jetty instead of Tomcat, exclude tomcat-spring-boot-starter artifactId and add jetty-spring-boot-starter in order to use Jetty servlet container.

If you prefer Undertow instead of Tomcat, exclude tomcat-spring-boot-starter artifactId and add undertow-spring-boot-starter in order to use Undertow servlet container.

If you prefer MyFaces instead of Mojarra, exclude mojarra-spring-boot-starter artifactId and add myfaces-spring-boot-starter in order to use MyFaces JSF Implementation.

If you prefer PrimeFaces, add primefaces-spring-boot-starter in order to use PrimeFaces JSF Components.

If you prefer BootsFaces, add bootsfaces-spring-boot-starter in order to use BootsFaces JSF Components.

If you prefer ButterFaces, add butterfaces-spring-boot-starter in order to use ButterFaces JSF Components.

If you prefer AngularFaces, add angularfaces-spring-boot-starter in order to use AngularFaces JSF Components.

If you prefer RichFaces, add richfaces-spring-boot-starter in order to use RichFaces JSF Components.

Note that spring-boot-starter-security is included to secure the application.

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-security</artifactId>
    </dependency>
</dependencies>

src/main/resources/application.yml

Configure jsf.PROJECT_STATE and jsf.primefaces.THEME properties.

jsf:
  PROJECT_STAGE: Development
  primefaces: 
    theme: overcast

src/main/resources/META-INF/resources/content/starter.xhtml

Example page to help you choose the right JSF Spring Boot Starter for you.

Note that xhtml, js, css and images files should be located at src/main/resources/META-INF/resources directory to JSF use them.

Look at authorize and anonymous jsf spring security facelet tags in action to secure page information.

  <sec:authorize access="hasRole('ROLE_ADMIN')">
    <p:panelGrid columns="1" rendered="#{sec:isFullyAuthenticated()}">
      <p:link title="Logout" href="/logout">
        <p:outputLabel value="You are logged in as an ADMIN" />
      </p:link>
    </p:panelGrid>
  </sec:authorize>

src/main/java/org/joinfaces/example/JoinFacesExampleApplication.java

Very simple spring main application. Only SpringBootApplication annotation is required.

@SpringBootApplication
public class JoinFacesExampleApplication {

src/main/java/org/joinfaces/example/SecurityConfig.java

Spring Security configuration class to secure authentication with credentials to persapiens and nyilmaz users.

src/main/java/org/joinfaces/example/view/StarterMBean.java

Managed bean using ViewScoped CDI annotation. The equivalent spring scope of ViewScoped annotation is configured automatically by Jsf Spring Boot Starter.

@Named
@ViewScoped
public class StarterMBean {

Getting Help

Take a look at JoinFaces Wiki.
Report questions and bugs at github.com/joinfaces/joinfaces-example/issues.

Contributing

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

nkolosnjaji / joinfaces-maven-jar-example