org.neo4j.server.security.auth

Interface AuthManager

All Known Implementing Classes:

BasicAuthManager

public interface AuthManager

An AuthManager is used to do basic authentication and user management.

Field Summary

Fields

Modifier and Type	Field and Description
static AuthManager	NO_AUTH Implementation that does no authentication.

Method Summary

Modifier and Type	Method and Description
AuthenticationResult	authenticate(String username, String password) Authenticate a username and password
boolean	deleteUser(String username) Delete the given user
User	getUser(String username) Retrieves the user with the provided user name.
AuthSubject	login(String username, String password) Log in using the provided username and password
User	newUser(String username, String initialPassword, boolean requirePasswordChange) Create a new user with the provided credentials.
User	setPassword(String username, String password) Set the password of the provided user.

Field Detail

NO_AUTH

static final AuthManager NO_AUTH

Implementation that does no authentication.

Method Detail

authenticate

AuthenticationResult authenticate(String username,
                                  String password)

Authenticate a username and password

Parameters:

username - The name of the user

password - The password of the user

login

AuthSubject login(String username,
                  String password)

Log in using the provided username and password

Parameters:

username - The name of the user

password - The password of the user

Returns:

An AuthSubject representing the newly logged-in user

newUser

User newUser(String username,
             String initialPassword,
             boolean requirePasswordChange)
      throws IOException,
             IllegalCredentialsException

Create a new user with the provided credentials.

Parameters:

username - The name of the user.

initialPassword - The initial password.

requirePasswordChange - Does the user need to change the initial password.

Returns:

A new user with the provided credentials.

Throws:

IOException - If user can't be serialized to disk.

IllegalCredentialsException - If the username is invalid.

deleteUser

boolean deleteUser(String username)
            throws IOException

Delete the given user

Parameters:

username - the name of the user to delete.

Returns:

true is user was deleted otherwise false

Throws:

IOException

getUser

User getUser(String username)

Retrieves the user with the provided user name.

Parameters:

username - The name of the user to retrieve.

Returns:

The stored user with the given user name.

setPassword

User setPassword(String username,
                 String password)
          throws IOException

Set the password of the provided user.

Parameters:

username - The name of the user whose password should be set.

password - The new password for the user.

Returns:

User with updated credentials

Throws:

IOException