org.neo4j.server.security.auth

Class BasicAuthManager

java.lang.Object

org.neo4j.server.security.auth.BasicAuthManager

All Implemented Interfaces:

org.neo4j.kernel.api.security.AuthManager, org.neo4j.kernel.lifecycle.Lifecycle, UserManager, UserManagerSupplier

public class BasicAuthManager
extends Object
implements org.neo4j.kernel.api.security.AuthManager, UserManager, UserManagerSupplier

Manages server authentication and authorization.

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

> NOTE: AuthManager will manage the lifecycle of the given UserRepository, so the given UserRepository should not be added to another LifeSupport.

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.kernel.api.security.AuthManager

NO_AUTH

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

INITIAL_USER_NAME

Constructor Summary

Constructors

Constructor and Description
BasicAuthManager(UserRepository userRepository, PasswordPolicy passwordPolicy, AuthenticationStrategy authStrategy, UserRepository initialUserRepository)
BasicAuthManager(UserRepository userRepository, PasswordPolicy passwordPolicy, Clock clock, UserRepository initialUserRepository)

Method Summary

Modifier and Type	Method and Description
boolean	deleteUser(String username)
Set<String>	getAllUsernames()
User	getUser(String username)
UserManager	getUserManager()
UserManager	getUserManager(org.neo4j.kernel.api.security.SecurityContext securityContext)
void	init()
BasicSecurityContext	login(Map<String,Object> authToken)
User	newUser(String username, String initialPassword, boolean requirePasswordChange)
void	setUserPassword(String username, String password, boolean requirePasswordChange)
void	shutdown()
User	silentlyGetUser(String username)
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicAuthManager

public BasicAuthManager(UserRepository userRepository,
                        PasswordPolicy passwordPolicy,
                        AuthenticationStrategy authStrategy,
                        UserRepository initialUserRepository)

BasicAuthManager

public BasicAuthManager(UserRepository userRepository,
                        PasswordPolicy passwordPolicy,
                        Clock clock,
                        UserRepository initialUserRepository)

Method Detail

init

public void init()
          throws Throwable

Specified by:

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

Throws:

Throwable

start

public void start()
           throws Throwable

Specified by:

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

Throws:

Throwable

stop

public void stop()
          throws Throwable

Specified by:

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

Throws:

Throwable

shutdown

public void shutdown()
              throws Throwable

Specified by:

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

Throws:

Throwable

login

public BasicSecurityContext login(Map<String,Object> authToken)
                           throws org.neo4j.kernel.api.security.exception.InvalidAuthTokenException

Specified by:

login in interface org.neo4j.kernel.api.security.AuthManager

Throws:

org.neo4j.kernel.api.security.exception.InvalidAuthTokenException

newUser

public User newUser(String username,
                    String initialPassword,
                    boolean requirePasswordChange)
             throws IOException,
                    org.neo4j.kernel.api.exceptions.InvalidArgumentsException

Specified by:

newUser in interface UserManager

Throws:

IOException

org.neo4j.kernel.api.exceptions.InvalidArgumentsException

deleteUser

public boolean deleteUser(String username)
                   throws IOException,
                          org.neo4j.kernel.api.exceptions.InvalidArgumentsException

Specified by:

deleteUser in interface UserManager

Throws:

IOException

org.neo4j.kernel.api.exceptions.InvalidArgumentsException

getUser

public User getUser(String username)
             throws org.neo4j.kernel.api.exceptions.InvalidArgumentsException

Specified by:

getUser in interface UserManager

Throws:

org.neo4j.kernel.api.exceptions.InvalidArgumentsException

silentlyGetUser

public User silentlyGetUser(String username)

Specified by:

silentlyGetUser in interface UserManager

setUserPassword

public void setUserPassword(String username,
                            String password,
                            boolean requirePasswordChange)
                     throws IOException,
                            org.neo4j.kernel.api.exceptions.InvalidArgumentsException

Specified by:

setUserPassword in interface UserManager

Throws:

IOException

org.neo4j.kernel.api.exceptions.InvalidArgumentsException

getAllUsernames

public Set<String> getAllUsernames()

Specified by:

getAllUsernames in interface UserManager

getUserManager

public UserManager getUserManager(org.neo4j.kernel.api.security.SecurityContext securityContext)

Specified by:

getUserManager in interface UserManagerSupplier

getUserManager

public UserManager getUserManager()

Specified by:

getUserManager in interface UserManagerSupplier