Package com.nickuc.login.api

Interface nLoginAPI

public interface nLoginAPI

nLogin API interface.

Please have a look at the ImplementationType enum to understand the limitations of the API depending on the implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	nLoginAPI.nLoginInternal	Interface used for internal nLogin calls.

Method Summary

Modifier and Type	Method	Description
boolean	changePassword(Identity identity, String newPassword)	Changes a player's password.
default boolean	changePassword(String playerName, String newPassword)	Deprecated. Use changePassword(Identity, String) instead.
boolean	comparePassword(AccountData account, String plainPassword)	Checks that the password you provided is valid.
default boolean	comparePassword(String playerName, String plainPassword)	Deprecated. Use comparePassword(AccountData, String) instead.
default boolean	forceLogin(Identity identity)	Forces a player's login.
boolean	forceLogin(Identity identity, boolean showMessages)	Forces a player's login.
default boolean	forceLogin(String playerName)	Deprecated. Use forceLogin(Identity) instead.
default boolean	forceLogin(String playerName, boolean showMessages)	Deprecated. Use forceLogin(Identity, boolean) instead.
Optional<AccountData>	getAccount(Identity identity)	Returns a player's account.
long	getAccountCount()	Returns the count of all accounts stored in the database.
Iterator<AccountData>	getAccounts()	Returns all accounts from nLogin.
List<AccountData>	getAccountsByIp(String ip)	Returns all nLogin accounts by IP.
default String	getAddress(String playerName)	Deprecated. Use getAccount(Identity) instead.
static nLoginAPI	getApi()	Returns the nLogin api.
int	getApiVersion()	Returns the version of the api.
DatabaseType	getDatabaseType()	Returns the type of database being used.
default String	getDiscord(String playerName)	Deprecated. Use getAccount(Identity) instead.
default String	getEmail(String playerName)	Deprecated. Use getAccount(Identity) instead.
default String	getHashedPassword(String playerName)	Deprecated. Use getAccount(Identity) instead.
ImplementationType	getImplementationType()	Returns the type of implementation used.
default String	getLanguage(String playerName)	Deprecated. Use getAccount(Identity) instead.
default Instant	getLastLogin(String playerName)	Deprecated. Use getAccount(Identity) instead.
default long	getLastLoginUnix(String playerName)	Deprecated. Use getAccount(Identity) instead.
default String	getRealName(String playerName)	Deprecated. Use getAccount(Identity) instead.
default Instant	getRegisterDate(String playerName)	Deprecated. Use getAccount(Identity) instead.
default long	getRegisterDateUnix(String playerName)	Deprecated. Use getAccount(Identity) instead.
int	getRemainingSeconds(Identity identity)	Returns the remaining seconds to authenticate.
default int	getRemainingSeconds(String playerName)	Deprecated. Use getRemainingSeconds(Identity) instead.
Optional<Location>	getSpawnLocation(SpawnType type)	Returns the location of a spawn.
String	getVersion()	Returns the version of the plugin.
default boolean	hasDiscord(String playerName)	Deprecated. Use getAccount(Identity) instead.
default boolean	hasEmail(String playerName)	Deprecated. Use getAccount(Identity) instead.
nLoginAPI.nLoginInternal	internal()	Returns the nLogin internal api.
boolean	isAuthenticated(Identity identity)	Checks if a player is logged in.
boolean	isAuthenticated(String knownName)	Checks if a player is logged in.
boolean	isAvailable()	It checks if the api is ready to be used.
default boolean	isBedrock(String playerName)	Deprecated. Use getAccount(Identity) instead.
default boolean	isPremium(String playerName)	Deprecated. Use getAccount(Identity) instead.
default boolean	isRegistered(String playerName)	Deprecated. Use getAccount(Identity) instead.
default boolean	performRegister(Identity identity, String plainPassword)	Register a player.
boolean	performRegister(Identity identity, String plainPassword, String ip)	Register a player.
default boolean	performRegister(String playerName, String plainPassword)	Deprecated. Use performRegister(Identity, String) instead.
default boolean	performRegister(String playerName, String plainPassword, String ip)	Deprecated. Use performRegister(Identity, String, String) instead.
boolean	performUnregister(Identity identity)	Unregister a player.
default boolean	performUnregister(String playerName)	Deprecated. Use performUnregister(Identity) instead.
void	requestLogin(Identity identity, Object plugin)	Sends a login request.
default void	requestLogin(String playerName, Object plugin)	Deprecated. Use requestLogin(Identity, Object) instead.
boolean	setDiscord(Identity identity, long newAccountId)	Set a discord account for a certain player.
default boolean	setDiscord(String playerName, long newAccountId)	Deprecated. Use setDiscord(Identity, long) instead.
boolean	setEmail(Identity identity, String newEmail)	Set an email account for a certain player.
default boolean	setEmail(String playerName, String newEmail)	Deprecated. Use setEmail(Identity, String) instead.
boolean	setLanguage(Identity identity, String languageCode)	Sets the language for a player.

