PasswordEqualityValidator.java

/*
 * IzPack - Copyright 2001-2008 Julien Ponge, All Rights Reserved.
 * 
 * http://izpack.org/
 * http://izpack.codehaus.org/
 * 
 * Copyright 2003 Elmar Grom
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0
 *     
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.izforge.izpack.util;

import com.izforge.izpack.panels.PasswordGroup;
import com.izforge.izpack.panels.ProcessingClient;
import com.izforge.izpack.panels.Validator;

import java.util.Map;


/**
 * This class represents a simple validator for passwords to test equality.  It is
 * based on the example implementation of a password validator that cooperates with the
 * password field in the <code>UserInputPanel</code>. Additional validation may
 * be done by utilizing the params added to the password field.
 *
 * @author Elmar Grom
 * @author Jeff Gordon
 */
public class PasswordEqualityValidator implements Validator
{

    /**
     * PasswordEqualityValidator
     * Validates the contend of multiple password fields. The test
     *
     * @param client the client object using the services of this validator.
     * @return <code>true</code> if the validation passes, otherwise <code>false</code>.
     */
    public boolean validate(ProcessingClient client)
    {
        boolean returnValue = false;
        Map<String, String> params = getParams(client);
        try
        {
            returnValue = fieldsMatch(client);
            if (returnValue)
            {
                // Additional checking if params passed...
                if (params != null)
                {
                    System.out.println("Additional " + params.size() + " params not evaluated");
                }
            }
        }
        catch (Exception e)
        {
            System.out.println("validate() Failed: " + e);
        }
        return (returnValue);
    }

    private Map<String, String> getParams(ProcessingClient client)
    {
        PasswordGroup group = null;
        Map<String, String> params = null;
        try
        {
            group = (PasswordGroup) client;
            if (group.hasParams())
            {
                params = group.getValidatorParams();
            }
        }
        catch (Exception e)
        {
            System.out.println("getParams() Failed: " + e);
        }
        return (params);
    }

    private boolean fieldsMatch(ProcessingClient client)
    {
        boolean returnValue = true;
        int numFields = client.getNumFields();
        // ----------------------------------------------------
        // verify that there is more than one field. If there
        // is only one field we have to return true.
        // ----------------------------------------------------
        if (numFields < 2)
        {
            returnValue = true;
        }
        else
        {
            String content = client.getFieldContents(0);
            for (int i = 1; i < numFields; i++)
            {
                if (!content.equals(client.getFieldContents(i)))
                {
                    returnValue = false;
                }
            }
        }
        return returnValue;
    }

}