src/main/java/org/apache/directory/fortress/core/impl/GlobalPwMsgIds.java

/*
 *   Licensed to the Apache Software Foundation (ASF) under one
 *   or more contributor license agreements.  See the NOTICE file
 *   distributed with this work for additional information
 *   regarding copyright ownership.  The ASF licenses this file
 *   to you 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 org.apache.directory.fortress.core.impl;


import java.io.Serializable;


/**
 * This class contains constants that contain status for Fortress password policy checking.
 *
 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
 */
public final class GlobalPwMsgIds implements Serializable
{
    /** Default serialVersionUID */
    private static final long serialVersionUID = 1L;

    /**
     * The processor could not process the password message.
     */
    public static final int INVALID_PASSWORD_MESSAGE = -10;

    /**
     * Password policies check out good.
     */
    public static final int GOOD = 0;

    /**
     * No warnings are associated with password.
     */
    public static final int PP_NOWARNING = 0;

    /**
     * The user has no password policies in effect.
     */
    public static final int NOT_PW_POLICY_ENABLED = 8;

    /**
     * The OPENLDAP password policies are not enforced.
     */
    public static final int NOT_OLPW_POLICY_ENABLED = 9;

    /**
     * The password policy control was not found in the message.
     */
    public static final int NO_CONTROLS_FOUND = 10;

    /**
     * The password is expiring.
     */
    public static final int PASSWORD_EXPIRATION_WARNING = 11;

    /**
     * Password in grace.
     */
    public static final int PASSWORD_GRACE_WARNING = 12;

    /**
     * The password has expired.
     */
    public static final int PASSWORD_HAS_EXPIRED = 100;

    /**
     * The User account is locked on the server.
     */
    public static final int ACCOUNT_LOCKED = 101;

    /**
     * The change after reset flag is set indicating the user must change their password.
     */
    public static final int CHANGE_AFTER_RESET = 102;

    /**
     * The User is not allowed to modify their password.
     */
    public static final int NO_MODIFICATIONS = 103;

    /**
     * The User did not supply their old password when trying to change.
     */
    public static final int MUST_SUPPLY_OLD = 104;

    /**
     * The password is not of sufficient quality.
     */
    public static final int INSUFFICIENT_QUALITY = 105;

    /**
     * The new password is too short.
     */
    public static final int PASSWORD_TOO_SHORT = 106;

    /**
     * The new password is too young to be changed.  This is typically used to prevent users from cycling thru
     * password on forced password change to reuse their previous password (to circumvent history constraints).
     */
    public static final int PASSWORD_TOO_YOUNG = 107;

    /**
     * The new password was found in history.
     */
    public static final int HISTORY_VIOLATION = 108;

    /**
     * The User account is locked.
     */
    public static final int ACCOUNT_LOCKED_CONSTRAINTS = 109;

    /**
     * These message will correspond with the errors above and will be loaded into the pw message entity and returned to
     * caller.
     */
    private final static String[] pwMsgs =
        {
            "password will expire",
            "password in grace limit",
            "password is expired",
            "user account is locked",
            "password requires change after reset",
            "password modification is not allowed",
            "old password is required",
            "insufficient password quality is found",
            "password is too short",
            "password is too young",
            "password is in history",
            "account is locked due to user constraints"
    };

    /**
     * array contains the password policy violations.
     */
    private final static int[] pwIds =
        {
            PASSWORD_EXPIRATION_WARNING,
            PASSWORD_GRACE_WARNING,
            PASSWORD_HAS_EXPIRED,
            ACCOUNT_LOCKED,
            CHANGE_AFTER_RESET,
            NO_MODIFICATIONS,
            MUST_SUPPLY_OLD,
            INSUFFICIENT_QUALITY,
            PASSWORD_TOO_SHORT,
            PASSWORD_TOO_YOUNG,
            HISTORY_VIOLATION,
            ACCOUNT_LOCKED_CONSTRAINTS
    };


    /**
     * Return a message that corresponds with error code for User's password.
     *
     * @param iId contains index offset of message.
     * @return string containing the error message.
     */
    public static String getMessage( int iId )
    {
        for ( int i = 0; i < pwIds.length; i++ )
        {
            if ( iId == pwIds[i] )
            {
                return pwMsgs[i];
            }
        }
        return "";
    }


    /**
     * Given a particular message value return the integer offset that corresponds to the index position
     * within the message array.
     *
     * @param strMsg
     * @return int
     */
    private static int getMessageCode( String strMsg )
    {
        for ( int i = 0; i < pwMsgs.length; i++ )
        {
            if ( pwMsgs[i].equals( strMsg ) )
            {
                return pwIds[i];
            }
        }
        return -1;
    }
}