Package com.broadleafcommerce.adminuser.user.service

Class AdminPrivilegeService.PrivilegeHydrationResult

java.lang.Object

com.broadleafcommerce.adminuser.user.service.AdminPrivilegeService.PrivilegeHydrationResult

Enclosing class:

AdminPrivilegeService

public static class AdminPrivilegeService.PrivilegeHydrationResult
extends Object

An intermediary data structure used internally by AdminPrivilegeService to hold data for a user or role entity to prevent querying the data multiple times.

When it's used for the user entity, all of its restrictions, flat permissions, restricted roles, and restricted permissions are stored.

When it's used for the role entity, only the flat permissions are stored.

Constructor Summary

Constructors

Constructor	Description
PrivilegeHydrationResult(Set<AdminPermissionRef> flatPermissions, Set<AdminRestriction> restrictions, Set<AdminRestrictedRole> restrictedRoles, Map<String,Collection<AdminRoleRef>> restrictedRoleWithAncestorsByRestrictedRoleId, Set<AdminRestrictedPermission> restrictedPermissions)	Creates a new PrivilegeHydrationResult instance.

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Set<AdminPermissionRef>	getFlatPermissions()	When hydrating for an AdminUser, this field contains all of the flat permissions from AdminUser.getPermissions(), including AdminRoleRef.getPermissions() ()} inherited from AdminUser.getRoles() and their ancestors.
Set<AdminRestrictedPermission>	getRestrictedPermissions()	All of the directly assigned AdminUser.getRestrictedPermissions() from an AdminUser, this does not include anything from AdminUser.getRoles().
Set<AdminRestrictedRole>	getRestrictedRoles()	All of the AdminUser.getRestrictedRoles().
Map<String,Collection<AdminRoleRef>>	getRestrictedRoleWithAncestorsByRestrictedRoleId()	All of the hydrated AdminUser.getRestrictedRoles() along with their ancestors mapped by the restricted role id.
Set<AdminRestriction>	getRestrictions()	All of the AdminUser.getRestrictions().
int	hashCode()
void	setFlatPermissions(Set<AdminPermissionRef> flatPermissions)	When hydrating for an AdminUser, this field contains all of the flat permissions from AdminUser.getPermissions(), including AdminRoleRef.getPermissions() ()} inherited from AdminUser.getRoles() and their ancestors.
void	setRestrictedPermissions(Set<AdminRestrictedPermission> restrictedPermissions)	All of the directly assigned AdminUser.getRestrictedPermissions() from an AdminUser, this does not include anything from AdminUser.getRoles().
void	setRestrictedRoles(Set<AdminRestrictedRole> restrictedRoles)	All of the AdminUser.getRestrictedRoles().
void	setRestrictedRoleWithAncestorsByRestrictedRoleId(Map<String,Collection<AdminRoleRef>> restrictedRoleWithAncestorsByRestrictedRoleId)	All of the hydrated AdminUser.getRestrictedRoles() along with their ancestors mapped by the restricted role id.
void	setRestrictions(Set<AdminRestriction> restrictions)	All of the AdminUser.getRestrictions().
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

PrivilegeHydrationResult

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

Creates a new PrivilegeHydrationResult instance.

Parameters:

flatPermissions - When hydrating for an AdminUser, this field contains all of the flat permissions from AdminUser.getPermissions(), including AdminRoleRef.getPermissions() ()} inherited from AdminUser.getRoles() and their ancestors.

When hydrating for an AdminRoleRef, this field contains all of the flat permissions from AdminRoleRef.getPermissions(), including those inherited from its ancestors.

restrictions - All of the AdminUser.getRestrictions(). This field is only relevant and hydrated for AdminUser.

restrictedRoles - All of the AdminUser.getRestrictedRoles(). This field is only relevant and hydrated for AdminUser.

restrictedRoleWithAncestorsByRestrictedRoleId - All of the hydrated AdminUser.getRestrictedRoles() along with their ancestors mapped by the restricted role id. This field is only relevant and hydrated for AdminUser.

restrictedPermissions - All of the directly assigned AdminUser.getRestrictedPermissions() from an AdminUser, this does not include anything from AdminUser.getRoles(). This field is only relevant and hydrated for AdminUser.

Method Details

getFlatPermissions

public Set<AdminPermissionRef> getFlatPermissions()

When hydrating for an AdminUser, this field contains all of the flat permissions from AdminUser.getPermissions(), including AdminRoleRef.getPermissions() ()} inherited from AdminUser.getRoles() and their ancestors.

When hydrating for an AdminRoleRef, this field contains all of the flat permissions from AdminRoleRef.getPermissions(), including those inherited from its ancestors.

getRestrictions

public Set<AdminRestriction> getRestrictions()

All of the AdminUser.getRestrictions(). This field is only relevant and hydrated for AdminUser.

getRestrictedRoles

public Set<AdminRestrictedRole> getRestrictedRoles()

All of the AdminUser.getRestrictedRoles(). This field is only relevant and hydrated for AdminUser.

getRestrictedRoleWithAncestorsByRestrictedRoleId

public Map<String,Collection<AdminRoleRef>> getRestrictedRoleWithAncestorsByRestrictedRoleId()

All of the hydrated AdminUser.getRestrictedRoles() along with their ancestors mapped by the restricted role id. This field is only relevant and hydrated for AdminUser.

getRestrictedPermissions

public Set<AdminRestrictedPermission> getRestrictedPermissions()

All of the directly assigned AdminUser.getRestrictedPermissions() from an AdminUser, this does not include anything from AdminUser.getRoles(). This field is only relevant and hydrated for AdminUser.

setFlatPermissions

public void setFlatPermissions(Set<AdminPermissionRef> flatPermissions)

When hydrating for an AdminUser, this field contains all of the flat permissions from AdminUser.getPermissions(), including AdminRoleRef.getPermissions() ()} inherited from AdminUser.getRoles() and their ancestors.

When hydrating for an AdminRoleRef, this field contains all of the flat permissions from AdminRoleRef.getPermissions(), including those inherited from its ancestors.

setRestrictions

public void setRestrictions(Set<AdminRestriction> restrictions)

All of the AdminUser.getRestrictions(). This field is only relevant and hydrated for AdminUser.

setRestrictedRoles

public void setRestrictedRoles(Set<AdminRestrictedRole> restrictedRoles)

All of the AdminUser.getRestrictedRoles(). This field is only relevant and hydrated for AdminUser.

setRestrictedRoleWithAncestorsByRestrictedRoleId

public void setRestrictedRoleWithAncestorsByRestrictedRoleId(Map<String,Collection<AdminRoleRef>> restrictedRoleWithAncestorsByRestrictedRoleId)

All of the hydrated AdminUser.getRestrictedRoles() along with their ancestors mapped by the restricted role id. This field is only relevant and hydrated for AdminUser.

setRestrictedPermissions

public void setRestrictedPermissions(Set<AdminRestrictedPermission> restrictedPermissions)

All of the directly assigned AdminUser.getRestrictedPermissions() from an AdminUser, this does not include anything from AdminUser.getRoles(). This field is only relevant and hydrated for AdminUser.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object