UserPasswordException.java

/**
 * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
 *
 * 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.
 */

package com.liferay.portal.kernel.exception;

import com.liferay.portal.kernel.util.StringPool;

import java.util.Date;
import java.util.List;

/**
 * @author Brian Wing Shun Chan
 * @author Preston Crary
 */
public class UserPasswordException extends PortalException {

	/**
	 * @deprecated As of 7.0.0
	 */
	@Deprecated
	public static final int PASSWORD_ALREADY_USED = 1;

	/**
	 * @deprecated As of 7.0.0
	 */
	@Deprecated
	public static final int PASSWORD_CONTAINS_TRIVIAL_WORDS = 2;

	/**
	 * @deprecated As of 7.0.0
	 */
	@Deprecated
	public static final int PASSWORD_INVALID = 3;

	/**
	 * @deprecated As of 7.0.0
	 */
	@Deprecated
	public static final int PASSWORD_LENGTH = 4;

	/**
	 * @deprecated As of 7.0.0
	 */
	@Deprecated
	public static final int PASSWORD_NOT_CHANGEABLE = 5;

	/**
	 * @deprecated As of 7.0.0
	 */
	@Deprecated
	public static final int PASSWORD_SAME_AS_CURRENT = 6;

	/**
	 * @deprecated As of 7.0.0
	 */
	@Deprecated
	public static final int PASSWORD_TOO_TRIVIAL = 8;

	/**
	 * @deprecated As of 7.0.0
	 */
	@Deprecated
	public static final int PASSWORD_TOO_YOUNG = 9;

	/**
	 * @deprecated As of 7.0.0
	 */
	@Deprecated
	public static final int PASSWORDS_DO_NOT_MATCH = 10;

	/**
	 * @deprecated As of 7.0.0, replaced by the inner classes
	 */
	@Deprecated
	public UserPasswordException(int type) {
		_type = type;
	}

	/**
	 * @deprecated As of 7.0.0, replaced by the inner classes
	 */
	@Deprecated
	public int getType() {
		return _type;
	}

	public static class MustBeLonger extends UserPasswordException {

		public MustBeLonger(long userId, int minLength) {
			super(
				String.format(
					"Password for user %s must be at least %s characters",
					userId, minLength),
				PASSWORD_LENGTH);

			this.minLength = minLength;
			this.userId = userId;
		}

		public final int minLength;
		public final long userId;

	}

	public static class MustComplyWithModelListeners
		extends UserPasswordException {

		public MustComplyWithModelListeners(
			long userId, ModelListenerException modelListenerException) {

			super(
				String.format(
					"Password must comply with model listeners: " +
						modelListenerException.getMessage()),
				PASSWORD_INVALID);

			this.userId = userId;
			this.modelListenerException = modelListenerException;
		}

		public final ModelListenerException modelListenerException;
		public final long userId;

	}

	public static class MustComplyWithRegex extends UserPasswordException {

		public MustComplyWithRegex(long userId, String regex) {
			super(
				String.format("Password must comply with regex: " + regex),
				PASSWORD_INVALID);

			this.regex = regex;
			this.userId = userId;
		}

		public final String regex;
		public final long userId;

	}

	public static class MustMatch extends UserPasswordException {

		public MustMatch(long userId) {
			super(
				String.format("Passwords for user %s must match", userId),
				PASSWORDS_DO_NOT_MATCH);

			this.userId = userId;
		}

		public final long userId;

	}

	public static class MustMatchCurrentPassword extends UserPasswordException {

		public MustMatchCurrentPassword(long userId) {
			super(
				String.format(
					"Password for user %s does not match the current password",
					userId),
				PASSWORD_INVALID);

			this.userId = userId;
		}

		public final long userId;

	}

	public static class MustNotBeChanged extends UserPasswordException {

		public MustNotBeChanged(long userId) {
			super(
				String.format(
					"Password for user %s must not be changed under the " +
						"current password policy",
					userId),
				PASSWORD_NOT_CHANGEABLE);

			this.userId = userId;
		}

		public final long userId;

	}

	public static class MustNotBeChangedYet extends UserPasswordException {

		public MustNotBeChangedYet(long userId, Date changeableDate) {
			super(
				String.format(
					"Password for user %s must not be changed until %s", userId,
					changeableDate),
				PASSWORD_TOO_YOUNG);

			this.userId = userId;
			this.changeableDate = changeableDate;
		}

		public final Date changeableDate;
		public long userId;

	}

	public static class MustNotBeEqualToCurrent extends UserPasswordException {

		public MustNotBeEqualToCurrent(long userId) {
			super(
				String.format(
					"Password for user %s must not be equal to their current " +
						"password",
					userId),
				PASSWORD_SAME_AS_CURRENT);

			this.userId = userId;
		}

		public final long userId;

	}

	public static class MustNotBeNull extends UserPasswordException {

		public MustNotBeNull(long userId) {
			super(
				String.format("Password for user %s must not be null", userId),
				PASSWORD_INVALID);

			this.userId = userId;
		}

		public long userId;

	}

	public static class MustNotBeRecentlyUsed extends UserPasswordException {

		public MustNotBeRecentlyUsed(long userId) {
			super(
				String.format(
					"Password for user %s was used too recently", userId),
				PASSWORD_ALREADY_USED);

			this.userId = userId;
		}

		public long userId;

	}

	public static class MustNotBeTrivial extends UserPasswordException {

		public MustNotBeTrivial(long userId) {
			super(
				String.format(
					"Password for user %s must not be too trivial", userId),
				PASSWORD_TOO_TRIVIAL);

			this.userId = userId;
		}

		public long userId;

	}

	public static class MustNotContainDictionaryWords
		extends UserPasswordException {

		public MustNotContainDictionaryWords(
			long userId, List<String> dictionaryWords) {

			super(
				String.format(
					"Password for user %s must not contain dictionary words " +
						"such as: %s",
					userId, _getDictionaryWordsString(dictionaryWords)),
				PASSWORD_CONTAINS_TRIVIAL_WORDS);

			this.userId = userId;
			this.dictionaryWords = dictionaryWords;
		}

		public final List<String> dictionaryWords;
		public long userId;

	}

	private static String _getDictionaryWordsString(
		List<String> dictionaryWords) {

		if (dictionaryWords.size() <= 10) {
			return dictionaryWords.toString();
		}

		List<String> sampleDictionaryWords = dictionaryWords.subList(0, 10);

		return sampleDictionaryWords.toString() + StringPool.SPACE +
			StringPool.TRIPLE_PERIOD;
	}

	private UserPasswordException(String message, int type) {
		super(message);

		_type = type;
	}

	private final int _type;

}