com.epimorphics.appbase.security

Interface UserStore

All Known Implementing Classes:

BaseUserStore, DBUserStore, MemUserStore

public interface UserStore

Interface abstraction for the store of registered users. The actual user credentials are not stored since we rely on OpenID for that. Stores permissions of the form "{action}:{target}" using the Shiro WildcardPermission syntax but this interface works at the level of strings.

Author:

Dave Reynolds

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTH_USER_ID ID of a pseudo user which stores the global permissions available to anyone logged in

Method Summary

Modifier and Type	Method and Description
void	addPermision(String id, String permission) Record a new permission for this user.
List<UserPermission>	authorizedOn(String target) Return the set of users who have some explicit permission over the given path Only relevant in applications that use action:path structure.
org.apache.shiro.authc.SaltedAuthenticationInfo	checkUser(String id) Test if a user is registered.
String	createCredentials(String id, int minstolive) Create a new random password, set it and return it.
Set<String>	getPermissions(String id) Return all the permissions and rolefor this user
UserInfo	getUser(String id) Return the user info for the given user ID, or null if not found
List<UserInfo>	listUsers(String match) Return the set of users whose name includes the given string
boolean	register(UserInfo user) Register a new user.
void	removeCredentials(String id) Remove the credentials for the user
void	removePermission(String id, String permission) Remove the specific matching permission for this user
void	removePermissionsOn(String id, String target) Remove permissions from this user for the given path.
void	setCredentials(String id, org.apache.shiro.util.ByteSource credentials, int minstolive) Store new credentials for the user
void	setRealm(AppRealm realm) Link this store to a specific authorization realm
void	unregister(String id) Unregister a user, removing them and any permissions from the store

Field Detail

AUTH_USER_ID

static final String AUTH_USER_ID

ID of a pseudo user which stores the global permissions available to anyone logged in

See Also:

Constant Field Values

Method Detail

setRealm

void setRealm(AppRealm realm)

Link this store to a specific authorization realm

register

boolean register(UserInfo user)

Register a new user. Return true if the new registration succeeded, false if the user is already registered.

checkUser

org.apache.shiro.authc.SaltedAuthenticationInfo checkUser(String id)

Test if a user is registered. Returns their user information and credentials if they are or null if not registered. Stored and returned credentials are salt-hashed to make it easy to allow user defined passwords in the future, redundant for generated passwords. If the user has no credentials or they have timed out then the credentials will be null.

Parameters:

id - the openid identifier string authenticated by the user

unregister

void unregister(String id)

Unregister a user, removing them and any permissions from the store

setCredentials

void setCredentials(String id,
                    org.apache.shiro.util.ByteSource credentials,
                    int minstolive)

Store new credentials for the user

Parameters:

id - the openid identifier string authenticated by the user

credentials - the password to store

minstolive - the time-to-livefor the credentials in minutes

createCredentials

String createCredentials(String id,
                         int minstolive)

Create a new random password, set it and return it.

Yes, the return ought to be a char[] to allow for reseting but the use case will be creating string serializations of the key in any case to send it out so the added security of using char[] is zero.

removeCredentials

void removeCredentials(String id)

Remove the credentials for the user

getPermissions

Set<String> getPermissions(String id)

Return all the permissions and rolefor this user

addPermision

void addPermision(String id,
                  String permission)

Record a new permission for this user.

removePermission

void removePermission(String id,
                      String permission)

Remove the specific matching permission for this user

removePermissionsOn

void removePermissionsOn(String id,
                         String target)

Remove permissions from this user for the given path. Only relevant in applications that use action:path structure.

authorizedOn

List<UserPermission> authorizedOn(String target)

Return the set of users who have some explicit permission over the given path Only relevant in applications that use action:path structure.

listUsers

List<UserInfo> listUsers(String match)

Return the set of users whose name includes the given string

getUser

UserInfo getUser(String id)

Return the user info for the given user ID, or null if not found