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

Methods

Modifier and Type	Method and Description
void	create(User user) Create a user, given that the users token is unique.
User	findByName(String name)
User	findByToken(String token)
boolean	isValidName(String name) Utility for API consumers to tell if #save() will accept a given username
boolean	isValidToken(String token) Utility for API consumers to tell if #save() will accept a given token
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)

findByToken

User findByToken(String token)

create

void create(User user)
            throws IllegalUsernameException,
                   IllegalTokenException,
                   IOException

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

Parameters:

user - the new user object

Throws:

IllegalUsernameException - if the username is not valid

IllegalTokenException - if the users token is invalid or already in use

IOException

update

void update(User existingUser,
          User updatedUser)
            throws IllegalTokenException,
                   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:

IllegalTokenException - if the user token is invalid or already in use

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

IOException

numberOfUsers

int numberOfUsers()

isValidName

boolean isValidName(String name)

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

isValidToken

boolean isValidToken(String token)

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