Method Details

getApi

@Nonnull
static nLoginAPI getApi()

Returns the nLogin api.

Throws:

nLoginNotLoadedException - if the api has not yet been instantiated

isAvailable

boolean isAvailable()

It checks if the api is ready to be used.

Since:

API v1

getVersion

@Nonnull
String getVersion()

Returns the version of the plugin.

Since:

API v1

getApiVersion

int getApiVersion()

Returns the version of the api.

Since:

API v1

getImplementationType

@Nonnull
ImplementationType getImplementationType()

Returns the type of implementation used.

Since:

API v1

getDatabaseType

@ProxyUnsafe
DatabaseType getDatabaseType()

Returns the type of database being used.

Throws:

nLoginNotReadyException - if the plugin is not yet fully loaded.

nLoginRequestUnavailableException - if the implementation type does not support this method at invocation time. @see ImplementationType

Since:

API v1

getSpawnLocation

@ProxyUnsafe
Optional<Location> getSpawnLocation(@Nonnull
 SpawnType type)

Returns the location of a spawn.

Parameters:

type - Spawn type.

Throws:

nLoginNotReadyException - if the plugin is not yet fully loaded.

nLoginRequestUnavailableException - if the implementation type does not support this method at invocation time. @see ImplementationType

Since:

API v3

getAccount

@ProxyUnsafe
Optional<AccountData> getAccount(@Nonnull
 Identity identity)

Returns a player's account. READ ONLY.

Parameters:

identity - Player identity.

Throws:

nLoginNotReadyException - if the plugin is not yet fully loaded.

nLoginRequestUnavailableException - if the implementation type does not support this method at invocation time. @see ImplementationType

Since:

API v3

getAccounts

@ProxyUnsupported
@Nonnull
Iterator<AccountData> getAccounts()

Returns all accounts from nLogin.

This method IS NOT AVAILABLE for PROXY implementations.

Throws:

nLoginNotReadyException - if the plugin is not yet fully loaded.

nLoginRequestUnsupportedException - if the implementation type does not support this method.

Since:

API v1

See Also:

• ImplementationType

getAccountCount

@ProxyUnsafe
long getAccountCount()

Returns the count of all accounts stored in the database.

Throws:

nLoginNotReadyException - if the plugin is not yet fully loaded.

nLoginRequestUnavailableException - if the implementation type does not support this method at invocation time. @see ImplementationType

Since:

API v11

getAccountsByIp

@ProxyUnsafe
@Nonnull
List<AccountData> getAccountsByIp(@Nonnull
 String ip)

Returns all nLogin accounts by IP.

Throws:

nLoginNotReadyException - if the plugin is not yet fully loaded.

nLoginRequestUnavailableException - if the implementation type does not support this method at invocation time. @see ImplementationType

Since:

API v1

isAuthenticated

boolean isAuthenticated(@Nonnull
 Identity identity)

Checks if a player is logged in.

Parameters:

identity - Player identity.

Returns:

true if the player is authenticated.

Throws:

nLoginNotReadyException - if the plugin is not yet fully loaded.

Since:

API v1

isAuthenticated

boolean isAuthenticated(@Nonnull
 String knownName)

Checks if a player is logged in.

Parameters:

knownName - Player name in server.

Returns:

true if the player is authenticated.

Throws:

nLoginNotReadyException - if the plugin is not yet fully loaded.

Since:

API v1

getRemainingSeconds

@ProxyUnsafe
int getRemainingSeconds(@Nonnull
 Identity identity)

Returns the remaining seconds to authenticate.

Parameters:

identity - Player identity.

Throws:

nLoginNotReadyException - if the plugin is not yet fully loaded.

nLoginRequestUnavailableException - if the implementation type does not support this method at invocation time. @see ImplementationType

Since:

API v3

getRemainingSeconds

@ProxyUnsafe
default int getRemainingSeconds(@Nonnull
 String playerName)

Deprecated.

Use getRemainingSeconds(Identity) instead.

getRealName

@ProxyUnsafe
@Nullable
default String getRealName(@Nonnull
 String playerName)

Deprecated.

Use getAccount(Identity) instead.

getHashedPassword

@ProxyUnsafe
@Nullable
default String getHashedPassword(@Nonnull
 String playerName)

Deprecated.

Use getAccount(Identity) instead.

getAddress

@ProxyUnsafe
@Nullable
default String getAddress(@Nonnull
 String playerName)

Deprecated.

Use getAccount(Identity) instead.

getLastLogin

