Uses of Class
com.broadleafcommerce.auth.resource.domain.UserRole

Packages that use UserRole

Package	Description
com.broadleafcommerce.auth.data
com.broadleafcommerce.auth.data.autoconfigure
com.broadleafcommerce.auth.resource.service.validation
com.broadleafcommerce.auth.resource.web.endpoint
com.broadleafcommerce.auth.security.domain
com.broadleafcommerce.auth.security.service
com.broadleafcommerce.auth.security.service.hydration
com.broadleafcommerce.auth.user.autoconfigure
com.broadleafcommerce.auth.user.listener
com.broadleafcommerce.auth.user.listener.autoconfigure
com.broadleafcommerce.auth.user.service
com.broadleafcommerce.auth.user.service.autoconfigure

Uses of UserRole in com.broadleafcommerce.auth.data

Constructor parameters in com.broadleafcommerce.auth.data with type arguments of type UserRole

Constructor	Description
AuthorizationServerDataInitializer(com.broadleafcommerce.common.extension.TypeFactory typeFactory, AuthorizationServerService<AuthorizationServer> serverService, UserRoleService<UserRole> userRoleService, AuthorizationDataInitializationProperties properties)

Uses of UserRole in com.broadleafcommerce.auth.data.autoconfigure

Constructor parameters in com.broadleafcommerce.auth.data.autoconfigure with type arguments of type UserRole

Constructor	Description
AuthorizationServerConfiguration(AuthorizationServerDataInitializerAutoConfiguration.RoleConfiguration roleConfiguration, com.broadleafcommerce.common.extension.TypeFactory typeFactory, AuthorizationServerService<AuthorizationServer> authorizationServerService, UserRoleService<UserRole> userRoleService, AuthorizationDataInitializationProperties properties)

Uses of UserRole in com.broadleafcommerce.auth.resource.service.validation

Methods in com.broadleafcommerce.auth.resource.service.validation that return types with arguments of type UserRole

Modifier and Type	Method	Description
protected UserRoleService<UserRole>	UserRoleValidator.getUserRoleService()

Methods in com.broadleafcommerce.auth.resource.service.validation with parameters of type UserRole

Modifier and Type	Method	Description
protected void	UserRoleValidator.validateParentRoleId(UserRole role, org.springframework.validation.Errors errors)	Traverses the full ancestry of the role to confirm each ancestor still exists and there are no cycles, either in the case that the ancestors already had cycles, or in the case that this role itself causes a cycle.

Method parameters in com.broadleafcommerce.auth.resource.service.validation with type arguments of type UserRole

Modifier and Type	Method	Description
void	UserRoleValidator.setUserRoleService(UserRoleService<UserRole> userRoleService)	Lazy injection since this validator is itself a service component.

Uses of UserRole in com.broadleafcommerce.auth.resource.web.endpoint

Methods in com.broadleafcommerce.auth.resource.web.endpoint that return UserRole

Modifier and Type	Method	Description
UserRole	UserRoleEndpoint.createRole(UserRole req)
UserRole	UserRoleEndpoint.readRole(String id)
UserRole	UserRoleEndpoint.replaceRole(String id, UserRole req)

Methods in com.broadleafcommerce.auth.resource.web.endpoint that return types with arguments of type UserRole

Modifier and Type	Method	Description
List<UserRole>	UserRoleEndpoint.findByIdIn(Collection<String> ids)
org.springframework.data.domain.Page<UserRole>	UserRoleEndpoint.readAllRoles(String query, org.springframework.data.domain.Pageable page)

Methods in com.broadleafcommerce.auth.resource.web.endpoint with parameters of type UserRole

Modifier and Type	Method	Description
UserRole	UserRoleEndpoint.createRole(UserRole req)
UserRole	UserRoleEndpoint.replaceRole(String id, UserRole req)

Constructor parameters in com.broadleafcommerce.auth.resource.web.endpoint with type arguments of type UserRole

Constructor	Description
UserRoleEndpoint(UserRoleService<UserRole> userRoleService)

Uses of UserRole in com.broadleafcommerce.auth.security.domain

Methods in com.broadleafcommerce.auth.security.domain that return UserRole

Modifier and Type	Method	Description
protected UserRole	JpaUserRole.pruneArchivedReferences(org.modelmapper.spi.MappingContext<JpaUserRole,UserRole> mappingContext)	Used as the TypeMap.setPostConverter(Converter) for JpaUserRole.fromMe().

