Package de.florianmichael.classic4j.model.classicube

Class CCAuthenticationResponse

java.lang.Object

de.florianmichael.classic4j.model.classicube.CCAuthenticationResponse

public final class CCAuthenticationResponse
extends Object

This class represents the response of the ClassiCube server list when authenticating. It is used by ClassiCubeHandler.

Field Summary

Fields

Modifier and Type	Field	Description
final boolean	authenticated
final Set<String>	errors
final String	token
final String	username

Constructor Summary

Constructors

Constructor	Description
CCAuthenticationResponse(String token, String username, boolean authenticated, Set<String> errors)

Method Summary

Modifier and Type	Method	Description
Set<CCError>	errors()
static CCAuthenticationResponse	fromJson(String json)
String	getErrorDisplay()	Returns a string containing all errors separated by a new line.
boolean	mfaRequired()
boolean	shouldError()

Methods inherited from class java.lang.Object

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

Field Details

token

public final String token

username

public final String username

authenticated

public final boolean authenticated

errors

public final Set<String> errors

Constructor Details

CCAuthenticationResponse

public CCAuthenticationResponse(String token,
 String username,
 boolean authenticated,
 Set<String> errors)

Method Details

fromJson

public static CCAuthenticationResponse fromJson(String json)

Parameters:

json - The JSON string to create the CCAuthenticationResponse from.

Returns:

The created CCAuthenticationResponse.

shouldError

public boolean shouldError()

Returns:

Whether the CCAuthenticationResponse contains any errors.

getErrorDisplay

public String getErrorDisplay()

Returns a string containing all errors separated by a new line.

Returns:

The error display.

errors

public Set<CCError> errors()

Returns:

All error names as a set.

mfaRequired

public boolean mfaRequired()

Returns:

Whether the CCError.LOGIN_CODE error is present.