@ProxyUnsafe
@Nonnull
default Instant getLastLogin(@Nonnull
 String playerName)

Deprecated.

Use getAccount(Identity) instead.

getLastLoginUnix

@ProxyUnsafe
default long getLastLoginUnix(@Nonnull
 String playerName)

Deprecated.

Use getAccount(Identity) instead.

getRegisterDate

@ProxyUnsafe
@Nonnull
default Instant getRegisterDate(@Nonnull
 String playerName)

Deprecated.

Use getAccount(Identity) instead.

getRegisterDateUnix

@ProxyUnsafe
default long getRegisterDateUnix(@Nonnull
 String playerName)

Deprecated.

Use getAccount(Identity) instead.

getEmail

@ProxyUnsafe
@Nullable
default String getEmail(@Nonnull
 String playerName)

Deprecated.

Use getAccount(Identity) instead.

getDiscord

@ProxyUnsafe
@Nullable
default String getDiscord(@Nonnull
 String playerName)

Deprecated.

Use getAccount(Identity) instead.

hasEmail

@ProxyUnsafe
default boolean hasEmail(@Nonnull
 String playerName)

Deprecated.

Use getAccount(Identity) instead.

hasDiscord

@ProxyUnsafe
default boolean hasDiscord(@Nonnull
 String playerName)

Deprecated.

Use getAccount(Identity) instead.

getLanguage

@ProxyUnsafe
@Nonnull
default String getLanguage(@Nonnull
 String playerName)

Deprecated.

Use getAccount(Identity) instead.

comparePassword

@ProxyUnsafe
boolean comparePassword(AccountData account,
 String plainPassword)

Checks that the password you provided is valid.

Parameters:

account - Account data.

plainPassword - Plain password to be compared (not hashed).

Returns:

true if the password is valid.

Throws:

nLoginNotReadyException - if the plugin is not yet fully loaded.

nLoginRequestUnavailableException - if the implementation type does not support this method at invocation time. @see ImplementationType

Since:

API v3

comparePassword

@ProxyUnsafe
default boolean comparePassword(String playerName,
 String plainPassword)

Deprecated.

Use comparePassword(AccountData, String) instead.

isRegistered

@ProxyUnsafe
default boolean isRegistered(@Nonnull
 String playerName)

Deprecated.

Use getAccount(Identity) instead.

isPremium

@ProxyUnsafe
default boolean isPremium(@Nonnull
 String playerName)

Deprecated.

Use getAccount(Identity) instead.

isBedrock

@ProxyUnsafe
default boolean isBedrock(@Nonnull
 String playerName)

Deprecated.

Use getAccount(Identity) instead.

requestLogin

@ProxyUnsupported
void requestLogin(@Nonnull
 Identity identity,
 @Nonnull
 Object plugin)

Sends a login request. Note: It is not sent if a login request is already in progress.

This method IS NOT AVAILABLE for PROXY implementations.

Parameters:

identity - Player identity.

plugin - Plugin instance.

Throws:

nLoginNotReadyException - if the plugin is not yet fully loaded.

nLoginRequestUnsupportedException - if the implementation type does not support this method.

Since:

API v1

See Also:

• ImplementationType

requestLogin

@ProxyUnsupported
default void requestLogin(@Nonnull
 String playerName,
 @Nonnull
 Object plugin)

Deprecated.

Use requestLogin(Identity, Object) instead.

performRegister

@ProxyUnsafe
default boolean performRegister(@Nonnull
 Identity identity,
 @Nonnull
 String plainPassword)

Register a player.

Parameters:

identity - Player identity.

plainPassword - Plain password to be used (not hashed).

Returns:

true if the registration was successful. If the user is already registered or during a database failure, returns false.

Throws:

nLoginNotReadyException - if the plugin is not yet fully loaded.

nLoginRequestUnavailableException - if the implementation type does not support this method at invocation time. @see ImplementationType

Since:

API v1

performRegister

@ProxyUnsafe
boolean performRegister(@Nonnull
 Identity identity,
 @Nonnull
 String plainPassword,
 @Nullable
 String ip)

Register a player.

Parameters:

identity - Player identity.

plainPassword - Plain password to be used (not hashed).

ip - IP address. Can be null.

Returns:

true if the registration was successful. If the user is already registered or during a database failure, returns false.

Throws:

nLoginNotReadyException - if the plugin is not yet fully loaded.

nLoginRequestUnavailableException - if the implementation type does not support this method at invocation time. @see ImplementationType

Since:

API v1

performRegister

@ProxyUnsafe
default boolean performRegister(@Nonnull
 String playerName,
 @Nonnull
 String plainPassword)

Deprecated.

Use performRegister(Identity, String) instead.

performRegister

@ProxyUnsafe
default boolean performRegister(@Nonnull
 String playerName,
 @Nonnull
 String plainPassword,
 @Nullable
 String ip)

