org.neo4j.server.security.auth

Interface UserRepository

All Known Implementing Classes:

FileUserRepository

public interface UserRepository

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

Method Summary

Modifier and Type	Method and Description
void	create(User user) Create a user, given that the users token is unique.
boolean	delete(User user) Deletes a user.
User	findByName(String name)
boolean	isValidName(String name) Utility for API consumers to tell if #save() will accept a given username
int	numberOfUsers()
void	update(User existingUser, User updatedUser) Update a user, given that the users token is unique.

Method Detail

findByName

User findByName(String name)

create

void create(User user)
     throws IllegalCredentialsException,
            IOException

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

Parameters:

user - the new user object

Throws:

IllegalCredentialsException - if the username is not valid

IOException

update

void update(User existingUser,
            User updatedUser)
     throws ConcurrentModificationException,
            IOException

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

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

numberOfUsers

int numberOfUsers()

isValidName

boolean isValidName(String name)

Utility for API consumers to tell if #save() will accept a given username