org.opencms.security.I_CmsValidationHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opencms-test Show documentation

OpenCms is an enterprise-ready, easy to use website content management system based on Java and XML technology. Offering a complete set of features, OpenCms helps content managers worldwide to create and maintain beautiful websites fast and efficiently.

There is a newer version: 18.0

Show newest version

/*
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * For further information about Alkacon Software GmbH & Co. KG, please see the
 * company website: http://www.alkacon.com
 *
 * For further information about OpenCms, please see the
 * project website: http://www.opencms.org
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.opencms.security;

import org.opencms.main.CmsIllegalArgumentException;

/**
 * Defines general validation methods.
 *
 * @since 6.3.0
 */
public interface I_CmsValidationHandler {

    /**
     * Checks if the provided email is a valid email address.

     *
     * @param email the email address to validate
     *
     * @throws CmsIllegalArgumentException if the given email address is not valid
     */
    void checkEmail(String email) throws CmsIllegalArgumentException;

    /**
     * Checks if the provided first name is valid.

     *
     * @param firstname the first name to validate
     *
     * @throws CmsIllegalArgumentException if the given email address is not valid
     */
    void checkFirstname(String firstname) throws CmsIllegalArgumentException;

    /**
     * Checks if the provided group name is a valid group name.

     *
     * @param groupName the group name to check
     *
     * @throws CmsIllegalArgumentException if the given group name is not valid
     */
    void checkGroupName(String groupName) throws CmsIllegalArgumentException;

    /**
     * Checks if the provided last name is valid.

     *
     * @param lastname the last name to validate
     *
     * @throws CmsIllegalArgumentException if the given email address is not valid
     */
    void checkLastname(String lastname) throws CmsIllegalArgumentException;

    /**
     * Checks if the provided user name is a valid user name.

     *
     * @param userName the user name to check
     *
     * @throws CmsIllegalArgumentException if the given user name is not valid
     */
    void checkUserName(String userName) throws CmsIllegalArgumentException;

    /**
     * Checks if the provided string is a valid zip code.
     *
     * @param zipcode the zip code to validate
     *
     * @throws CmsIllegalArgumentException if the given zip code is not valid
     */
    void checkZipCode(String zipcode) throws CmsIllegalArgumentException;
}