org.neo4j.server.security.auth

Class AbstractUserRepository

java.lang.Object

org.neo4j.kernel.lifecycle.LifecycleAdapter

org.neo4j.server.security.auth.AbstractUserRepository

All Implemented Interfaces:

org.neo4j.kernel.lifecycle.Lifecycle, UserRepository

Direct Known Subclasses:

FileUserRepository

public abstract class AbstractUserRepository
extends org.neo4j.kernel.lifecycle.LifecycleAdapter
implements UserRepository

Nested Class Summary

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

org.neo4j.kernel.lifecycle.Lifecycle.Delegate

Constructor Summary

Constructors

Constructor and Description
AbstractUserRepository()

Method Summary

Modifier and Type	Method and Description
void	assertValidUsername(String username) Asserts whether the given username is valid or not.
void	clear() Clears all cached user data.
void	create(User user) Create a user, given that the users token is unique.
boolean	delete(User user) Deletes a user.
Set<String>	getAllUsernames()
User	getUserByName(String username) Return the user associated with the given username.
int	numberOfUsers()
void	setUsers(ListSnapshot<User> usersSnapshot) Replaces the users in the repository with the given users.
void	update(User existingUser, User updatedUser) Update a user, given that the users token is unique.

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

init, shutdown, start, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.neo4j.server.security.auth.UserRepository

getPersistedSnapshot

Methods inherited from interface org.neo4j.kernel.lifecycle.Lifecycle

init, shutdown, start, stop

Constructor Detail

AbstractUserRepository

public AbstractUserRepository()

Method Detail

clear

public void clear()

Description copied from interface: UserRepository

Clears all cached user data.

Specified by:

clear in interface UserRepository

getUserByName

public User getUserByName(String username)

Description copied from interface: UserRepository

Return the user associated with the given username.

Specified by:

getUserByName in interface UserRepository

Parameters:

username - the username

Returns:

the associated user, or null if no user exists

create

public void create(User user)
            throws org.neo4j.kernel.api.exceptions.InvalidArgumentsException,
                   IOException

Description copied from interface: UserRepository

Create a user, given that the users token is unique.

Specified by:

create in interface UserRepository

Parameters:

user - the new user object

Throws:

org.neo4j.kernel.api.exceptions.InvalidArgumentsException - if the username is not valid

IOException - if the underlying storage for users fails

setUsers

public void setUsers(ListSnapshot<User> usersSnapshot)
              throws org.neo4j.kernel.api.exceptions.InvalidArgumentsException,
                     IOException

Description copied from interface: UserRepository

Replaces the users in the repository with the given users.

Specified by:

setUsers in interface UserRepository

Parameters:

usersSnapshot - the new users

Throws:

org.neo4j.kernel.api.exceptions.InvalidArgumentsException - if any username is not valid

IOException - if the underlying storage for users fails

update

public void update(User existingUser,
                   User updatedUser)
            throws ConcurrentModificationException,
                   IOException,
                   org.neo4j.kernel.api.exceptions.InvalidArgumentsException

Description copied from interface: UserRepository

Update a user, given that the users token is unique.

Specified by:

update in interface UserRepository

Parameters:

existingUser - the existing user object, which must match the current state in this repository

updatedUser - the updated user object

Throws:

ConcurrentModificationException - if the existingUser does not match the current state in the repository

IOException - if the underlying storage for users fails

org.neo4j.kernel.api.exceptions.InvalidArgumentsException - if the existing and updated users have different names

delete

public boolean delete(User user)
               throws IOException

Description copied from interface: UserRepository

Deletes a user.

Specified by:

delete in interface UserRepository

Parameters:

user - the user to delete

Returns:

true if the user was found and deleted

Throws:

IOException - if the underlying storage for users fails

numberOfUsers

public int numberOfUsers()

Specified by:

numberOfUsers in interface UserRepository

assertValidUsername

public void assertValidUsername(String username)
                         throws org.neo4j.kernel.api.exceptions.InvalidArgumentsException

Description copied from interface: UserRepository

Asserts whether the given username is valid or not. A valid username is non-null, non-empty, and contains only simple ascii characters.

Specified by:

assertValidUsername in interface UserRepository

Parameters:

username - the username to be tested.

Throws:

org.neo4j.kernel.api.exceptions.InvalidArgumentsException - if the username was invalid.

getAllUsernames

public Set<String> getAllUsernames()

Specified by:

getAllUsernames in interface UserRepository