Package org.apache.archiva.redback.rest.services.v2

Class DefaultUserService

java.lang.Object

org.apache.archiva.redback.rest.services.v2.BaseRedbackService

org.apache.archiva.redback.rest.services.v2.DefaultUserService

All Implemented Interfaces:

UserService

@Service("v2.userService#rest")
public class DefaultUserService
extends BaseRedbackService
implements UserService

Field Summary

Fields inherited from class org.apache.archiva.redback.rest.services.v2.BaseRedbackService

DEFAULT_SEARCH_FIELDS, rbacManager, USER_FILTER_MAP, USER_ORDER_MAP, USER_QUERY_HELPER, userManager

Constructor Summary

Constructors

Constructor	Description
DefaultUserService(RBACManager rbacManager, UserManager userManager, SecuritySystem securitySystem)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	changePassword(PasswordChange passwordChange)
javax.ws.rs.core.Response	changePasswordUnauthenticated(String userId, PasswordChange passwordChange)
void	clearRequirePasswordChangeFlag(String userId)
UserInfo	createAdminUser(User adminUser)	will create admin user only if not exists !! if exists will return false
UserInfo	createUser(User user)
void	deleteUser(String userId)
AvailabilityStatus	getAdminStatus()
Collection<Operation>	getCurrentUserOperations()
Collection<Permission>	getCurrentUserPermissions()
List<RoleInfo>	getEffectivelyAssignedRoles(String username)	Returns all roles for a given user id.
Collection<Permission>	getGuestPermissions()
UserInfo	getLoggedInUser()
RoleTree	getRoleTree(String username)
UserInfo	getUser(String userId)
Collection<Operation>	getUserOperations(String userName)
Collection<Permission>	getUserPermissions(String userName)
org.apache.archiva.components.rest.model.PagedResult<UserInfo>	getUsers(String q, Integer offset, Integer limit, List<String> orderBy, String order)
void	lockUser(String userId)
PingResult	ping()
RegistrationKey	registerUser(String userId, UserRegistrationRequest userRegistrationRequest)
javax.ws.rs.core.Response	removeFromCache(String userId)
javax.ws.rs.core.Response	resetPassword(String userId)	Asks for a password reset of the given User.
void	setRequirePasswordChangeFlag(String userId)
void	unlockUser(String userId)
UserInfo	updateMe(SelfUserData user)	Update only the current logged in user and this fields: fullname, email, password.
UserInfo	updateUser(String userId, User user)
void	validateCredentialsLoose(User user)
void	validateCredentialsStrict(User user)
VerificationStatus	validateUserRegistration(String userId, String key)

Methods inherited from class org.apache.archiva.redback.rest.services.v2.BaseRedbackService

getAssignedRedbackUsers, getAssignedRedbackUsersRecursive, getAssignedUsersRecursive, getChildRoles, getParentRoles, getRedbackUser, getRestUser, getRoleInfo, getRoleInfoOptional, getUserInfoPagedResult, isAscending

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultUserService

@Inject
public DefaultUserService(@Named("rbacManager#default")
                          RBACManager rbacManager,
                          @Named("userManager#default")
                          UserManager userManager,
                          SecuritySystem securitySystem)

Method Detail

createUser

public UserInfo createUser(User user)
                    throws RedbackServiceException

Specified by:

createUser in interface UserService

Throws:

RedbackServiceException

deleteUser

public void deleteUser(String userId)
                throws RedbackServiceException

Specified by:

deleteUser in interface UserService

Throws:

RedbackServiceException

getUser

public UserInfo getUser(String userId)
                 throws RedbackServiceException

Specified by:

getUser in interface UserService

Throws:

RedbackServiceException

getUsers

public org.apache.archiva.components.rest.model.PagedResult<UserInfo> getUsers(String q,
                                                                               Integer offset,
                                                                               Integer limit,
                                                                               List<String> orderBy,
                                                                               String order)
                                                                        throws RedbackServiceException

Specified by:

getUsers in interface UserService

Throws:

RedbackServiceException

updateMe

public UserInfo updateMe(SelfUserData user)
                  throws RedbackServiceException

Description copied from interface: UserService

Update only the current logged in user and this fields: fullname, email, password. The service verifies the current logged user with the one passed in the method

Specified by:

updateMe in interface UserService

Returns:

the user info object

Throws:

RedbackServiceException

getLoggedInUser

public UserInfo getLoggedInUser()
                         throws RedbackServiceException

Specified by:

getLoggedInUser in interface UserService

Throws:

RedbackServiceException

updateUser

public UserInfo updateUser(String userId,
                           User user)
                    throws RedbackServiceException

Specified by:

updateUser in interface UserService

Throws:

RedbackServiceException

removeFromCache

