PasswordPolicy.java

/*
 * Copyright 2018 Global Crop Diversity Trust
 *
 * 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 org.genesys.blocks.security.service;

import org.genesys.blocks.security.UserException;

/**
 * Password policy interface.
 */
public interface PasswordPolicy {

	/**
	 * Check that password meets policy requirements.
	 *
	 * @param password the password
	 * @throws PasswordPolicyException the password policy exception
	 */
	void assureGoodPassword(final String password) throws PasswordPolicyException;

	/**
	 * Thrown when password is not okay.
	 */
	public static final class PasswordPolicyException extends UserException {

		/** The Constant serialVersionUID. */
		private static final long serialVersionUID = -4692900263383479542L;

		/**
		 * Instantiates a new password policy exception.
		 *
		 * @param message the message
		 */
		public PasswordPolicyException(final String message) {
			super(message);
		}
	}
}