IPwGenConstants.java

/*
 * JOSSO: Java Open Single Sign-On
 *
 * Copyright 2004-2009, Atricore, Inc.
 *
 * This 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 software 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.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 *
 */
package org.josso.selfservices.password.generator;

/**
 * Interface containing default values and constants related to the password
 * generation process.
 * 
 * @author unrz205
 * 
 */
public interface IPwGenConstants
{

	/**
	 * Default password length, used if none is specified
	 */
	public static final int DEFAULT_PASSWORD_LENGTH = 8;

	/**
	 * Default number of passwords to be generated
	 */
	public static final int DEFAULT_NUMBER_OF_PASSWORDS = 1;

	/**
	 * Default number of columns to be used when printing out passwords on a
	 * terminal
	 */
	public static final int DEFAULT_NUMBER_OF_COLUMNS = -1;

	/**
	 * Flag that indicates whether a password element should be treated as a
	 * consonant.
	 */
	public static final int CONSONANT = 0x01;

	/**
	 * Flag that indicates whether a password element should be treated as a
	 * vowel.
	 */
	public static final int VOWEL = 0x02;

	/**
	 * Flag that indicates whether a password element should be treated as a
	 * diphtong.
	 */
	public static final int DIPTHONG = 0x04;

	/**
	 * Flag that indicates that a password element should not be used as a
	 * starting one in a password.
	 */
	public static final int NOT_FIRST = 0x08;

	/**
	 * Flag that enables the inclusion of digits in the generated passwords.
	 */
	public static final int PW_DIGITS = 0x01;

	/**
	 * Flag that enables the inclusion of upper case characters in the generated
	 * passwords.
	 */
	public static final int PW_UPPERS = 0x02;

	/**
	 * Flag that enables the inclusion of symbols characters in the generated
	 * passwords.
	 */
	public static final int PW_SYMBOLS = 0x04;

	/**
	 * Flag that enables the inclusion of ambiguous characters in the generated
	 * passwords.
	 */
	public static final int PW_AMBIGUOUS = 0x08;

	/**
	 * Special characters that can be included in a password.
	 */
	public static final String PW_SPECIAL_SYMBOLS = "!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~";

	/**
	 * Represents ambiguous characters that can look alike and can confuse users.
	 */
	public static final String PW_AMBIGUOUS_SYMBOLS = "B8G6I1l0OQDS5Z2";
}