org.neo4j.server.security.auth

Class FileUserRepository

java.lang.Object

org.neo4j.kernel.lifecycle.LifecycleAdapter

org.neo4j.server.security.auth.FileUserRepository

All Implemented Interfaces:

org.neo4j.kernel.lifecycle.Lifecycle, UserRepository

public class FileUserRepository
extends org.neo4j.kernel.lifecycle.LifecycleAdapter
implements UserRepository

Stores user auth data. In memory, but backed by persistent storage so changes to this repository will survive JVM restarts and crashes.

Constructor Summary

Constructors

Constructor and Description
FileUserRepository(org.neo4j.io.fs.FileSystemAbstraction fs, File file)

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 name)
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	start()
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, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

FileUserRepository

public FileUserRepository(org.neo4j.io.fs.FileSystemAbstraction fs,
                  File file)

Method Detail

findByName

public User findByName(String name)

Specified by:

findByName in interface UserRepository

findByToken

public User findByToken(String name)

Specified by:

findByToken in interface UserRepository

start

public void start()
           throws Throwable

Specified by:

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

Overrides:

start in class org.neo4j.kernel.lifecycle.LifecycleAdapter

Throws:

Throwable

create

public void create(User user)
            throws IllegalUsernameException,
                   IllegalTokenException,
                   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:

IllegalUsernameException - if the username is not valid

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

IOException

update

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

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:

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

public int numberOfUsers()

Specified by:

numberOfUsers in interface UserRepository

isValidName

public boolean isValidName(String name)

Description copied from interface: UserRepository

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

Specified by:

isValidName in interface UserRepository

isValidToken

public boolean isValidToken(String token)

Description copied from interface: UserRepository

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

Specified by:

isValidToken in interface UserRepository