Uses of Class
com.broadleafcommerce.adminuser.resource.domain.AdminRoleRef

Packages that use AdminRoleRef

Package	Description
com.broadleafcommerce.adminuser.resource.domain
com.broadleafcommerce.adminuser.resource.service.provider
com.broadleafcommerce.adminuser.resource.service.provider.external
com.broadleafcommerce.adminuser.resource.service.validation.support
com.broadleafcommerce.adminuser.user.domain
com.broadleafcommerce.adminuser.user.service
com.broadleafcommerce.adminuser.user.service.hydration

Uses of AdminRoleRef in com.broadleafcommerce.adminuser.resource.domain

Methods in com.broadleafcommerce.adminuser.resource.domain that return AdminRoleRef

Modifier and Type	Method	Description
AdminRoleRef	AdminRestrictedRole.getRole()	Represents the Role that is being restricted.
AdminRoleRef	AdminRole.toRef()	Deprecated.

Methods in com.broadleafcommerce.adminuser.resource.domain that return types with arguments of type AdminRoleRef

Modifier and Type	Method	Description
Set<AdminRoleRef>	AdminUser.getRestrictedRolesRoleRefs()	Gets the AdminRoleRef from AdminUser.restrictedRoles.
Set<AdminRoleRef>	AdminUser.getRoles()	The roles that this user is assigned.

Methods in com.broadleafcommerce.adminuser.resource.domain with parameters of type AdminRoleRef

Modifier and Type	Method	Description
void	AdminRestrictedRole.setRole(AdminRoleRef role)	Represents the Role that is being restricted.

Method parameters in com.broadleafcommerce.adminuser.resource.domain with type arguments of type AdminRoleRef

Modifier and Type	Method	Description
void	AdminUser.setRoles(Set<AdminRoleRef> roles)	The roles that this user is assigned.

Uses of AdminRoleRef in com.broadleafcommerce.adminuser.resource.service.provider

Methods in com.broadleafcommerce.adminuser.resource.service.provider that return types with arguments of type AdminRoleRef

Modifier and Type	Method	Description
Set<AdminRoleRef>	AuthProvider.readRolesByIds(Set<String> ids)	Read a set of roles by the supplied ids

Uses of AdminRoleRef in com.broadleafcommerce.adminuser.resource.service.provider.external

Methods in com.broadleafcommerce.adminuser.resource.service.provider.external that return types with arguments of type AdminRoleRef

Modifier and Type	Method	Description
Set<AdminRoleRef>	ExternalAuthProvider.readRolesByIds(Set<String> ids)

Uses of AdminRoleRef in com.broadleafcommerce.adminuser.resource.service.validation.support

Method parameters in com.broadleafcommerce.adminuser.resource.service.validation.support with type arguments of type AdminRoleRef

Modifier and Type	Method	Description
static void	ValidationSupport.validateAllRolesHaveIdAndName(Collection<AdminRoleRef> roleRefs, org.springframework.validation.Errors errors, String rolesFieldNameOnParent, String missingIdErrorCode, String missingNameErrorCode)	Deprecated. Since 1.7.0.
static void	ValidationSupport.validateAllRolesNonNullAndHaveId(Collection<AdminRoleRef> roleRefs, org.springframework.validation.Errors errors, String rolesFieldNameOnParent, String nullRoleErrorCode, String missingIdErrorCode)	This validation serves purely to guarantee that each reference is not null and has an id.

Uses of AdminRoleRef in com.broadleafcommerce.adminuser.user.domain

Methods in com.broadleafcommerce.adminuser.user.domain that return types with arguments of type AdminRoleRef

Modifier and Type	Method	Description
Set<AdminRoleRef>	User.getRoles()	The roles of the user.

Method parameters in com.broadleafcommerce.adminuser.user.domain with type arguments of type AdminRoleRef

Modifier and Type	Method	Description
void	User.setRoles(Set<AdminRoleRef> roles)	The roles of the user.

Constructor parameters in com.broadleafcommerce.adminuser.user.domain with type arguments of type AdminRoleRef

