Package crow.game.login.api

Interface UserAuthenticator

All Known Implementing Classes:

SimpleUserAuthenticator

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface UserAuthenticator

The interface for authenticating a user.

Method Summary

Modifier and Type	Method	Description
boolean	authenticateUser(Object userID, String password, Map<String,Object> properties)	Authenticate a user.

Method Details

authenticateUser

boolean authenticateUser(Object userID,
 String password,
 Map<String,Object> properties)
                  throws Exception

Authenticate a user.

Parameters:

userID - The user ID object, usually a string or integer.

password - The password, could be hashed, etc.

properties - An open-ended properties dict, containing details about the client, the password hashing mechanism, anything else implementation specific.

Returns:

true if the authentication passes, false otherwise

Throws:

Exception - on an unexpected error