The Enterprise JSF project delivers:

• a PDF document about writing custom JSF components.
• a JSF component library (requires PrimeFaces).

The demo web application is available at: https://demo.e-contract.be/ejsf-demo/

The latest version of the Enterprise JSF document is available at:

https://github.com/e-Contract/enterprise-jsf/releases/download/enterprise-jsf-1.15.0/enterprise-jsf.pdf

The following dependencies are required for building the PDF document:

• make
• latex
• PlantUML, and a PLANTUML_JAR environment variable pointing to the corresponding JAR. PlantUML can be downloaded from: https://plantuml.com

Building this project should be possible on Mac OS, Linux, and FreeBSD.

Compile the PDF document via:

cd doc
make

All the examples referenced within the document can be found within the examples directory.

We prefer to edit the LaTeX document using TeXstudio. TeXstudio can be downloaded from: https://texstudio.org

The Enterprise JSF library provides various JSF components. An overview of all JSF tags is available at: https://demo.e-contract.be/ejsf-demo/api.xhtml

The library is compatible with the following versions of Primefaces:

• 12
• 13
• 14

The JSF component library is available within the e-Contract.be public Maven repository. If you use Maven, refer to the e-Contract.be Maven repository via:

<repository>
    <id>e-contract</id>
    <url>https://www.e-contract.be/maven2/</url>
</repository>

Add the JSF component library to your web application WAR project via:

<dependency>
    <groupId>be.e-contract.enterprise-jsf</groupId>
    <artifactId>ejsf-taglib</artifactId>
    <version>1.17.0</version>
</dependency>
<dependency>
    <groupId>org.primefaces</groupId>
    <artifactId>primefaces</artifactId>
    <version>13.0.10</version>
</dependency>

Within you JSF pages, use the following JSF namespace declaration:

xmlns:ejsf="urn:be:e-contract:ejsf"

Now you are ready to use our components, for example:

<ejsf:outputBoolean value="#{true}"/>

For Jakarta EE 10 runtimes, use the following dependency:

<dependency>
    <groupId>be.e-contract.enterprise-jsf</groupId>
    <artifactId>ejsf-taglib</artifactId>
    <version>1.17.0</version>
    <classifier>jakarta</classifier>
    <exclusions>
        <exclusion>
            <groupId>be.e-contract.enterprise-jsf</groupId>
            <artifactId>ejsf-api</artifactId>
        </exclusion>
    </exclusions>
</dependency>
<dependency>
    <groupId>be.e-contract.enterprise-jsf</groupId>
    <artifactId>ejsf-api</artifactId>
    <version>1.17.0</version>
    <classifier>jakarta</classifier>
</dependency>
<dependency>
    <groupId>org.primefaces</groupId>
    <artifactId>primefaces</artifactId>
    <version>13.0.10</version>
    <classifier>jakarta</classifier>
</dependency>

We use Apache Maven as build system. Apache Maven can be downloaded from: https://maven.apache.org

You need Java JDK 11 or higher to build this project.

Build the project via:

mvn clean install

We provide two flavors of the demo web application:

• ejsf-demo targeting Java EE version 8.
• ejsf-demo-ee10 targeting Jakarta EE version 10.

Running the demo web application requires an application server that supports Java EE version 8. We prefer WildFly as application server. WildFly version 26.1.3.Final is the latest version that still supports Java EE 8. WildFly can be downloaded from: https://www.wildfly.org

Start a WildFly version 26.1.3.Final via:

cd wildfly-26.1.3.Final/bin
./standalone.sh --server-config=standalone-full.xml

Deploy the demo web application via:

cd ejsf-demo
mvn wildfly:deploy

Try out the demo web application via: http://localhost:8080/ejsf-demo/

You can also run the demo web application using an embedded Jetty servlet container. Run the demo web application with Mojarra as JSF implementation via:

cd ejsf-demo
mvn clean jetty:run -Pmojarra

Run the demo web application with MyFaces as JSF implementation via:

cd ejsf-demo
mvn clean jetty:run -Pmyfaces

Run the demo web application on the Open Liberty application server via:

cd ejsf-demo
mvn clean package liberty:run

Run the demo web application on the Payara application server via:

cd ejsf-demo
mvn clean package payara-micro:start -Ppayara

Running the demo web application requires an application server that supports Jakarta EE version 10. We prefer WildFly as application server. WildFly version 32.0.1.Final is the latest version that supports Jakarta EE 10. WildFly can be downloaded from: https://www.wildfly.org

Start a WildFly version 32.0.1.Final via:

cd wildfly-32.0.1.Final/bin
./standalone.sh --server-config=standalone-full.xml

Deploy the demo web application via:

cd ejsf-demo-ee10
mvn wildfly:deploy

Try out the demo web application via: http://localhost:8080/ejsf-demo/

You can also run the demo web application using an embedded Jetty servlet container. Run the demo web application with Mojarra as JSF implementation via:

cd ejsf-demo-ee10
mvn clean jetty:run -Pmojarra

Run the demo web application with MyFaces as JSF implementation via:

cd ejsf-demo-ee10
mvn clean jetty:run -Pmyfaces

Run the demo web application on the Open Liberty application server via:

cd ejsf-demo-ee10
mvn clean package liberty:run

Run the demo web application on the Payara application server via:

cd ejsf-demo-ee10
mvn clean package payara-micro:start -Ppayara

Alternatively, the Java EE application can be compiled and deployed to a WildFly Docker container that is built on the fly (using the Dockerfile-files located in docker/) by entering the following command:

make

Other useful make targets are:

• make run-ee10: to deploy the JEE 10 version on a WildFly Docker 27.x container
• make docker-start-ee8: to start the WildFly Docker 26.x container, with l/p: admin/e-contract.be
• make docker-start-ee10: to start the WildFly Docker 27.x container, with l/p: admin/e-contract.be
• make clean: to clean the maven project and to stop the running WildFly Docker container
• make mrproper: to clean everything and remove the WildFly Docker image(s)
• make doc-with-docker: uses Docker with all required dependencies installed to generate the enterprise-jsf.pdf file.