Modifier	Constructor	Description
	User(String id, String firstName, String middleName, String lastName, String fullName, String username, String email, String phone, String serviceId, String type, String externalId, String tenantId, Map<String,Object> attributes, boolean locked, boolean expired, boolean changePasswordRequired, Set<AdminRoleRef> roles, boolean applicationAccess, boolean tenantAccess, Set<String> applicationIds)

Uses of AdminRoleRef in com.broadleafcommerce.adminuser.user.service

Methods in com.broadleafcommerce.adminuser.user.service that return types with arguments of type AdminRoleRef

Modifier and Type	Method	Description
Map<String,Collection<AdminRoleRef>>	AdminPrivilegeService.PrivilegeHydrationResult.getRestrictedRoleWithAncestorsByRestrictedRoleId()
protected Map<String,Collection<AdminRoleRef>>	AdminPrivilegeService.getRoleWithAncestorsByRoleId(@NonNull Set<String> roleIds)	Gets roles along with their ancestry roles mapped by given role id.

Method parameters in com.broadleafcommerce.adminuser.user.service with type arguments of type AdminRoleRef

Modifier and Type	Method	Description
protected Set<AdminPermissionRef>	AdminPrivilegeService.getAllFlatPermissions(@NonNull AdminUser user, @NonNull Collection<AdminRoleRef> roles)	Gets a Set of all AdminUser.getPermissions() along with getPermissions().
protected Set<AdminPermissionRef>	AdminPrivilegeService.getAllFlatPermissions(@NonNull Collection<AdminRoleRef> roles)	Gets a Set of all getPermissions().
void	AdminPrivilegeService.PrivilegeHydrationResult.setRestrictedRoleWithAncestorsByRestrictedRoleId(Map<String,Collection<AdminRoleRef>> restrictedRoleWithAncestorsByRestrictedRoleId)
protected void	DefaultAdminUserContextValidator.validateRoles(P user, String roleFieldNameOnParent, Set<AdminRoleRef> roles, org.springframework.validation.Errors errors)
protected void	DefaultAdminUserContextValidator.validateRolesAccessibleFromUserContext(P user, String rolesFieldNameOnParent, Set<AdminRoleRef> roleRefs, org.springframework.validation.Errors errors)	Validates that all of the user's assigned role IDs belong to roles that are accessible from the user's context.

Constructor parameters in com.broadleafcommerce.adminuser.user.service with type arguments of type AdminRoleRef

Modifier	Constructor	Description
	PrivilegeHydrationResult(Set<AdminPermissionRef> flatPermissions, Set<AdminRestriction> restrictions, Set<AdminRestrictedRole> restrictedRoles, Map<String,Collection<AdminRoleRef>> restrictedRoleWithAncestorsByRestrictedRoleId, Set<AdminRestrictedPermission> restrictedPermissions)

Uses of AdminRoleRef in com.broadleafcommerce.adminuser.user.service.hydration

Methods in com.broadleafcommerce.adminuser.user.service.hydration that return types with arguments of type AdminRoleRef

Modifier and Type	Method	Description
Collection<AdminRoleRef>	AdminRoleHydrationService.getFlattenedWithAllAncestors(Collection<AdminRoleRef> roles)
Collection<AdminRoleRef>	AdminRoleHydrationService.getFlattenedWithAllAncestorsAndThrowIfAnyFailed(Collection<AdminRoleRef> roles)	Same as AdminRoleHydrationService.getFlattenedWithAllAncestors(Collection) except this method throws an exception when there's one or more AdminRoleAncestryHydrationResponse not successful.
List<AdminRoleRef>	AdminRoleAncestryHydrationResponse.getRoleAndAncestors()	If the operation was AdminRoleAncestryHydrationResponse.successful, this will contain the role itself along with all of its ancestors.
Map<String,Collection<AdminRoleRef>>	AdminRoleHydrationService.getRolesWithAllAncestorsByRoleIdAndThrowIfAnyFailed(Collection<AdminRoleRef> roles)	Fetches all of the given roles' ancestors from the data store and returns a result containing them and the given roles themselves.
Set<AdminRoleRef>	AdminRoleHydrationService.hydrateRoleReferences(Set<AdminRoleRef> toHydrate)	Queries for each element in toHydrate in the data store.
protected Map<String,AdminRoleRef>	AdminRoleHydrationService.initializeFoundRolesCache(@NonNull Collection<AdminRoleRef> roles)

