Package com.broadleafcommerce.auth.security.service

Class DefaultPrivilegeService.PrivilegeHydrationResult

java.lang.Object

com.broadleafcommerce.auth.security.service.DefaultPrivilegeService.PrivilegeHydrationResult

Enclosing class:

DefaultPrivilegeService

public static class DefaultPrivilegeService.PrivilegeHydrationResult
extends Object

An intermediary data structure used internally by PrivilegeService to hold all the restrictions, flat permissions, restricted roles, and restricted permissions of a user entity and permissions from a server entity to prevent querying the data multiple times.

Constructor Summary

Constructors

Constructor	Description
PrivilegeHydrationResult(User user, Set<UserPermissionRef> flatPermissions, Set<Restriction> restrictions, Set<RestrictedRole> restrictedRoles, Map<String,Collection<UserRole>> restrictedRoleWithAncestorsByRestrictedRoleId, Set<RestrictedPermission> restrictedPermissions)	Creates a new PrivilegeHydrationResult instance.
PrivilegeHydrationResult(Set<UserPermissionRef> flatPermissions, Set<Restriction> restrictions, Set<RestrictedRole> restrictedRoles, Map<String,Collection<UserRole>> restrictedRoleWithAncestorsByRestrictedRoleId, Set<RestrictedPermission> restrictedPermissions)	Deprecated.

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Set<UserPermissionRef>	getFlatPermissions()	All of the flat permissions from User.getPermissions(), including UserRole.getPermissions() inherited from User.getRoles() and their ancestors.
Set<RestrictedPermission>	getRestrictedPermissions()	All of the directly assigned User.getRestrictedPermissions() from an User, this does not include anything from User.getRoles().
Set<RestrictedRole>	getRestrictedRoles()	All of the User.getRestrictedRoles().
Map<String,Collection<UserRole>>	getRestrictedRoleWithAncestorsByRestrictedRoleId()	All of the hydrated User.getRestrictedRoles() along with their ancestors mapped by the restricted role id.
Set<Restriction>	getRestrictions()	All of the User.getRestrictions().
User	getUser()	The User that this DefaultPrivilegeService.PrivilegeHydrationResult is for.
int	hashCode()
void	setFlatPermissions(Set<UserPermissionRef> flatPermissions)	All of the flat permissions from User.getPermissions(), including UserRole.getPermissions() inherited from User.getRoles() and their ancestors.
void	setRestrictedPermissions(Set<RestrictedPermission> restrictedPermissions)	All of the directly assigned User.getRestrictedPermissions() from an User, this does not include anything from User.getRoles().
void	setRestrictedRoles(Set<RestrictedRole> restrictedRoles)	All of the User.getRestrictedRoles().
void	setRestrictedRoleWithAncestorsByRestrictedRoleId(Map<String,Collection<UserRole>> restrictedRoleWithAncestorsByRestrictedRoleId)	All of the hydrated User.getRestrictedRoles() along with their ancestors mapped by the restricted role id.
void	setRestrictions(Set<Restriction> restrictions)	All of the User.getRestrictions().
void	setUser(User user)	The User that this DefaultPrivilegeService.PrivilegeHydrationResult is for.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

PrivilegeHydrationResult

@Deprecated(since="Authentication Service 2.3.0, Release Train 2.3.0")
public PrivilegeHydrationResult(Set<UserPermissionRef> flatPermissions,
 Set<Restriction> restrictions,
 Set<RestrictedRole> restrictedRoles,
 Map<String,Collection<UserRole>> restrictedRoleWithAncestorsByRestrictedRoleId,
 Set<RestrictedPermission> restrictedPermissions)

Deprecated.

PrivilegeHydrationResult

public PrivilegeHydrationResult(User user,
 Set<UserPermissionRef> flatPermissions,
 Set<Restriction> restrictions,
 Set<RestrictedRole> restrictedRoles,
 Map<String,Collection<UserRole>> restrictedRoleWithAncestorsByRestrictedRoleId,
 Set<RestrictedPermission> restrictedPermissions)

Creates a new PrivilegeHydrationResult instance.

Parameters:

user - The User that this DefaultPrivilegeService.PrivilegeHydrationResult is for.

flatPermissions - All of the flat permissions from User.getPermissions(), including UserRole.getPermissions() inherited from User.getRoles() and their ancestors. This also includes all of the flat permissions from AuthorizationServer.getDefaultUserPermissions() and AuthorizationServer.getDefaultUserRoles() along with their ancestors.

restrictions - All of the User.getRestrictions().

restrictedRoles - All of the User.getRestrictedRoles().

restrictedRoleWithAncestorsByRestrictedRoleId - All of the hydrated User.getRestrictedRoles() along with their ancestors mapped by the restricted role id.

restrictedPermissions - All of the directly assigned User.getRestrictedPermissions() from an User, this does not include anything from User.getRoles().

Since:

Authentication Service 2.3.0, Release Train 2.3.0

Method Details

getUser

public User getUser()

The User that this DefaultPrivilegeService.PrivilegeHydrationResult is for.

Since:

Authentication Service 2.3.0, Release Train 2.3.0

getFlatPermissions

public Set<UserPermissionRef> getFlatPermissions()

All of the flat permissions from User.getPermissions(), including UserRole.getPermissions() inherited from User.getRoles() and their ancestors. This also includes all of the flat permissions from AuthorizationServer.getDefaultUserPermissions() and AuthorizationServer.getDefaultUserRoles() along with their ancestors.

getRestrictions

public Set<Restriction> getRestrictions()

All of the User.getRestrictions().

getRestrictedRoles

public Set<RestrictedRole> getRestrictedRoles()

All of the User.getRestrictedRoles().

getRestrictedRoleWithAncestorsByRestrictedRoleId

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

All of the hydrated User.getRestrictedRoles() along with their ancestors mapped by the restricted role id.

getRestrictedPermissions

public Set<RestrictedPermission> getRestrictedPermissions()

All of the directly assigned User.getRestrictedPermissions() from an User, this does not include anything from User.getRoles().

setUser

public void setUser(User user)

The User that this DefaultPrivilegeService.PrivilegeHydrationResult is for.

Since:

Authentication Service 2.3.0, Release Train 2.3.0

setFlatPermissions

public void setFlatPermissions(Set<UserPermissionRef> flatPermissions)

All of the flat permissions from User.getPermissions(), including UserRole.getPermissions() inherited from User.getRoles() and their ancestors. This also includes all of the flat permissions from AuthorizationServer.getDefaultUserPermissions() and AuthorizationServer.getDefaultUserRoles() along with their ancestors.

setRestrictions

public void setRestrictions(Set<Restriction> restrictions)

All of the User.getRestrictions().

setRestrictedRoles

public void setRestrictedRoles(Set<RestrictedRole> restrictedRoles)

All of the User.getRestrictedRoles().

setRestrictedRoleWithAncestorsByRestrictedRoleId

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

All of the hydrated User.getRestrictedRoles() along with their ancestors mapped by the restricted role id.

setRestrictedPermissions

public void setRestrictedPermissions(Set<RestrictedPermission> restrictedPermissions)

All of the directly assigned User.getRestrictedPermissions() from an User, this does not include anything from User.getRoles().

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