com.github.steveice10.mc.auth.service

Class AuthenticationService

java.lang.Object

com.github.steveice10.mc.auth.service.Service

com.github.steveice10.mc.auth.service.AuthenticationService

Direct Known Subclasses:

MojangAuthenticationService, MsaAuthenticationService

public abstract class AuthenticationService
extends Service

Service used for authenticating users.

Constructor Summary

Constructors

Constructor and Description
AuthenticationService(URI defaultURI)

Method Summary

Modifier and Type	Method and Description
String	getAccessToken() Gets the access token of the service.
List<GameProfile>	getAvailableProfiles() Gets the available profiles of the user logged in with the service.
String	getPassword() Gets the password of the service.
List<GameProfile.Property>	getProperties() Gets the properties of the user logged in with the service.
GameProfile	getSelectedProfile() Gets the selected profile of the user logged in with the service.
String	getUsername() Gets the username of the service.
boolean	isLoggedIn() Gets whether the service has been used to log in.
abstract void	login() Logs the service in.
void	logout() Logs the service out.
void	setAccessToken(String accessToken) Sets the access token of the service.
void	setPassword(String password) Sets the password of the service.
void	setUsername(String username) Sets the username of the service.

Methods inherited from class com.github.steveice10.mc.auth.service.Service

getBaseUri, getEndpointUri, getEndpointUri, getProxy, setBaseUri, setBaseUri, setProxy

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AuthenticationService

public AuthenticationService(URI defaultURI)

Method Detail

getAccessToken

public String getAccessToken()

Gets the access token of the service.

Returns:

The user's access token.

isLoggedIn

public boolean isLoggedIn()

Gets whether the service has been used to log in.

Returns:

Whether the service is logged in.

getUsername

public String getUsername()

Gets the username of the service.

Returns:

The service's username.

getPassword

public String getPassword()

Gets the password of the service.

Returns:

The user's ID.

setUsername

public void setUsername(String username)

Sets the username of the service.

Parameters:

username - Username to set.

setPassword

public void setPassword(String password)

Sets the password of the service.

Parameters:

password - Password to set.

getProperties

public List<GameProfile.Property> getProperties()

Gets the properties of the user logged in with the service.

Returns:

The user's properties.

getAvailableProfiles

public List<GameProfile> getAvailableProfiles()

Gets the available profiles of the user logged in with the service.

Returns:

The user's available profiles.

getSelectedProfile

public GameProfile getSelectedProfile()

Gets the selected profile of the user logged in with the service.

Returns:

The user's selected profile.

setAccessToken

public void setAccessToken(String accessToken)

Sets the access token of the service.

Parameters:

accessToken - Access token to set.

login

public abstract void login()
                    throws RequestException

Logs the service in. The current access token will be used if set. Otherwise, password-based authentication will be used.

Throws:

RequestException - If an error occurs while making the request.

logout

public void logout()
            throws RequestException

Logs the service out.

Throws:

RequestException - If an error occurs while making the request.