org.neo4j.server.security.auth

Class BasicAuthManager

java.lang.Object

org.neo4j.kernel.lifecycle.LifecycleAdapter

org.neo4j.server.security.auth.BasicAuthManager

All Implemented Interfaces:

org.neo4j.kernel.lifecycle.Lifecycle, AuthManager

public class BasicAuthManager
extends org.neo4j.kernel.lifecycle.LifecycleAdapter
implements AuthManager

Manages server authentication and authorization.

Through the BasicAuthManager you can create, update and delete users, and authenticate using credentials.

Nested Class Summary

Nested classes/interfaces inherited from interface org.neo4j.kernel.lifecycle.Lifecycle

org.neo4j.kernel.lifecycle.Lifecycle.Delegate

Field Summary

Fields inherited from interface org.neo4j.server.security.auth.AuthManager

NO_AUTH

Constructor Summary

Constructors

Constructor and Description
BasicAuthManager(UserRepository users, AuthenticationStrategy authStrategy)
BasicAuthManager(UserRepository users, AuthenticationStrategy authStrategy, boolean authEnabled)
BasicAuthManager(UserRepository users, Clock clock, boolean authEnabled)

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.
void	setPassword(AuthSubject authSubject, String username, String password)
User	setPassword(String username, String password) Set the password of the provided user.
void	start()

Methods inherited from class org.neo4j.kernel.lifecycle.LifecycleAdapter

init, shutdown, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicAuthManager

public BasicAuthManager(UserRepository users,
                        AuthenticationStrategy authStrategy,
                        boolean authEnabled)

BasicAuthManager

public BasicAuthManager(UserRepository users,
                        AuthenticationStrategy authStrategy)

BasicAuthManager

public BasicAuthManager(UserRepository users,
                        Clock clock,
                        boolean authEnabled)

Method Detail

start

public void start()
           throws Throwable

Specified by:

start in interface org.neo4j.kernel.lifecycle.Lifecycle

Overrides:

start in class org.neo4j.kernel.lifecycle.LifecycleAdapter

Throws:

Throwable

authenticate

public AuthenticationResult authenticate(String username,
                                         String password)

Description copied from interface: AuthManager

Authenticate a username and password

Specified by:

authenticate in interface AuthManager

Parameters:

username - The name of the user

password - The password of the user

login

public AuthSubject login(String username,
                         String password)

Description copied from interface: AuthManager

Log in using the provided username and password

Specified by:

login in interface AuthManager

Parameters:

username - The name of the user

password - The password of the user

Returns:

An AuthSubject representing the newly logged-in user

newUser

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

Description copied from interface: AuthManager

Create a new user with the provided credentials.

Specified by:

newUser in interface AuthManager

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

public boolean deleteUser(String username)
                   throws IOException

Description copied from interface: AuthManager

Delete the given user

Specified by:

deleteUser in interface AuthManager

Parameters:

username - the name of the user to delete.

Returns:

true is user was deleted otherwise false

Throws:

IOException

getUser

public User getUser(String username)

Description copied from interface: AuthManager

Retrieves the user with the provided user name.

Specified by:

getUser in interface AuthManager

Parameters:

username - The name of the user to retrieve.

Returns:

The stored user with the given user name.

setPassword

public void setPassword(AuthSubject authSubject,
                        String username,
                        String password)
                 throws IOException

Throws:

IOException

setPassword

public User setPassword(String username,
                        String password)
                 throws IOException

Description copied from interface: AuthManager

Set the password of the provided user.

Specified by:

setPassword in interface AuthManager

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