com.github.to2mbn.jmccc.auth.YggdrasilTokenAuthenticator Maven / Gradle / Ivy
package com.github.to2mbn.jmccc.auth;
import java.util.Objects;
import java.util.UUID;
import com.github.to2mbn.jmccc.launch.AuthenticationException;
import com.github.to2mbn.jyal.GameProfile;
import com.github.to2mbn.jyal.Session;
/**
* Yggdrasil authenticator using token.
*
* This class is serializable. If you want to save the authentication (aka 'remember password'), you don't need to save
* the password, just save this YggdrasilTokenAuthenticator object. It's safer because YggdrasilTokenAuthenticator only
* saves the access token.
*
* Use {@link #loginWithToken(String, String)}, {@link #loginWithToken(String, String, CharacterSelector)}, or
* {@link #loginWithToken(String, String, CharacterSelector, UUID)} to create an instance.
*
* @author yushijinhun
*/
public class YggdrasilTokenAuthenticator extends YggdrasilAuthenticator {
private static final long serialVersionUID = 1L;
/**
* Login with password and create a YggdrasilTokenAuthenticator.
*
* This method uses a randomized client token, and selects the default character.
*
* @param email the email of the account
* @param password the password
* @return the YggdrasilTokenAuthenticator
* @throws AuthenticationException if an exception has occurred during the authentication
* @throws NullPointerException if email==null||password==null||clientToken==null
*/
public static YggdrasilTokenAuthenticator loginWithToken(String email, String password) throws AuthenticationException {
return loginWithToken(email, password, null);
}
/**
* Login with password and create a YggdrasilTokenAuthenticator.
*
* This method uses a randomized client token. If characterSelector!=null,
* {@link CharacterSelector#select(GameProfile, GameProfile[])} will be called during the authentication.
*
* @param email the email of the account
* @param password the password
* @param characterSelector the character selector, null to select the default character
* @return the YggdrasilTokenAuthenticator
* @throws AuthenticationException if an exception has occurred during the authentication
* @throws NullPointerException if email==null||password==null||clientToken==null
*/
public static YggdrasilTokenAuthenticator loginWithToken(String email, String password, CharacterSelector characterSelector) throws AuthenticationException {
return loginWithToken(email, password, characterSelector, UUID.randomUUID());
}
/**
* Login with password and create a YggdrasilTokenAuthenticator.
*
* If characterSelector!=null, {@link CharacterSelector#select(GameProfile, GameProfile[])} will be
* called during the authentication.
*
* @param email the email of the account
* @param password the password
* @param characterSelector the character selector, null to select the default character
* @param clientToken the client token
* @return the YggdrasilTokenAuthenticator
* @throws AuthenticationException if an exception has occurred during the authentication
* @throws NullPointerException if email==null||password==null||clientToken==null
*/
public static YggdrasilTokenAuthenticator loginWithToken(String email, String password, CharacterSelector characterSelector, UUID clientToken) throws AuthenticationException {
// no need for null checks, YggdrasilPasswordAuthenticator. does this
return new YggdrasilTokenAuthenticator(clientToken, new YggdrasilPasswordAuthenticator(email, password, characterSelector, clientToken).auth().getToken());
}
private String accessToken;
/**
* Creates a YggdrasilTokenAuthenticator with the given client token and the given access token.
*
* @param clientToken the given client token
* @param accessToken the given access token
* @throws NullPointerException if clientToken==null
*/
public YggdrasilTokenAuthenticator(UUID clientToken, String accessToken) {
super(clientToken);
Objects.requireNonNull(accessToken);
this.accessToken = accessToken;
}
/**
* Checks if the access token is valid.
*
* If this method returns false, you shouldn't use this YggdrasilTokenAuthenticator any longer. You need to create
* another YggdrasilTokenAuthenticator by password authentication.
*
* @return true if the access token is valid
* @throws AuthenticationException if an error has occurred during validating
*/
public boolean isValid() throws AuthenticationException {
try {
return getSessionService().isValid(accessToken);
} catch (com.github.to2mbn.jyal.AuthenticationException e) {
throw new AuthenticationException("failed to valid access token", e);
}
}
@Override
protected Session createSession() throws com.github.to2mbn.jyal.AuthenticationException {
Session session = getSessionService().loginWithToken(accessToken);
accessToken = session.getAccessToken();
return session;
}
}