restx.security

Interface UserRepository<U extends RestxPrincipal>

All Known Implementing Classes:

FileBasedUserRepository

public interface UserRepository<U extends RestxPrincipal>

Date: 14/12/13 Time: 14:48

Method Summary

Methods

Modifier and Type	Method and Description
U	defaultAdmin() Returns the default admin to use if none is defined and authentication succeeds.
com.google.common.base.Optional<String>	findCredentialByUserName(String name) Finds a user credentials by userName
com.google.common.base.Optional<U>	findUserByName(String name) Finds a user by name in the repository.
boolean	isAdminDefined() Tells wether a restx admin is defined in this repository.

Method Detail

findUserByName

com.google.common.base.Optional<U> findUserByName(String name)

Finds a user by name in the repository.

Parameters:

name -

Returns:

findCredentialByUserName

com.google.common.base.Optional<String> findCredentialByUserName(String name)

Finds a user credentials by userName

Parameters:

name -

Returns:

isAdminDefined

boolean isAdminDefined()

Tells wether a restx admin is defined in this repository. This allows to access restx admin console even when the user repository is empty or does not contain a restx admin. Returning true will simply bypass the default admin behavior, and thus prevent any connection to the admin console if no restx admin user is actually present in the UserRepository. Note that default admin password check is performed based on a string injected password hash which is not very secured.

Returns:

true is a restx admin is defined in this repo.

defaultAdmin

U defaultAdmin()

Returns the default admin to use if none is defined and authentication succeeds. Note that implementation must return a value even if they always return true on isAdminDefined(), because the default admin user name is checked before isAdminDefined() because in most implementations returning defaultAdmin is less expensive than checking if admin is defined.

Returns:

the default restx admin user. See restx-admin module for details on restx admin.