org.neo4j.server.security.auth

Interface UserRepository

All Superinterfaces:

org.neo4j.kernel.lifecycle.Lifecycle

All Known Implementing Classes:

AbstractUserRepository, FileUserRepository

public interface UserRepository
extends org.neo4j.kernel.lifecycle.Lifecycle

A component that can store and retrieve users. Implementations must be thread safe.

Nested Class Summary

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

org.neo4j.kernel.lifecycle.Lifecycle.Delegate

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()
ListSnapshot<User>	getPersistedSnapshot() Returns a snapshot of the current persisted user repository
User	getUserByName(String username) Return the user associated with the given username.
int	numberOfUsers()
void	setUsers(ListSnapshot<User> users) 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 interface org.neo4j.kernel.lifecycle.Lifecycle

init, shutdown, start, stop

Method Detail

clear

void clear()

Clears all cached user data.

getUserByName

User getUserByName(String username)

Return the user associated with the given username.

Parameters:

username - the username

Returns:

the associated user, or null if no user exists

create

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

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

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

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

Replaces the users in the repository with the given users.

Parameters:

users - 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

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

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

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

boolean delete(User user)
        throws IOException

Deletes a user.

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

int numberOfUsers()

assertValidUsername

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

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

Parameters:

username - the username to be tested.

Throws:

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

getAllUsernames

Set<String> getAllUsernames()

getPersistedSnapshot

ListSnapshot<User> getPersistedSnapshot()
                                 throws IOException

Returns a snapshot of the current persisted user repository

Returns:

a snapshot of the current persisted user repository

Throws:

IOException