org.appng.api.model.AuthSubject Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of appng-api Show documentation

the public API of appNG

There is a newer version: 1.24.5

/*
 * Copyright 2011-2021 the original author or authors.
 *
 * 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.appng.api.model;

import java.util.Date;

/**
 * An {@link AuthSubject} provides some user-credentials.
 * 
 * @author Matthias Müller
 */
public interface AuthSubject extends Account {

	/**
	 * The policy for changing the subject's password
	 * 
	 * @since 1.21
	 */
	enum PasswordChangePolicy {
		MAY, MUST, MUST_NOT, MUST_RECOVER;
	}

	/**
	 * Returns the salted digest for this {@link AuthSubject}.
	 * 
	 * @return the salted digest
	 */
	String getDigest();

	/**
	 * Returns the salt for this {@link AuthSubject}.
	 * 
	 * @return the salt
	 */
	String getSalt();

	/**
	 * Sets the salt for this {@link AuthSubject}.
	 * 
	 * @param salt
	 *             the salt
	 */
	void setSalt(String salt);

	/**
	 * Sets the salted digest for this {@link AuthSubject}.
	 * 
	 * @param digest
	 *               the digest
	 */
	void setDigest(String digest);

	/**
	 * Returns the {@link PasswordChangePolicy} for this subject
	 * 
	 * @return the {@link PasswordChangePolicy} for this subject
	 * 
	 * @since 1.21
	 */
	default PasswordChangePolicy getPasswordChangePolicy() {
		return PasswordChangePolicy.MAY;
	}

	/**
	 * Sets the {@link PasswordChangePolicy} to use.
	 * 
	 * @param passwordChangePolicy
	 *                             the policy to use
	 * 
	 * @since 1.21
	 */
	default void setPasswordChangePolicy(PasswordChangePolicy passwordChangePolicy) {
	}

	/**
	 * Sets the date when the password was last changed
	 * 
	 * @param date
	 *             the date
	 * 
	 * @since 1.21
	 */
	default void setPasswordLastChanged(Date date) {
	}

}