JavaServer Faces JSF Validation Tutorial: Error Handling in JSF

In continuation with my previous article on Creating JavaServer Faces JSF application in Eclipse, I am posting next article in the series. This time we will cover details about JSF Validation Model and Handling Errors in JSF. JavaServer Faces technology supports a mechanism for validating the data of editable components. Each component in JavaServer Faces, created Error Messages during the life cycle of JSF and attached them to FacesContext object. Hence each message is attached to a component in the component tree and the message is displayed into the view at the end of JSF life cycle.

Showing Error Messages on View

JSF provides different tags to handle and display messages on the view. There are two message tags in SUN’s reference implementation of JSF HTML library:

<h:message />
<h:messages />
Code language: HTML, XML (xml)

h:messages is used to display all messages at once. You can place h:messages tag in start of your form. You may need to display only global messages using h:messages tag. For displaying only global messages set globleOnly attribute of h:messages to true.

<h:messages globalOnly="true" />
Code language: HTML, XML (xml)

Use h:message to display message attached to one component. An attibute for=”” can be used to specify the id of a component whose error messages we need to display. h:message is used to display error message next to the component that generated the error. If more then one message is attached to that component, h:message will display the last message.

...
<h:inputText id="userName" value="#{userBean.userName}" />
<h:message for="userName" />
...
Code language: HTML, XML (xml)

Each message can have a summary description and a detailed description. When using the h:message tag, the default is to show the detail message. When using the h:messages tag, the default is to display the summary descriptions. To change the defaults, modify the boolean showSummary and showDetail attributes.

<h:message for="userName" showSummary="true"/>
<h:messages showDetail="true"/>
Code language: HTML, XML (xml)

You can also enable component’s detail message to appear as a tooltip. To do so, set tooltip attribute of message tag to true. Note that for enabling this option, showDetail and showSummary must be set to true. There are four forms of JSF validation: 1. Built-in validation components 2. Application level validations 3. Custom validation components using Validator interface 4. Validation methods in backing beans

Built-in validation components

The SUN’s reference implementation of JSF provides some default validation components that can be leveraged to implement validation of any user inputs. The JSF’s core library provides tags to validate input. Following are few tags that can be used to validate the input. f:validateDoubleRange : This tag checks the value of component within specified range. The value must be convertible to floating-point type or a floating-point itself. f:validateLength : This tag checks the length of a value and restrict it within a specified range. The value must be of type java.lang.String. f:validateLongRange : Checks is component value is within a specified range. The value must be of numeric type or string convertible to a long. Example:

<h:inputText id="Username" value="#{UserBean.userName}">
	<f:validateLength minimum="6" maximum="15"/>
</h:inputText>
....
<h:inputText id="Age" value="#{UserBean.age}">
	<f:validateLongRange minimum="1" maximum="120"/>
</h:inputText>
Code language: HTML, XML (xml)

Validation using Backing Bean methods

A backing bean method can be used for doing validation of any input field. First we need to create the backing bean method that will get called during validation process. The signature of the method can be:

public void <METHOD_NAME> (FacesContext context, UIComponent component, Object value) { .. }
Code language: Java (java)

Once a backing bean method is ready we can bind it with a component using f:validator tag.

<h:inputText value="#{userBean.name}" validator="#{userBean.checkUsername}">
</h:inputText>
Code language: HTML, XML (xml)

In above snippet, we have bind checkUsername() method of userBean to component inputText. It is possible to bind more than one validators to one component. Backing bean method of validation is easy to implement, but this method is specific for one application and may not be reused for different application. To create generic validators which can be used in different application, Validator interface can be used.

Custom validation components using Validator interface

Validator interface can be extended and a custom validator can be created which can be reused across different applications in JSF. To create a custom validator, we need to create a Java class that implements javax.faces.validator.Validator interface. Validator interface provides a method validate () that needs to be implemented. Following is the signature of validate() method.

import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
import javax.faces.validator.Validator;
import javax.faces.validator.ValidatorException;
...
...
public void validate(FacesContext context, UIComponent component, Object value)
		throws ValidatorException {
}
Code language: Java (java)

Once the Validator is implemented, we need to register this validator in faces-config.xml file. To do so copy following code in faces-config.xml assuming that our validator class name is net.viralpatel.jsf.helloworld.EmailValidator.

<validator>
	<validator-id>emailValidator</validator-id>
	<validator-class>net.viralpatel.jsf.helloworld.EmailValidator</validator-class>
</validator>
Code language: HTML, XML (xml)

We can bind this validator with any component using f:validator tag.

<h:inputText id="Email" value="#{userBean.email}" required="true">
	<f:validator validatorId="emailValidator" />
</h:inputText>
Code language: HTML, XML (xml)

Note that in above code snippet, validatorId attribute of f:validator tag points to the validator’s ID that is registered in faces-config.xml file. For validating email address we can create a Validator class as:

package net.viralpatel.jsf.helloworld;

import javax.faces.application.FacesMessage;
import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
import javax.faces.validator.Validator;
import javax.faces.validator.ValidatorException;

public class EmailValidator implements Validator{
	public void validate(FacesContext context, UIComponent component, Object value)
			throws ValidatorException {
		
		String email = (String) value;
		
		if(!email.contains("@")) {
			FacesMessage message = new FacesMessage();
			message.setSeverity(FacesMessage.SEVERITY_ERROR);
			message.setSummary("Email is not valid.");
			message.setDetail("Email is not valid.");
			context.addMessage("userForm:Email", message);
			throw new ValidatorException(message);
		}
	}
}
Code language: Java (java)

Thus by using JSF Validation framework, it is possible to validate user input easily. We saw different ways of validation in JSF: Default validators, backing bean methods and validation through validator interface. Let me know your comments about this tutorial. << PREVIOUS: Tutorial: Creating JavaServer Faces JSF application in Eclipse.