Skip to main content

Struts2 - Writing custom validator

Sometimes it is needed that the existing validation rules those are implemented by struts framework do not satisfy project validation criteria. That you have to write your logic according to your requirements. Struts2 provides the facility to write your own validation class in which you can implement your own validation logic.

Write down a class that extends inbuilt validator support class. In this example I am extending the FieldValidatorSupport class that the validate() method that has to be overridden by your custom validator class. Here we can create the variable (i.e. property) e.g. domainName(or other) and its getter-setter in which the values will be passed from validation (xml) file as parameters.

Method validate() is overridden to implement your validation logic. This method takes the Object to be validated at run time that is passed by interceptor.

The method  getFieldValue() which is inherited from super class will help you to retrieve the actual value of the specified field name from the Object passed to validate method.

Now you can define you validation criteria and you can use addFieldError method to add the field error if your validation condition get failed.  If field error is added here, struts framework get intimation that the field validation has failed and shows its corresponding message is displayed on web page.

import com.opensymphony.xwork2.validator.ValidationException;
import com.opensymphony.xwork2.validator.validators.FieldValidatorSupport;

public class MyValidator extends FieldValidatorSupport {
    private String domainName;

    public String getDomainName() {
        return domainName;

    public void setDomainName(String domainName) {
        this.domainName = domainName;
    public void validate(Object object) throws ValidationException {
        String fieldName = getFieldName();
        Object value = this.getFieldValue(fieldName, object);
        String s = (String) value;
        System.out.println("custom validator invoked for value : "+s);
        if (!s.endsWith(domainName)) {
            addFieldError(fieldName, object);

Create file validators.xml in class path where ActionSupport class is and add the following lines there.
<?xml version="1.0" encoding="UTF-8"?> 
 <!DOCTYPE validators PUBLIC "-//OpenSymphony Group//XWork Validator Config 1.0//EN" "">
    <validator name="myvalidator" class="MyValidator" />

Here myvalidator is the name of validator through which will be refered
MyValidator is the name of the class that is implementing the validation logic.

Step-3 :
Add the following lines of code to use the validator to validate the field .

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE validators PUBLIC 
  "-//OpenSymphony Group//XWork Validator 1.0.2//EN"
    <field name="username">
        <field-validator type="requiredstring">
            <param name="trim">false</param>
            <message>Username is required.</message>

    <field name="email">
        <field-validator type="email">
            <message>Email is invalid.</message>
        <field-validator type="requiredstring">
            <message>Email is required.</message>
        <field-validator type="myvalidator">
            <param name="domainName"></param>
            <message>Email must ends with ${domainName}</message>

Here, you are using the validator myvalidator by referring it the type attribute of field-validator element.
Value of the param having the name domainName will be sent to the domainName property of the validator support class MyValidator.

Download Complete source code of this example.


Unknown said…
password for zip file ?????
YoMan said…
email password plz to
Hemraj said…
Sorry for this mistake. Now, I have replaced zip file that opens without password. And thanks for reminding me for this mistake. New Link is Download
Unknown said…
Thanx a load, Hemraj.
That was very helpful!

Popular posts from this blog

Using HyperSQL (HSQLDB)

HSQLDB is a portable RDBMS implemented in pure java. It can be embedded with your application as well as can be used separately. It is very a small database that supports almost all features of the standard database system. It comes with small jar file that can be found in lib folder. The HSQLDB jar package is located in the /lib directory of the ZIP package and contains several components and programs. Core components of jar file are : HyperSQL RDBMS Engine (HSQLDB), HyperSQL JDBC Driver, Database Manager, and Sql Tool. Installing and Using Download: download latest release of HyperSQL database from website and extract it. You will see following contents. Here "bin" directory contains some batch files those can be used to run a swing based GUI tool. You can use runManagerSwing.bat to connect to database, but database must be on before running it. Directory lib contains File hsqldb.jar . It is the database to be used by you. Running database First

How to handle values from dynamically generated elements in web page using struts2

Some time you will see the form containing the button " Add More " . This facility is provided for the user to get the values for unknown number of repeating for some information. for example when you are asking to get the projects details from user, you need to put the option to add the more project for the user since you don't known how many projects user have. In the HTML form, you repeat the particular section to get the multiple values for those elements. In Html page , you can put the option to add new row of elements or text fields by writing the java script or using JQuery API. Now, the question is that how to capture the values of dynamically generated text fields on the server. Using the servlet programming you can get the values by using getParameters() method that resultants the array of the parameter having the same name. But this limit you to naming the text fields in the HTML form. To ally this approach, you have to take the same name for t

In Process Mode of HSQLDB in web application.

If you want to use the database into your web application, you can use the HSQLDB in In_Process mode. In this mode, you can embed the HSQLDB into your web application and it runs as a part of your web application programm in the same JVM. In this mode, the database does not open any port to connect to the application on the hosing machine and you don't need to configure anything to access it. Database is not expposed to other application and can not be accessed from any dabase tools like dbVisualizer etc. In this mode ,database will be unknown from any other person except you. But in the 1.8.0 version, you can use Server intance for external as well as in process access.  To close the databse, you can issue SHUTDOWN command as an SQL query.   In the in-process mode, database starts from JDBC with the associated databse file provided through  connection URL. for example   DriverManager.getConnection("jdbc:hsqldb:mydatabase","SA","");   Here myd