org.outerj.daisy.repository.commonimpl.user
Interface UserManagementStrategy

public interface UserManagementStrategy

Allows to customise the behaviour of the abstract implementation classes of the repository User Management API.

For (important) general information about this and other strategy interfaces, see also DocumentStrategy.

Method Summary

void	deleteRole(long roleId, AuthenticatedUser requestingUser) deletes a role from the system
void	deleteUser(long userId, AuthenticatedUser requestingUser) deletes the user with given userID from the system
org.outerj.daisy.repository.user.AuthenticationSchemeInfos	getAuthenticationSchemes(AuthenticatedUser requestingUser)
RoleImpl	getRole(long roleId, AuthenticatedUser user)
RoleImpl	getRole(java.lang.String roleName, AuthenticatedUser requestingUser)
UserImpl	getUser(long userId, AuthenticatedUser user)
UserImpl	getUser(java.lang.String login, AuthenticatedUser requestingUser)
long[]	getUserIds(AuthenticatedUser requestingUser) Returns the IDs of all users in the system.
UsersImpl	getUsersByEmail(java.lang.String email, AuthenticatedUser requestingUser)
org.outerj.daisy.repository.user.Roles	loadRoles(AuthenticatedUser requestingUser) returns all the roles in the system
org.outerj.daisy.repository.user.Users	loadUsers(AuthenticatedUser requestingUser) returns all the Users in the system
void	store(RoleImpl role) stores the specified RoleImpl to the data store
void	store(UserImpl user) stores the specified UserImpl to the data store

Method Detail

loadUsers

public org.outerj.daisy.repository.user.Users loadUsers(AuthenticatedUser requestingUser)
                                                 throws org.outerj.daisy.repository.RepositoryException

returns all the Users in the system

Throws:

org.outerj.daisy.repository.RepositoryException

getUserIds

public long[] getUserIds(AuthenticatedUser requestingUser)
                  throws org.outerj.daisy.repository.RepositoryException

Returns the IDs of all users in the system.

Throws:

org.outerj.daisy.repository.RepositoryException

loadRoles

public org.outerj.daisy.repository.user.Roles loadRoles(AuthenticatedUser requestingUser)
                                                 throws org.outerj.daisy.repository.RepositoryException

returns all the roles in the system

Throws:

org.outerj.daisy.repository.RepositoryException

deleteUser

public void deleteUser(long userId,
                       AuthenticatedUser requestingUser)
                throws org.outerj.daisy.repository.RepositoryException

deletes the user with given userID from the system

Parameters:

userId - the data store id of the User to delete

Throws:

org.outerj.daisy.repository.RepositoryException

deleteRole

public void deleteRole(long roleId,
                       AuthenticatedUser requestingUser)
                throws org.outerj.daisy.repository.RepositoryException

deletes a role from the system

Parameters:

roleId - the data store id of the role to delete

Throws:

org.outerj.daisy.repository.RepositoryException

getUser

public UserImpl getUser(java.lang.String login,
                        AuthenticatedUser requestingUser)
                 throws org.outerj.daisy.repository.RepositoryException

Parameters:

login - login of the user object

requestingUser - the authenticated user that requests this object

Returns:

Throws:

org.outerj.daisy.repository.RepositoryException

getRole

public RoleImpl getRole(java.lang.String roleName,
                        AuthenticatedUser requestingUser)
                 throws org.outerj.daisy.repository.RepositoryException

Parameters:

roleName - the name of the role you want to obtain

requestingUser - the authenticated user that requests this object

Returns:

the Role object with the specified roleName

Throws:

org.outerj.daisy.repository.RepositoryException

store

public void store(UserImpl user)
           throws org.outerj.daisy.repository.RepositoryException

stores the specified UserImpl to the data store

Parameters:

user - the UserImpl object to persist

Throws:

org.outerj.daisy.repository.RepositoryException

store

public void store(RoleImpl role)
           throws org.outerj.daisy.repository.RepositoryException

stores the specified RoleImpl to the data store

Parameters:

role - the RoleImpl object to persist

Throws:

org.outerj.daisy.repository.RepositoryException

getUser

public UserImpl getUser(long userId,
                        AuthenticatedUser user)
                 throws org.outerj.daisy.repository.RepositoryException

Parameters:

userId - the data stoe id of the user object to fetch

user - the authenticated user that requests this object

Returns:

Throws:

org.outerj.daisy.repository.RepositoryException

getRole

public RoleImpl getRole(long roleId,
                        AuthenticatedUser user)
                 throws org.outerj.daisy.repository.RepositoryException

Parameters:

roleId - the data store id of the role object to fetch

user - the authenticated user that requests this object

Returns:

Throws:

org.outerj.daisy.repository.RepositoryException

getUsersByEmail

public UsersImpl getUsersByEmail(java.lang.String email,
                                 AuthenticatedUser requestingUser)
                          throws org.outerj.daisy.repository.RepositoryException

Throws:

org.outerj.daisy.repository.RepositoryException

getAuthenticationSchemes

public org.outerj.daisy.repository.user.AuthenticationSchemeInfos getAuthenticationSchemes(AuthenticatedUser requestingUser)
                                                                                    throws org.outerj.daisy.repository.RepositoryException

Throws:

org.outerj.daisy.repository.RepositoryException