Welcome to the OmniFaces Showcase application!

Live examples of the OmniFaces components and utilities can be tried out here. Check out the left side menu for all of 'em!

Please note that OmniFaces is a JSF utility library, not a JSF UI/component library. The UI which you see on this showcase is done by PrimeFaces 5.3, with a little bit of custom CSS.

The source code of this showcase can be found here. The below is actually a copy of the homepage.

Download - Showcase - API docs - VDL docs - Sources - Issues - Twitter

What is OmniFaces?

Tired of reinventing JSFUtils or FacesUtils utility classes for every JSF web application and/or homebrewing custom components, taghandlers, etc to workaround or enhance some general shortcomings in JSF? OmniFaces may be what you're looking for!

OmniFaces is a utility library for JSF 2 that focusses on utilities that ease everyday tasks with the standard JSF API. OmniFaces is a response to frequently recurring problems encountered during ages of professional JSF development of the JDevelopment team and from questions being asked on Stack Overflow.

Contrary to some of the other excellent JSF 2 libraries out there (like PrimeFaces, BootsFaces, or RichFaces), OmniFaces does not contain much if any of the beautiful visually oriented components that those other libraries are already known and loved for. As such, OmniFaces does not and probably will never contain things like rich table components or tasty look'n'feels. OmniFaces is more geared toward "utilities" that solve everyday practical problems and workarounds for small shortcomings in the JSF API. Such utilities and workarounds can be based on components, but OmniFaces does not necessarily strive to be a "component library" perse. OmniFaces can just be used together with any component library.

Besides utility classes for working with the JSF API from Java code, such as Faces and Messages, and utility and enhanced components, such as o:highlight and o:viewParam, OmniFaces will include various general converters, validators and Facelets tag handlers. These will range from "all-or-none" validators to converters which automatically convert Java models for usage in f:selectItem(s). There are also specialized handlers, such as a full ajax exception handler which will automatically handle all ajax exceptions with the default web.xml error-page mechanisms and a combined resource handler which will automatically combine all separate CSS/JS resources into a single resource. CDI specific features are available such as transparent support for injection in @FacesConverter and @FacesValidator. For a full overview of what's all available in OmniFaces and several live examples, look at the showcase.

Minimum requirements

An important design goal will be to have as few dependencies as possible and to be minimally invasive. So far, OmniFaces 1.x only requires Java 1.6, JSF 2.0, EL 2.1 and Servlet 2.5 APIs which is already minimally available in a fairly modern servlet container serving a JSF 2.x web application. OmniFaces 2.x goes a step further by requiring Java 1.7, JSF 2.2, EL 2.2, Servlet 3.0 and CDI 1.1 APIs which is already minimally available in a fairly modern servlet container serving a JSF 2.2 web application.

Since OmniFaces 1.6 there is an optional dependency on CDI, which turned out to be troublesome in some outdated environments, so they were since version 1.10 removed from version 1.x for a better compatibility with those environments. The CDI specific features remain in version 2.x whereby the CDI dependency is thus made required. Version 1.x users who are already using CDI specific features on a JSF 2.1 environment should be able to effortlessly migrate to version 2.x. As of now, OmniFaces 2.x is backwards compatible with JSF 2.1, but not with JSF 2.0 anymore due to the new <o:viewParamValidationFailed> tag.

All versions have an optional dependency on JSR303 Bean Validation which is only required when you actually use <o:validateBean> or JsfLabelMessageInterpolator.

OmniFaces should principally integrate perfectly well with most other JSF component libraries. Even more, the OmniFaces showcase application uses PrimeFaces. If you encounter problems in combination with a specific component library, then by all means report an issue. We'll investigate if it's caused by OmniFaces or the component library in question and fix it or propose a workaround solution, depending on the nature of the problem. Note that OmniFaces is due to the mandatory Servlet API dependency not compatible with portlets.


It is a matter of dropping the OmniFaces 2.2 JAR file in /WEB-INF/lib.

Maven users can add OmniFaces by adding the following Maven coordinates to pom.xml of the WAR project:


For users on outdated environments who can't/won't use CDI, use 1.12.1 instead. It doesn't contain anything from CDI nor new things which were added in 2.x, but it does contain enhancements and bugfixes to existing 1.x things.

The OmniFaces UI components/taghandlers and EL functions are available under the following XML namespaces:


OmniFaces is designed as a WAR library (web fragment library) and therefore can't be placed elsewhere in the webapp's runtime classpath outside WAR's own /WEB-INF/lib, such as EAR's /lib or even server's or JRE's own /lib. When OmniFaces JAR file is misplaced this way, then the webapp will be unable to find OmniFaces-bundled JSF/CDI annotated classes and throw exceptions related to this during deploy or runtime. To solve it, put back OmniFaces in WAR's /WEB-INF/lib.


Version history can be found in "What's new" page at the showcase.

OmniFaces 2.x

Required: Java 1.7, JSF 2.2, EL 2.2, Servlet 3.0 and CDI 1.1
Optional: BV 1.0

OmniFaces 1.1x

Required: Java 1.6, JSF 2.0, EL 2.1, Servlet 2.5
Optional: BV 1.0

OmniFaces 1.6 - 1.8

Required: Java 1.6, JSF 2.0, EL 2.1, Servlet 2.5
Optional: CDI 1.0 and BV 1.0

OmniFaces 1.0 - 1.5

Required: Java 1.6, JSF 2.0, EL 2.1, Servlet 2.5
Optional: BV 1.0


If you like to play around with the newest of the newest, hereby accepting the risk that new classes/methods may be moved/renamed without notice, then grab the 2.3-SNAPSHOT instead.

Maven users can add OmniFaces SNAPSHOT by adding the following Maven coordinates to pom.xml:


It is showcased on the SNAPSHOT showcase instead of the main showcase.

For starters, a "snapshot" is just the current/latest build. It's far from a release. We may make code changes and create snapshots so now and then before final version release. Those changes will then get reflected in your project if you use the snapshot version in your Maven project and forces an update. It will generally work just fine, but imagine if we make some mistake and notice it only a few days or weeks later, or are trying to test something which may not necessarily work in all environments, then your project may be affected. That's why it's advisable to not use snapshots of 3rd party libraries in production, unless you have your own build system which can "lock" a specific snapshot version, or closely track (and understand) any changes in the codebase. See also a.o. What exactly is a Maven snapshot?.



Mastering OmniFaces

Mastering OmniFaces is since October 5, 2015 available at Amazon.com. This book was created in cooperation with the creators of OmniFaces, Bauke Scholtz and Arjan Tijms. From the beginning on, they worked together with Anghel Leonard and Constantin Alin to get this book ready, and have reviewed it from top to bottom.

A little over 500 pages, this book goes into depth identifying general JSF problems and describing how OmniFaces has solved it, hereby uncovering several patterns and tricks. Basically, the working of every OmniFaces component, taghandler, converter, validator, and several handlers and listeners is break down in the book in a problem-to-solution approach. Reading this book is a true learning exercise as to exploiting JSF API, creating custom components, renderers, tagfiles and what not provided by JSF API in order to solve common problems.

A must read if you also like Mastering JSF 2.2 from the same author!



If you have specific programming problems or questions related to the OmniFaces library, feel free to post a question on Stack Overflow using at least the jsf and omnifaces tags.

If you have found bugs or have new ideas, feel free to open a new issue.

If you have general feedback that's not either a question, bug report or feature request, or if you have a review/rating, please feel free to leave it at Devrates or Ohloh

OmniFaces in the worldwide news and literature