Module Mal4J

Package dev.katsute.mal4j

Class AccessToken

java.lang.Object

dev.katsute.mal4j.AccessToken

public final class AccessToken
extends Object

Represents an access token.

Since:

1.0.0

Version:

2.7.0

Author:

Katsute

See Also:

• MyAnimeListAuthenticator(Authorization)
• MyAnimeListAuthenticator(Authorization, AccessToken)

Constructor Summary

Constructors

Constructor	Description
AccessToken(String access_token)	Creates an access token from a token.
AccessToken(String access_token, String refresh_token)	Creates an access token from a token and refresh token.
AccessToken(String access_token, String refresh_token, long expiry_in_seconds)	Creates an access token with expiry from a token and refresh token.

Method Summary

Modifier and Type	Method	Description
final Date	getExpiry()	Returns expiry date.
final long	getExpiryEpochSeconds()	Returns expiry date as seconds since epoch.
final String	getRefreshToken()	Returns the refresh token or null.
final long	getTimeUntilExpires()	Returns how long until the token expires in seconds.
final String	getToken()	Returns token with token type.
final boolean	isExpired()	Returns if the token used is expired.
final String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

AccessToken

public AccessToken(String access_token)

Creates an access token from a token.

Parameters:

access_token - access token

Since:

2.7.0

See Also:

• AccessToken(String, String)
• AccessToken(String, String, long)

AccessToken

public AccessToken(String access_token,
 String refresh_token)

Creates an access token from a token and refresh token.

Parameters:

access_token - access token

refresh_token - refresh token

Since:

2.7.0

See Also:

• AccessToken(String)
• AccessToken(String, String, long)

AccessToken

public AccessToken(String access_token,
 String refresh_token,
 long expiry_in_seconds)

Creates an access token with expiry from a token and refresh token.

Parameters:

access_token - access token

refresh_token - refresh token

expiry_in_seconds - when the token expires as seconds since EPOCH

Since:

2.7.0

See Also:

• AccessToken(String)
• AccessToken(String, String)

Method Details

getToken

public final String getToken()

Returns token with token type. Ex: 'Bearer oauth2token'

Returns:

token

Since:

1.0.0

getRefreshToken

public final String getRefreshToken()

Returns the refresh token or null.

Returns:

refresh token

Throws:

NullPointerException - if the refresh token is missing

Since:

1.0.0

getExpiry

public final Date getExpiry()

Returns expiry date.

Returns:

expiry date

Throws:

NullPointerException - if the expiry date is missing

Since:

1.0.0

See Also:

• getExpiryEpochSeconds()
• getTimeUntilExpires()

getExpiryEpochSeconds

public final long getExpiryEpochSeconds()

Returns expiry date as seconds since epoch.

Returns:

expiry date

Throws:

NullPointerException - if the expiry date is missing

Since:

2.7.0

See Also:

• getExpiry()
• getTimeUntilExpires()

getTimeUntilExpires

public final long getTimeUntilExpires()

Returns how long until the token expires in seconds.

Returns:

time until expiry

Throws:

NullPointerException - if the expiry date is missing

Since:

1.0.0

See Also:

• getExpiry()
• getExpiryEpochSeconds()
• isExpired()

isExpired

public final boolean isExpired()

Returns if the token used is expired.

Returns:

if the token used is expired

Throws:

NullPointerException - if the expiry date is missing

Since:

1.0.0

See Also:

• getTimeUntilExpires()

toString

public final String toString()

Overrides:

toString in class Object