public javax.ws.rs.core.Response removeFromCache(String userId)
                                          throws RedbackServiceException

Specified by:

removeFromCache in interface UserService

Throws:

RedbackServiceException

ping

public PingResult ping()
                throws RedbackServiceException

Specified by:

ping in interface UserService

Throws:

RedbackServiceException

createAdminUser

public UserInfo createAdminUser(User adminUser)
                         throws RedbackServiceException

Description copied from interface: UserService

will create admin user only if not exists !! if exists will return false

Specified by:

createAdminUser in interface UserService

Throws:

RedbackServiceException

getAdminStatus

public AvailabilityStatus getAdminStatus()
                                  throws RedbackServiceException

Specified by:

getAdminStatus in interface UserService

Throws:

RedbackServiceException

resetPassword

public javax.ws.rs.core.Response resetPassword(String userId)
                                        throws RedbackServiceException

Description copied from interface: UserService

Asks for a password reset of the given User. Normally this results in a password reset email sent to the stored email address for the given user.

Specified by:

resetPassword in interface UserService

Throws:

RedbackServiceException

registerUser

public RegistrationKey registerUser(String userId,
                                    UserRegistrationRequest userRegistrationRequest)
                             throws RedbackServiceException

Specified by:

registerUser in interface UserService

Returns:

the registration key

Throws:

RedbackServiceException

getCurrentUserPermissions

public Collection<Permission> getCurrentUserPermissions()
                                                 throws RedbackServiceException

Specified by:

getCurrentUserPermissions in interface UserService

Returns:

the current logged user permissions, if no logged user guest permissions are returned

Throws:

RedbackServiceException

getCurrentUserOperations

public Collection<Operation> getCurrentUserOperations()
                                               throws RedbackServiceException

Specified by:

getCurrentUserOperations in interface UserService

Returns:

the current logged user operations, if no logged user guest operations are returned

Throws:

RedbackServiceException

validateUserRegistration

public VerificationStatus validateUserRegistration(String userId,
                                                   String key)
                                            throws RedbackServiceException

Specified by:

validateUserRegistration in interface UserService

Throws:

RedbackServiceException

getEffectivelyAssignedRoles

public List<RoleInfo> getEffectivelyAssignedRoles(String username)
                                           throws RedbackServiceException

Description copied from interface: UserService

Returns all roles for a given user id. Recurses all child roles.

Specified by:

getEffectivelyAssignedRoles in interface UserService

Throws:

RedbackServiceException

getRoleTree

public RoleTree getRoleTree(String username)
                     throws RedbackServiceException

Specified by:

getRoleTree in interface UserService

Throws:

RedbackServiceException

changePasswordUnauthenticated

public javax.ws.rs.core.Response changePasswordUnauthenticated(String userId,
                                                               PasswordChange passwordChange)
                                                        throws RedbackServiceException

Specified by:

changePasswordUnauthenticated in interface UserService

Throws:

RedbackServiceException

changePassword

public javax.ws.rs.core.Response changePassword(PasswordChange passwordChange)
                                         throws RedbackServiceException

Specified by:

changePassword in interface UserService

Throws:

RedbackServiceException

getUserOperations

public Collection<Operation> getUserOperations(String userName)
                                        throws RedbackServiceException

Specified by:

getUserOperations in interface UserService

Throws:

RedbackServiceException

getUserPermissions

public Collection<Permission> getUserPermissions(String userName)
                                          throws RedbackServiceException

Specified by:

getUserPermissions in interface UserService

Throws:

RedbackServiceException

getGuestPermissions

public Collection<Permission> getGuestPermissions()
                                           throws RedbackServiceException

Specified by:

getGuestPermissions in interface UserService

Throws:

RedbackServiceException

validateCredentialsLoose

public void validateCredentialsLoose(User user)
                              throws RedbackServiceException

Throws:

RedbackServiceException

validateCredentialsStrict

public void validateCredentialsStrict(User user)
                               throws RedbackServiceException

Throws:

RedbackServiceException

unlockUser

public void unlockUser(String userId)
                throws RedbackServiceException

Specified by:

unlockUser in interface UserService

Throws:

RedbackServiceException

lockUser

public void lockUser(String userId)
              throws RedbackServiceException

Specified by:

lockUser in interface UserService

Throws:

RedbackServiceException

setRequirePasswordChangeFlag

public void setRequirePasswordChangeFlag(String userId)
                                  throws RedbackServiceException

Specified by:

setRequirePasswordChangeFlag in interface UserService

Throws:

RedbackServiceException

clearRequirePasswordChangeFlag

public void clearRequirePasswordChangeFlag(String userId)
                                    throws RedbackServiceException

Specified by:

clearRequirePasswordChangeFlag in interface UserService

Throws:

RedbackServiceException