Add token to login credentials and database user
This commit is contained in:
		@@ -7,6 +7,9 @@ import java.time.Instant;
 | 
			
		||||
 * Contains a {@link User}'s login / registration information as well as the
 | 
			
		||||
 * client version.
 | 
			
		||||
 * <p>
 | 
			
		||||
 * If the authentication is performed with a token, the token is stored instead
 | 
			
		||||
 * of the password.
 | 
			
		||||
 * <p>
 | 
			
		||||
 * Project: <strong>envoy-common</strong><br>
 | 
			
		||||
 * File: <strong>LoginCredentials.java</strong><br>
 | 
			
		||||
 * Created: <strong>29.12.2019</strong><br>
 | 
			
		||||
@@ -17,35 +20,68 @@ import java.time.Instant;
 | 
			
		||||
public final class LoginCredentials implements Serializable {
 | 
			
		||||
 | 
			
		||||
	private final String	identifier, password, clientVersion;
 | 
			
		||||
	private final boolean	registration;
 | 
			
		||||
	private final boolean	registration, token;
 | 
			
		||||
	private final Instant	lastSync;
 | 
			
		||||
 | 
			
		||||
	private static final long serialVersionUID = 3;
 | 
			
		||||
 | 
			
		||||
	/**
 | 
			
		||||
	 * Initializes login credentials for a handshake.
 | 
			
		||||
	 *
 | 
			
		||||
	 * @param identifier    the identifier of the user
 | 
			
		||||
	 * @param password      the password of the user
 | 
			
		||||
	 * @param registration  signifies that these credentials are used for user
 | 
			
		||||
	 *                      registration instead of user login
 | 
			
		||||
	 * @param clientVersion the version of the client sending these credentials
 | 
			
		||||
	 * @param lastSync      the time stamp of the last synchronization
 | 
			
		||||
	 * @since Envoy Common v0.2-beta
 | 
			
		||||
	 */
 | 
			
		||||
	public LoginCredentials(String identifier, String password, boolean registration, String clientVersion, Instant lastSync) {
 | 
			
		||||
	private LoginCredentials(String identifier, String password, boolean registration, boolean token, String clientVersion, Instant lastSync) {
 | 
			
		||||
		this.identifier		= identifier;
 | 
			
		||||
		this.password		= password;
 | 
			
		||||
		this.registration	= registration;
 | 
			
		||||
		this.token			= token;
 | 
			
		||||
		this.clientVersion	= clientVersion;
 | 
			
		||||
		this.lastSync		= lastSync;
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	/**
 | 
			
		||||
	 * Creates login credentials for a regular login.
 | 
			
		||||
	 *
 | 
			
		||||
	 * @param identifier    the identifier of the user
 | 
			
		||||
	 * @param password      the password of the user
 | 
			
		||||
	 * @param clientVersion the version of the client sending these credentials
 | 
			
		||||
	 * @param lastSync      the timestamp of the last synchronization
 | 
			
		||||
	 * @return the created login credentials
 | 
			
		||||
	 * @since Envoy Common v0.2-beta
 | 
			
		||||
	 */
 | 
			
		||||
	public static LoginCredentials login(String identifier, String password, String clientVersion, Instant lastSync) {
 | 
			
		||||
		return new LoginCredentials(identifier, password, false, false, clientVersion, lastSync);
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	/**
 | 
			
		||||
	 * Creates login credentials for a login with an authentication token.
 | 
			
		||||
	 *
 | 
			
		||||
	 * @param identifier    the identifier of the user
 | 
			
		||||
	 * @param token         the authentication token of the user
 | 
			
		||||
	 * @param clientVersion the version of the client sending these credentials
 | 
			
		||||
	 * @param lastSync      the timestamp of the last synchronization
 | 
			
		||||
	 * @return the created login credentials
 | 
			
		||||
	 * @since Envoy Common v0.2-beta
 | 
			
		||||
	 */
 | 
			
		||||
	public static LoginCredentials loginWithToken(String identifier, String token, String clientVersion, Instant lastSync) {
 | 
			
		||||
		return new LoginCredentials(identifier, token, false, true, clientVersion, lastSync);
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	/**
 | 
			
		||||
	 * Creates login credentials for a registration.
 | 
			
		||||
	 *
 | 
			
		||||
	 * @param identifier    the identifier of the user
 | 
			
		||||
	 * @param password      the password of the user
 | 
			
		||||
	 * @param clientVersion the version of the client sending these credentials
 | 
			
		||||
	 * @param lastSync      the timestamp of the last synchronization
 | 
			
		||||
	 * @return the created login credentials
 | 
			
		||||
	 * @since Envoy Common v0.2-beta
 | 
			
		||||
	 */
 | 
			
		||||
	public static LoginCredentials registration(String identifier, String password, String clientVersion, Instant lastSync) {
 | 
			
		||||
		return new LoginCredentials(identifier, password, true, false, clientVersion, lastSync);
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	@Override
 | 
			
		||||
	public String toString() {
 | 
			
		||||
		return String.format("LoginCredentials[identifier=%s,registration=%b,clientVersion=%s,lastSync=%s]",
 | 
			
		||||
		return String.format("LoginCredentials[identifier=%s,registration=%b,token=%b,clientVersion=%s,lastSync=%s]",
 | 
			
		||||
				identifier,
 | 
			
		||||
				registration,
 | 
			
		||||
				token,
 | 
			
		||||
				clientVersion,
 | 
			
		||||
				lastSync);
 | 
			
		||||
	}
 | 
			
		||||
@@ -69,6 +105,13 @@ public final class LoginCredentials implements Serializable {
 | 
			
		||||
	 */
 | 
			
		||||
	public boolean isRegistration() { return registration; }
 | 
			
		||||
 | 
			
		||||
	/**
 | 
			
		||||
	 * @return {@code true} if these credentials use an authentication token instead
 | 
			
		||||
	 *         of a password
 | 
			
		||||
	 * @since Envoy Common v0.2-beta
 | 
			
		||||
	 */
 | 
			
		||||
	public boolean usesToken() { return token; }
 | 
			
		||||
 | 
			
		||||
	/**
 | 
			
		||||
	 * @return the version of the client sending these credentials
 | 
			
		||||
	 * @since Envoy Common v0.1-beta
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user