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 and Description
static interface	nLoginAPI.nLoginInternal Interface used for internal nLogin calls.

Method Summary

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

Method Detail

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
java.lang.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
java.util.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
java.util.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
java.util.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

getAccountsByIp

@ProxyUnsafe
 @Nonnull
java.util.List<AccountData> getAccountsByIp(@Nonnull
                                                                   java.lang.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
                        java.lang.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
                                             java.lang.String playerName)

Deprecated. Use getRemainingSeconds(Identity) instead.

getRealName

@ProxyUnsafe
 @Nullable
default java.lang.String getRealName(@Nonnull
                                                             java.lang.String playerName)

Deprecated. Use getAccount(Identity) instead.

getHashedPassword

@ProxyUnsafe
 @Nullable
default java.lang.String getHashedPassword(@Nonnull
                                                                   java.lang.String playerName)

Deprecated. Use getAccount(Identity) instead.

getAddress

@ProxyUnsafe
 @Nullable
default java.lang.String getAddress(@Nonnull
                                                            java.lang.String playerName)

Deprecated. Use getAccount(Identity) instead.

getLastLogin

@ProxyUnsafe
 @Nonnull
default java.time.Instant getLastLogin(@Nonnull
                                                              java.lang.String playerName)

Deprecated. Use getAccount(Identity) instead.

getLastLoginUnix

@ProxyUnsafe
default long getLastLoginUnix(@Nonnull
                                           java.lang.String playerName)

Deprecated. Use getAccount(Identity) instead.

getRegisterDate

@ProxyUnsafe
 @Nonnull
default java.time.Instant getRegisterDate(@Nonnull
                                                                 java.lang.String playerName)

Deprecated. Use getAccount(Identity) instead.

getRegisterDateUnix

@ProxyUnsafe
default long getRegisterDateUnix(@Nonnull
                                              java.lang.String playerName)

Deprecated. Use getAccount(Identity) instead.

getEmail

@ProxyUnsafe
 @Nullable
default java.lang.String getEmail(@Nonnull
                                                          java.lang.String playerName)

Deprecated. Use getAccount(Identity) instead.

getDiscord

@ProxyUnsafe
 @Nullable
default java.lang.String getDiscord(@Nonnull
                                                            java.lang.String playerName)

Deprecated. Use getAccount(Identity) instead.

hasEmail

@ProxyUnsafe
default boolean hasEmail(@Nonnull
                                      java.lang.String playerName)

Deprecated. Use getAccount(Identity) instead.

hasDiscord

@ProxyUnsafe
default boolean hasDiscord(@Nonnull
                                        java.lang.String playerName)

Deprecated. Use getAccount(Identity) instead.

getLanguage

@ProxyUnsafe
 @Nonnull
default java.lang.String getLanguage(@Nonnull
                                                            java.lang.String playerName)

Deprecated. Use getAccount(Identity) instead.

comparePassword

boolean comparePassword(AccountData account,
                        java.lang.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(java.lang.String playerName,
                                             java.lang.String plainPassword)

Deprecated. Use comparePassword(AccountData, String) instead.

isRegistered

@ProxyUnsafe
default boolean isRegistered(@Nonnull
                                          java.lang.String playerName)

Deprecated. Use getAccount(Identity) instead.

isPremium

@ProxyUnsafe
default boolean isPremium(@Nonnull
                                       java.lang.String playerName)

Deprecated. Use getAccount(Identity) instead.

isBedrock

@ProxyUnsafe
default boolean isBedrock(@Nonnull
                                       java.lang.String playerName)

Deprecated. Use getAccount(Identity) instead.

requestLogin

@ProxyUnsupported
void requestLogin(@Nonnull
                                    Identity identity,
                                    @Nonnull
                                    java.lang.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
                                            java.lang.String playerName,
                                            @Nonnull
                                            java.lang.Object plugin)

Deprecated. Use requestLogin(Identity, Object) instead.

performRegister

@ProxyUnsafe
default boolean performRegister(@Nonnull
                                             Identity identity,
                                             @Nonnull
                                             java.lang.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
                                     java.lang.String plainPassword,
                                     @Nullable
                                     java.lang.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
                                             java.lang.String playerName,
                                             @Nonnull
                                             java.lang.String plainPassword)

Deprecated. Use performRegister(Identity, String) instead.

performRegister

@ProxyUnsafe
default boolean performRegister(@Nonnull
                                             java.lang.String playerName,
                                             @Nonnull
                                             java.lang.String plainPassword,
                                             @Nullable
                                             java.lang.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
                                               java.lang.String playerName)

Deprecated. Use performUnregister(Identity) instead.

changePassword

@ProxyUnsafe
boolean changePassword(@Nonnull
                                    Identity identity,
                                    @Nonnull
                                    java.lang.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
                                            java.lang.String playerName,
                                            @Nonnull
                                            java.lang.String newPassword)

Deprecated. Use changePassword(Identity, String) instead.

setEmail

@ProxyUnsafe
boolean setEmail(@Nonnull
                              Identity identity,
                              @Nullable
                              java.lang.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
                                      java.lang.String playerName,
                                      @Nullable
                                      java.lang.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
                                        java.lang.String playerName,
                                        long newAccountId)

Deprecated. Use setDiscord(Identity, long) instead.

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
                                        java.lang.String playerName)

Deprecated. Use forceLogin(Identity) instead.

forceLogin

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

Deprecated. Use forceLogin(Identity, boolean) instead.

internal

@Nonnull
nLoginAPI.nLoginInternal internal()

Returns the nLogin internal api.