Method parameters in com.broadleafcommerce.auth.security.domain with type arguments of type UserRole

Modifier and Type	Method	Description
protected UserRole	JpaUserRole.pruneArchivedReferences(org.modelmapper.spi.MappingContext<JpaUserRole,UserRole> mappingContext)	Used as the TypeMap.setPostConverter(Converter) for JpaUserRole.fromMe().

Uses of UserRole in com.broadleafcommerce.auth.security.service

Classes in com.broadleafcommerce.auth.security.service with type parameters of type UserRole

Modifier and Type	Class	Description
class	DefaultUserRoleService<P extends UserRole,D extends com.broadleafcommerce.data.tracking.core.mapping.BusinessTypeAware & com.broadleafcommerce.data.tracking.core.mapping.ModelMapperMappable>
interface	UserRoleService<P extends UserRole>

Methods in com.broadleafcommerce.auth.security.service that return types with arguments of type UserRole

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

Method parameters in com.broadleafcommerce.auth.security.service with type arguments of type UserRole

Modifier and Type	Method	Description
protected Set<UserPermissionRef>	DefaultPrivilegeService.getAllFlatPermissions(@NonNull User user, @NonNull AuthorizationServer server, @NonNull Collection<UserRole> userAndServerRolesWithAncestors)	Gets a set of all flat permissions from User.getPermissions(), AuthorizationServer.getDefaultUserPermissions(), and permissions from the given roles.
protected Set<UserPermissionRef>	DefaultPrivilegeService.getAllFlatPermissions(@NonNull Collection<UserRole> roles)	Gets a set of all getPermissions() from the given roles
void	DefaultPrivilegeService.PrivilegeHydrationResult.setRestrictedRoleWithAncestorsByRestrictedRoleId(Map<String,Collection<UserRole>> restrictedRoleWithAncestorsByRestrictedRoleId)

Constructor parameters in com.broadleafcommerce.auth.security.service with type arguments of type UserRole

Constructor	Description
DefaultPrivilegeService(UserRoleService<UserRole> userRoleService, UserRoleAncestryHydrationService roleAncestryHydrationService, AuthorizationServerService<AuthorizationServer> serverService)
PrivilegeHydrationResult(Set<UserPermissionRef> flatPermissions, Set<Restriction> restrictions, Set<RestrictedRole> restrictedRoles, Map<String,Collection<UserRole>> restrictedRoleWithAncestorsByRestrictedRoleId, Set<RestrictedPermission> restrictedPermissions)

Uses of UserRole in com.broadleafcommerce.auth.security.service.hydration

Methods in com.broadleafcommerce.auth.security.service.hydration that return types with arguments of type UserRole

Modifier and Type	Method	Description
Collection<UserRole>	DefaultUserRoleAncestryHydrationService.getFlattenedWithAllAncestors(Collection<UserRole> roles)
Collection<UserRole>	UserRoleAncestryHydrationService.getFlattenedWithAllAncestors(Collection<UserRole> roles)	A convenience method to enable fetching a flattened collection consisting of all of the given roles along with their ancestors.
Collection<UserRole>	DefaultUserRoleAncestryHydrationService.getFlattenedWithAllAncestorsAndThrowIfAnyFailed(Collection<UserRole> roles)
Collection<UserRole>	UserRoleAncestryHydrationService.getFlattenedWithAllAncestorsAndThrowIfAnyFailed(Collection<UserRole> roles)	Same logic as documented for UserRoleAncestryHydrationService.getFlattenedWithAllAncestors(Collection) except this method throws an exception when there's one or more UserRoleAncestryHydrationResponse not successful.
List<UserRole>	UserRoleAncestryHydrationResponse.getRoleAndAncestors()	If the operation was UserRoleAncestryHydrationResponse.successful, this will contain the role itself along with all of its ancestors.
protected UserRoleService<UserRole>	DefaultUserRoleAncestryHydrationService.getUserRoleService()
Map<String,Collection<UserRole>>	DefaultUserRoleAncestryHydrationService.getWithAllAncestorsByRoleIdAndThrowIfAnyFailed(Collection<UserRole> roles)
Map<String,Collection<UserRole>>	UserRoleAncestryHydrationService.getWithAllAncestorsByRoleIdAndThrowIfAnyFailed(Collection<UserRole> roles)	Same logic as documented for UserRoleAncestryHydrationService.getWithAllAncestors(Collection) except this method throws an exception when there's one or more UserRoleAncestryHydrationResponse not successful, and the value of the map is a collection of the given roles along with their ancestors mapped by the given role id.

