org.broadleafcommerce.openadmin.server.security.service

Interface AdminSecurityService

All Known Implementing Classes:

AdminSecurityServiceImpl

public interface AdminSecurityService

Author:

jfischer

Method Summary

Modifier and Type	Method and Description
AdminUser	changePassword(PasswordChange passwordChange)
GenericResponse	changePassword(java.lang.String username, java.lang.String oldPassword, java.lang.String password, java.lang.String confirmPassword)
void	deleteAdminPermission(AdminPermission permission)
void	deleteAdminRole(AdminRole role)
void	deleteAdminUser(AdminUser user)
boolean	doesOperationExistForCeilingEntity(PermissionType permissionType, java.lang.String ceilingEntityFullyQualifiedName)
boolean	isUserQualifiedForOperationOnCeilingEntity(AdminUser adminUser, PermissionType permissionType, java.lang.String ceilingEntityFullyQualifiedName)
AdminPermission	readAdminPermissionById(java.lang.Long id)
AdminRole	readAdminRoleById(java.lang.Long id)
AdminUser	readAdminUserById(java.lang.Long id)
AdminUser	readAdminUserByUserName(java.lang.String userName)
java.util.List<AdminPermission>	readAllAdminPermissions()
java.util.List<AdminRole>	readAllAdminRoles()
java.util.List<AdminUser>	readAllAdminUsers()
GenericResponse	resetPasswordUsingToken(java.lang.String username, java.lang.String token, java.lang.String password, java.lang.String confirmPassword) Updates the password for the passed in user only if the passed in token is valid for that user.
AdminPermission	saveAdminPermission(AdminPermission permission)
AdminRole	saveAdminRole(AdminRole role)
AdminUser	saveAdminUser(AdminUser user)
GenericResponse	sendForgotUsernameNotification(java.lang.String emailAddress) Looks up the corresponding AdminUser and emails the address on file with the associated username.
GenericResponse	sendResetPasswordNotification(java.lang.String userName) Generates an access token and then emails the user.

Method Detail

readAllAdminUsers

java.util.List<AdminUser> readAllAdminUsers()

readAdminUserById

AdminUser readAdminUserById(java.lang.Long id)

readAdminUserByUserName

AdminUser readAdminUserByUserName(java.lang.String userName)

saveAdminUser

AdminUser saveAdminUser(AdminUser user)

deleteAdminUser

void deleteAdminUser(AdminUser user)

readAllAdminRoles

java.util.List<AdminRole> readAllAdminRoles()

readAdminRoleById

AdminRole readAdminRoleById(java.lang.Long id)

saveAdminRole

AdminRole saveAdminRole(AdminRole role)

deleteAdminRole

void deleteAdminRole(AdminRole role)

readAllAdminPermissions

java.util.List<AdminPermission> readAllAdminPermissions()

readAdminPermissionById

AdminPermission readAdminPermissionById(java.lang.Long id)

saveAdminPermission

AdminPermission saveAdminPermission(AdminPermission permission)

deleteAdminPermission

void deleteAdminPermission(AdminPermission permission)

changePassword

AdminUser changePassword(PasswordChange passwordChange)

isUserQualifiedForOperationOnCeilingEntity

boolean isUserQualifiedForOperationOnCeilingEntity(AdminUser adminUser,
                                                   PermissionType permissionType,
                                                   java.lang.String ceilingEntityFullyQualifiedName)

doesOperationExistForCeilingEntity

boolean doesOperationExistForCeilingEntity(PermissionType permissionType,
                                           java.lang.String ceilingEntityFullyQualifiedName)

sendForgotUsernameNotification

GenericResponse sendForgotUsernameNotification(java.lang.String emailAddress)

Looks up the corresponding AdminUser and emails the address on file with the associated username.

Parameters:

emailAddress -

Returns:

Response can contain errors including (notFound)

sendResetPasswordNotification

GenericResponse sendResetPasswordNotification(java.lang.String userName)

Generates an access token and then emails the user.

Parameters:

userName -

Returns:

Response can contain errors including (invalidEmail, invalidUsername, inactiveUser)

resetPasswordUsingToken

GenericResponse resetPasswordUsingToken(java.lang.String username,
                                        java.lang.String token,
                                        java.lang.String password,
                                        java.lang.String confirmPassword)

Updates the password for the passed in user only if the passed in token is valid for that user.

Parameters:

username - Name of the user

token - Valid reset token

password - new password

Returns:

Response can contain errors including (invalidUsername, inactiveUser, invalidToken, invalidPassword, tokenExpired, passwordMismatch)

changePassword

GenericResponse changePassword(java.lang.String username,
                               java.lang.String oldPassword,
                               java.lang.String password,
                               java.lang.String confirmPassword)