Methods in com.broadleafcommerce.adminuser.user.service.hydration with parameters of type AdminRoleRef

Modifier and Type	Method	Description
protected void	AdminRoleHydrationService.attemptHydrationOfNextAncestor(String inProgressRoleToHydrate, AdminRoleRef highestAncestorThusFar, List<String> ancestorIdsSeenThusFar, Set<String> failedToFindRoleIds, Map<String,AdminRoleRef> foundRolesCache, Set<String> roleIdsToRemoveFromInProgress, Set<String> roleIdsToFindInDataStore, Map<String,AdminRoleAncestryHydrationResponse> completed)
protected String	AdminRoleHydrationService.getCycleFoundErrorMessage(AdminRoleRef roleWithCycleCausingParent)
protected boolean	AdminRoleHydrationService.hasParentRoleId(AdminRoleRef role)

Method parameters in com.broadleafcommerce.adminuser.user.service.hydration with type arguments of type AdminRoleRef

Modifier and Type	Method	Description
protected void	AdminRoleHydrationService.assertAllRolesHaveIds(Collection<AdminRoleRef> roles)
protected void	AdminRoleHydrationService.attemptHydrationOfNextAncestor(String inProgressRoleToHydrate, AdminRoleRef highestAncestorThusFar, List<String> ancestorIdsSeenThusFar, Set<String> failedToFindRoleIds, Map<String,AdminRoleRef> foundRolesCache, Set<String> roleIdsToRemoveFromInProgress, Set<String> roleIdsToFindInDataStore, Map<String,AdminRoleAncestryHydrationResponse> completed)
protected Set<String>	AdminRoleHydrationService.findInDataStoreAndReturnMissingIds(Set<String> roleIdsToFind, Map<String,AdminRoleRef> cacheToAddFoundTo)	Searches the data store for roles matching the given roleIdsToFind.
Collection<AdminRoleRef>	AdminRoleHydrationService.getFlattenedWithAllAncestors(Collection<AdminRoleRef> roles)
Collection<AdminRoleRef>	AdminRoleHydrationService.getFlattenedWithAllAncestorsAndThrowIfAnyFailed(Collection<AdminRoleRef> roles)	Same as AdminRoleHydrationService.getFlattenedWithAllAncestors(Collection) except this method throws an exception when there's one or more AdminRoleAncestryHydrationResponse not successful.
Map<String,Collection<AdminRoleRef>>	AdminRoleHydrationService.getRolesWithAllAncestorsByRoleIdAndThrowIfAnyFailed(Collection<AdminRoleRef> roles)	Fetches all of the given roles' ancestors from the data store and returns a result containing them and the given roles themselves.
Map<String,AdminRoleAncestryHydrationResponse>	AdminRoleHydrationService.getWithAllAncestors(Collection<AdminRoleRef> roles)	Fetches all of the given roles' ancestors from the data store and returns a result containing them and the given roles themselves.
Set<AdminRoleRef>	AdminRoleHydrationService.hydrateRoleReferences(Set<AdminRoleRef> toHydrate)	Queries for each element in toHydrate in the data store.
protected Map<String,AdminRoleRef>	AdminRoleHydrationService.initializeFoundRolesCache(@NonNull Collection<AdminRoleRef> roles)
protected Map<String,List<String>>	AdminRoleHydrationService.initializeInProgressRoles(@NonNull Collection<AdminRoleRef> roles)
static AdminRoleAncestryHydrationResponse	AdminRoleAncestryHydrationResponse.success(@NonNull List<AdminRoleRef> ancestors)

Constructor parameters in com.broadleafcommerce.adminuser.user.service.hydration with type arguments of type AdminRoleRef

Modifier	Constructor	Description
	AdminRoleAncestryHydrationResponse(boolean successful, String errorMessage, List<AdminRoleRef> roleAndAncestors)