Fix unnecessary authentication token being sent in requests
This commit is contained in:
		@@ -4,7 +4,7 @@ import java.io.Serializable;
 | 
			
		||||
import java.util.Objects;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Wraps any request sent to the server in the authentication details of a user.
 | 
			
		||||
 * Enables checking for the server whether the client is really who he is supposed to be.
 | 
			
		||||
 *
 | 
			
		||||
 * @author Leon Hofmeister
 | 
			
		||||
 * @param <T> the type of object to be sent
 | 
			
		||||
@@ -12,30 +12,21 @@ import java.util.Objects;
 | 
			
		||||
 */
 | 
			
		||||
public final class AuthenticatedRequest<T extends Serializable> implements Serializable {
 | 
			
		||||
 | 
			
		||||
	private final T			request;
 | 
			
		||||
	private final String	authentication;
 | 
			
		||||
	private final long		userID;
 | 
			
		||||
	private final T		request;
 | 
			
		||||
	private final long	userID;
 | 
			
		||||
 | 
			
		||||
	private static final long serialVersionUID = 1L;
 | 
			
		||||
 | 
			
		||||
	/**
 | 
			
		||||
	 * @param request        the actual object that should be sent
 | 
			
		||||
	 * @param userID         the ID of the currently logged in user
 | 
			
		||||
	 * @param authentication the authentication of the currently logged in user
 | 
			
		||||
	 * @param request the actual object that should be sent
 | 
			
		||||
	 * @param userID  the ID of the currently logged in user
 | 
			
		||||
	 * @since Envoy Common v0.3-beta
 | 
			
		||||
	 */
 | 
			
		||||
	public AuthenticatedRequest(T request, long userID, String authentication) {
 | 
			
		||||
		this.request		= Objects.requireNonNull(request);
 | 
			
		||||
		this.userID			= userID;
 | 
			
		||||
		this.authentication	= authentication == null ? "" : authentication;
 | 
			
		||||
	public AuthenticatedRequest(T request, long userID) {
 | 
			
		||||
		this.request	= Objects.requireNonNull(request);
 | 
			
		||||
		this.userID		= userID;
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	/**
 | 
			
		||||
	 * @return the authentication token of the currently logged in user
 | 
			
		||||
	 * @since Envoy Common v0.3-beta
 | 
			
		||||
	 */
 | 
			
		||||
	public String getAuthentication() { return authentication; }
 | 
			
		||||
 | 
			
		||||
	/**
 | 
			
		||||
	 * @return the request
 | 
			
		||||
	 * @since Envoy Common v0.3-beta
 | 
			
		||||
 
 | 
			
		||||
@@ -15,18 +15,18 @@ import java.util.Objects;
 | 
			
		||||
public final class LoginCredentials implements Serializable {
 | 
			
		||||
 | 
			
		||||
	private final String	identifier, password, clientVersion;
 | 
			
		||||
	private final boolean	registration, token;
 | 
			
		||||
	private final boolean	registration, token, requestToken;
 | 
			
		||||
	private final Instant	lastSync;
 | 
			
		||||
 | 
			
		||||
	private static final long serialVersionUID = 4;
 | 
			
		||||
 | 
			
		||||
	private LoginCredentials(String identifier, String password, boolean registration,
 | 
			
		||||
		boolean token, String clientVersion,
 | 
			
		||||
		Instant lastSync) {
 | 
			
		||||
		boolean token, boolean requestToken, String clientVersion, Instant lastSync) {
 | 
			
		||||
		this.identifier		= Objects.requireNonNull(identifier);
 | 
			
		||||
		this.password		= Objects.requireNonNull(password);
 | 
			
		||||
		this.registration	= registration;
 | 
			
		||||
		this.token			= token;
 | 
			
		||||
		this.requestToken	= requestToken;
 | 
			
		||||
		this.clientVersion	= Objects.requireNonNull(clientVersion);
 | 
			
		||||
		this.lastSync		= lastSync == null ? Instant.EPOCH : lastSync;
 | 
			
		||||
	}
 | 
			
		||||
@@ -36,14 +36,15 @@ public final class LoginCredentials implements Serializable {
 | 
			
		||||
	 *
 | 
			
		||||
	 * @param identifier    the identifier of the user
 | 
			
		||||
	 * @param password      the password of the user
 | 
			
		||||
	 * @param requestToken  requests the server to generate an authentication token
 | 
			
		||||
	 * @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,
 | 
			
		||||
	public static LoginCredentials login(String identifier, String password, boolean requestToken,
 | 
			
		||||
		String clientVersion, Instant lastSync) {
 | 
			
		||||
		return new LoginCredentials(identifier, password, false, false, clientVersion,
 | 
			
		||||
		return new LoginCredentials(identifier, password, false, false, requestToken, clientVersion,
 | 
			
		||||
			lastSync);
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
@@ -59,7 +60,7 @@ public final class LoginCredentials implements Serializable {
 | 
			
		||||
	 */
 | 
			
		||||
	public static LoginCredentials loginWithToken(String identifier, String token,
 | 
			
		||||
		String clientVersion, Instant lastSync) {
 | 
			
		||||
		return new LoginCredentials(identifier, token, false, true, clientVersion, lastSync);
 | 
			
		||||
		return new LoginCredentials(identifier, token, false, true, false, clientVersion, lastSync);
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	/**
 | 
			
		||||
@@ -67,24 +68,27 @@ public final class LoginCredentials implements Serializable {
 | 
			
		||||
	 *
 | 
			
		||||
	 * @param identifier    the identifier of the user
 | 
			
		||||
	 * @param password      the password of the user
 | 
			
		||||
	 * @param requestToken  requests the server to generate an authentication token
 | 
			
		||||
	 * @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,
 | 
			
		||||
		boolean requestToken,
 | 
			
		||||
		String clientVersion, Instant lastSync) {
 | 
			
		||||
		return new LoginCredentials(identifier, password, true, false, clientVersion,
 | 
			
		||||
		return new LoginCredentials(identifier, password, true, false, requestToken, clientVersion,
 | 
			
		||||
			lastSync);
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	@Override
 | 
			
		||||
	public String toString() {
 | 
			
		||||
		return String.format(
 | 
			
		||||
			"LoginCredentials[identifier=%s,registration=%b,token=%b,clientVersion=%s,lastSync=%s]",
 | 
			
		||||
			"LoginCredentials[identifier=%s,registration=%b,token=%b,requestToken=%b,clientVersion=%s,lastSync=%s]",
 | 
			
		||||
			identifier,
 | 
			
		||||
			registration,
 | 
			
		||||
			token,
 | 
			
		||||
			requestToken,
 | 
			
		||||
			clientVersion,
 | 
			
		||||
			lastSync);
 | 
			
		||||
	}
 | 
			
		||||
@@ -116,6 +120,14 @@ public final class LoginCredentials implements Serializable {
 | 
			
		||||
		return token;
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	/**
 | 
			
		||||
	 * @return {@code true} if the server should generate a new authentication token
 | 
			
		||||
	 * @since Envoy Common v0.2-beta
 | 
			
		||||
	 */
 | 
			
		||||
	public boolean requestToken() {
 | 
			
		||||
		return requestToken;
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	/**
 | 
			
		||||
	 * @return the version of the client sending these credentials
 | 
			
		||||
	 * @since Envoy Common v0.1-beta
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user