Methods in com.broadleafcommerce.auth.security.service.hydration with parameters of type UserRole

Modifier and Type	Method	Description
protected void	DefaultUserRoleAncestryHydrationService.attemptHydrationOfNextAncestor(String inProgressRoleToHydrate, UserRole highestAncestorThusFar, List<String> ancestorIdsSeenThusFar, Set<String> failedToFindRoleIds, Map<String,UserRole> foundRolesCache, Set<String> roleIdsToRemoveFromInProgress, Set<String> roleIdsToFindInDataStore, Map<String,UserRoleAncestryHydrationResponse> completed)

Method parameters in com.broadleafcommerce.auth.security.service.hydration with type arguments of type UserRole

Modifier and Type	Method	Description
protected void	DefaultUserRoleAncestryHydrationService.attemptHydrationOfNextAncestor(String inProgressRoleToHydrate, UserRole highestAncestorThusFar, List<String> ancestorIdsSeenThusFar, Set<String> failedToFindRoleIds, Map<String,UserRole> foundRolesCache, Set<String> roleIdsToRemoveFromInProgress, Set<String> roleIdsToFindInDataStore, Map<String,UserRoleAncestryHydrationResponse> completed)
protected Set<String>	DefaultUserRoleAncestryHydrationService.findInDataStoreAndReturnMissingIds(Set<String> roleIdsToFind, Map<String,UserRole> cacheToAddFoundTo)	Searches the data store for roles matching the given roleIdsToFind.
Collection<UserRole>	DefaultUserRoleAncestryHydrationService.getFlattenedWithAllAncestors(Collection<UserRole> roles)
Collection<UserRole>	UserRoleAncestryHydrationService.getFlattenedWithAllAncestors(Collection<UserRole> roles)	A convenience method to enable fetching a flattened collection consisting of all of the given roles along with their ancestors.
Collection<UserRole>	DefaultUserRoleAncestryHydrationService.getFlattenedWithAllAncestorsAndThrowIfAnyFailed(Collection<UserRole> roles)
Collection<UserRole>	UserRoleAncestryHydrationService.getFlattenedWithAllAncestorsAndThrowIfAnyFailed(Collection<UserRole> roles)	Same logic as documented for UserRoleAncestryHydrationService.getFlattenedWithAllAncestors(Collection) except this method throws an exception when there's one or more UserRoleAncestryHydrationResponse not successful.
Map<String,UserRoleAncestryHydrationResponse>	DefaultUserRoleAncestryHydrationService.getWithAllAncestors(Collection<UserRole> roles)
Map<String,UserRoleAncestryHydrationResponse>	UserRoleAncestryHydrationService.getWithAllAncestors(Collection<UserRole> 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,Collection<UserRole>>	DefaultUserRoleAncestryHydrationService.getWithAllAncestorsByRoleIdAndThrowIfAnyFailed(Collection<UserRole> roles)
Map<String,Collection<UserRole>>	UserRoleAncestryHydrationService.getWithAllAncestorsByRoleIdAndThrowIfAnyFailed(Collection<UserRole> roles)	Same logic as documented for UserRoleAncestryHydrationService.getWithAllAncestors(Collection) except this method throws an exception when there's one or more UserRoleAncestryHydrationResponse not successful, and the value of the map is a collection of the given roles along with their ancestors mapped by the given role id.
static UserRoleAncestryHydrationResponse	UserRoleAncestryHydrationResponse.success(@NonNull List<UserRole> ancestors)

Constructor parameters in com.broadleafcommerce.auth.security.service.hydration with type arguments of type UserRole

Constructor	Description
DefaultUserRoleAncestryHydrationService(UserRoleService<UserRole> userRoleService)
UserRoleAncestryHydrationResponse(boolean successful, String errorMessage, List<UserRole> roleAndAncestors)

Uses of UserRole in com.broadleafcommerce.auth.user.autoconfigure

Method parameters in com.broadleafcommerce.auth.user.autoconfigure with type arguments of type UserRole

Modifier and Type	Method	Description
ImpersonationClaimsEnhancer	ImpersonationConfiguration.defaultImpersonationClaimsEnhancer(AuthorizationServerProperties properties, UserService<User> userService, UserRoleService<UserRole> roleService, UserRoleAncestryHydrationService roleAncestryHydrationService)

Uses of UserRole in com.broadleafcommerce.auth.user.listener

Methods in com.broadleafcommerce.auth.user.listener that return UserRole

Modifier and Type	Method	Description
protected UserRole	AdminRolePersistenceHandler.buildUserRoleForCreate(String id, AdminRole request, Instant lastUpdated)

Methods in com.broadleafcommerce.auth.user.listener that return types with arguments of type UserRole

Modifier and Type	Method	Description
protected UserRoleService<UserRole>	AdminRolePersistenceHandler.getUserRoleService()

Methods in com.broadleafcommerce.auth.user.listener with parameters of type UserRole

Modifier and Type	Method	Description
protected void	AdminRolePersistenceHandler.mapUpdatesFromRequest(AdminRole request, UserRole target)
protected void	AdminRolePersistenceHandler.modifyForArchival(UserRole target)	Mimic what UserRoleService.archive(String) would do to mark this record as archived.
protected void	AdminRolePersistenceHandler.performArchivalReplacementIfEligible(@NonNull String entityId, @NonNull UserRole existing, @NonNull Instant changeTimestamp)
protected void	AdminRolePersistenceHandler.performReplacementIfEligible(@NonNull String entityId, @NonNull UserRole existing, @NonNull AdminRole request, @NonNull Instant changeTimestamp)
protected void	AdminRolePersistenceHandler.updateBasicRoleInfo(AdminRole request, UserRole role)
protected void	AdminRolePersistenceHandler.updateParent(AdminRole request, UserRole role)	Don't validate parent or ancestry here, since we expect the admin user service to have pre-validated it against cycles or broken references.
protected void	AdminRolePersistenceHandler.updatePermissions(AdminRole request, UserRole role)	We will not validate these references by querying for them, as the associated permissions may not yet be synchronized to the authentication service.
protected void	AdminRolePersistenceHandler.updateRoleTenantRestrictions(AdminRole request, UserRole role)

Constructor parameters in com.broadleafcommerce.auth.user.listener with type arguments of type UserRole

Constructor	Description
AdminRolePersistenceHandler(UserRoleService<UserRole> userRoleService, com.fasterxml.jackson.databind.ObjectMapper mapper, com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Uses of UserRole in com.broadleafcommerce.auth.user.listener.autoconfigure

Method parameters in com.broadleafcommerce.auth.user.listener.autoconfigure with type arguments of type UserRole

Modifier and Type	Method	Description
AdminRolePersistenceHandler	AuthDataUpdatePersistenceHandlerAutoConfiguration.adminRolePersistenceHandler(UserRoleService<UserRole> userRoleService, com.fasterxml.jackson.databind.ObjectMapper mapper, com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Uses of UserRole in com.broadleafcommerce.auth.user.service

Constructor parameters in com.broadleafcommerce.auth.user.service with type arguments of type UserRole

Constructor	Description
DefaultImpersonationClaimsEnhancer(AuthorizationServerProperties properties, UserService<User> userService, UserRoleService<UserRole> userRoleService, UserRoleAncestryHydrationService roleAncestryHydrationService)

Uses of UserRole in com.broadleafcommerce.auth.user.service.autoconfigure

Methods in com.broadleafcommerce.auth.user.service.autoconfigure that return types with arguments of type UserRole

Modifier and Type	Method	Description
<D extends com.broadleafcommerce.data.tracking.core.mapping.BusinessTypeAware & com.broadleafcommerce.data.tracking.core.mapping.ModelMapperMappable> UserRoleService<UserRole>	AuthServiceServiceAutoConfiguration.userRoleService(RoleRepository<D> roleRepository, com.broadleafcommerce.data.tracking.core.mapping.validation.EntityValidatorManager validatorManager, SimplePayloadMapper simplePayloadMapper)

Method parameters in com.broadleafcommerce.auth.user.service.autoconfigure with type arguments of type UserRole

Modifier and Type	Method	Description
PrivilegeService	AuthServiceServiceAutoConfiguration.restrictionService(UserRoleService<UserRole> userRoleService, UserRoleAncestryHydrationService userRoleAncestryHydrationService, AuthorizationServerService<AuthorizationServer> serverService)
UserRoleAncestryHydrationService	AuthServiceServiceAutoConfiguration.userRoleAncestryHydrationService(UserRoleService<UserRole> userRoleService)