Deprecated.

Use performRegister(Identity, String, String) instead.

performUnregister

@ProxyUnsafe
boolean performUnregister(@Nonnull
 Identity identity)

Unregister a player.

Parameters:

identity - Player identity.

Returns:

true if the operation was successful. If the user is not registered or during a database failure, returns false.

Throws:

nLoginNotReadyException - if the plugin is not yet fully loaded.

nLoginRequestUnavailableException - if the implementation type does not support this method at invocation time. @see ImplementationType

Since:

API v1

performUnregister

@ProxyUnsafe
default boolean performUnregister(@Nonnull
 String playerName)

Deprecated.

Use performUnregister(Identity) instead.

changePassword

@ProxyUnsafe
boolean changePassword(@Nonnull
 Identity identity,
 @Nonnull
 String newPassword)

Changes a player's password.

Parameters:

identity - Player identity.

newPassword - New password (not hashed).

Returns:

true if the operation was successful. If the user is not registered or during a database failure, returns false.

Throws:

nLoginNotReadyException - if the plugin is not yet fully loaded.

nLoginRequestUnavailableException - if the implementation type does not support this method at invocation time. @see ImplementationType

Since:

API v1

changePassword

@ProxyUnsafe
default boolean changePassword(@Nonnull
 String playerName,
 @Nonnull
 String newPassword)

Deprecated.

Use changePassword(Identity, String) instead.

setEmail

@ProxyUnsafe
boolean setEmail(@Nonnull
 Identity identity,
 @Nullable
 String newEmail)

Set an email account for a certain player.

Parameters:

identity - Player identity.

newEmail - Full email.

Returns:

true if the operation was successful. If the user is not registered, returns false.

Throws:

nLoginNotReadyException - if the plugin is not yet fully loaded.

nLoginRequestUnavailableException - if the implementation type does not support this method at invocation time. @see ImplementationType

Since:

API v2

setEmail

@ProxyUnsafe
default boolean setEmail(@Nonnull
 String playerName,
 @Nullable
 String newEmail)

Deprecated.

Use setEmail(Identity, String) instead.

setDiscord

@ProxyUnsafe
boolean setDiscord(@Nonnull
 Identity identity,
 long newAccountId)

Set a discord account for a certain player.

Parameters:

identity - Player identity.

newAccountId - Account id.

Returns:

true if the operation was successful. If the user is not registered, returns false.

Throws:

nLoginNotReadyException - if the plugin is not yet fully loaded.

nLoginRequestUnavailableException - if the implementation type does not support this method at invocation time. @see ImplementationType

Since:

API v2

setDiscord

@ProxyUnsafe
default boolean setDiscord(@Nonnull
 String playerName,
 long newAccountId)

Deprecated.

Use setDiscord(Identity, long) instead.

setLanguage

@ProxyUnsafe
boolean setLanguage(@Nonnull
 Identity identity,
 @Nullable
 String languageCode)

Sets the language for a player.

Parameters:

identity - Player identity.

languageCode - The language code (2 letters).

Returns:

true if the operation was successful. If the user is not registered, returns false.

Throws:

nLoginNotReadyException - if the plugin is not yet fully loaded.

nLoginRequestUnavailableException - if the implementation type does not support this method at invocation time. @see ImplementationType

Since:

API v9

forceLogin

@ProxyUnsafe
default boolean forceLogin(@Nonnull
 Identity identity)

Forces a player's login.

Parameters:

identity - Player identity.

Returns:

true if the operation was successful. If the user is not registered, returns false.

Throws:

nLoginNotReadyException - if the plugin is not yet fully loaded.

nLoginRequestUnavailableException - if the implementation type does not support this method at invocation time. @see ImplementationType

Since:

API v1

forceLogin

@ProxyUnsafe
boolean forceLogin(@Nonnull
 Identity identity,
 boolean showMessages)

Forces a player's login.

Parameters:

identity - Player identity.

showMessages - Sends login messages if the supplied value is true.

Returns:

true if the operation was successful. If the user is not registered, returns false.

Throws:

nLoginNotReadyException - if the plugin is not yet fully loaded.

nLoginRequestUnavailableException - if the implementation type does not support this method at invocation time. @see ImplementationType

Since:

API v1

forceLogin

@ProxyUnsafe
default boolean forceLogin(@Nonnull
 String playerName)

Deprecated.

Use forceLogin(Identity) instead.

forceLogin

@ProxyUnsafe
default boolean forceLogin(@Nonnull
 String playerName,
 boolean showMessages)

Deprecated.

Use forceLogin(Identity, boolean) instead.

internal

@Nonnull
nLoginAPI.nLoginInternal internal()

Returns the nLogin internal api.