Package org.ametys.plugins.core.impl.right

Class JdbcProfileAssignmentStorage

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.datasource.AbstractMyBatisDAO

org.ametys.plugins.core.impl.right.JdbcProfileAssignmentStorage

All Implemented Interfaces:

ModifiableProfileAssignmentStorage, ProfileAssignmentStorage, LogEnabled, PluginAware, Prioritizable, Component, Configurable, Contextualizable, Serviceable

public class JdbcProfileAssignmentStorage
extends AbstractMyBatisDAO
implements ModifiableProfileAssignmentStorage

Jdbc implementation of ProfileAssignmentStorage which stores profile assignments in database. This only supports String objects as contexts.

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.core.right.ProfileAssignmentStorage

ProfileAssignmentStorage.AnonymousOrAnyConnectedKeys, ProfileAssignmentStorage.UserOrGroup

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<String,org.ametys.plugins.core.impl.right.JdbcProfileAssignmentStorage.Database>	_cache	The jdbc cache
protected final Map<String,Boolean>	_inheritances	The cache for inheritances
protected boolean	_inheritancesUpToDate	If cache of inheritances is up-to-date
protected String	_supportedContext	The handled context

Fields inherited from class org.ametys.core.datasource.AbstractMyBatisDAO

_manager

Fields inherited from interface org.ametys.core.right.ProfileAssignmentStorage

MAX_PRIORITY, MIN_PRIORITY

Constructor Summary

Constructors

Constructor	Description
JdbcProfileAssignmentStorage()

Method Summary

Modifier and Type	Method	Description
protected void	_clearCache()	Clear the cache of _getFullData
protected void	_clearCache(Object context)	Clear the cache of _getFullData
protected void	_clearInheritanceCache()	Clear the cache of _getFullData
protected org.ametys.plugins.core.impl.right.JdbcProfileAssignmentStorage.Database	_getFullData(Object context)	Dump the SQL database in an cached object
protected Map<String,Boolean>	_getInheritances()	Get the full inheritances from SQL database in an cached object
void	addAllowedGroups(Set<GroupIdentity> groups, Object object, String profileId)	Associates some groups with an allowed profile on a given object
void	addAllowedProfilesForAnonymous(Object object, Set<String> profileIds)	Adds allowed profiles an anonymous user has on the given object
void	addAllowedProfilesForAnyConnectedUser(Object object, Set<String> profileIds)	Adds allowed profiles any connected user has on the given object
void	addAllowedUsers(Set<UserIdentity> users, Object object, String profileId)	Associates some users with an allowed profile on a given object
void	addDeniedGroups(Set<GroupIdentity> groups, Object object, String profileId)	Associates some groups with a denied profile on a given object
void	addDeniedProfilesForAnonymous(Object object, Set<String> profileIds)	Adds denied profiles an anonymous user has on the given object
void	addDeniedProfilesForAnyConnectedUser(Object object, Set<String> profileIds)	Adds denied profiles any connected user has on the given object
void	addDeniedUsers(Set<UserIdentity> users, Object object, String profileId)	Associates some users with a denied profile on a given object
void	configure(Configuration configuration)
void	disallowInheritance(Object object, boolean disallow)	Allow or disallow inheritance of permissions on the given object
protected Object	getObjectWithPrefix(Object context)	Get the object context with prefix if necessary
protected String	getPrefix()	Get the prefix for object context
int	getPriority()	Get the priority for the component.
Map<ProfileAssignmentStorage.AnonymousOrAnyConnectedKeys,Set<String>>	getProfilesForAnonymousAndAnyConnectedUser(Object object)	Gets the allowed profiles any connected user has on the given object
Map<GroupIdentity,Map<ProfileAssignmentStorage.UserOrGroup,Set<String>>>	getProfilesForGroups(Object object, Set<GroupIdentity> groups)	Gets the groups that have allowed profiles assigned on the given object
Map<UserIdentity,Map<ProfileAssignmentStorage.UserOrGroup,Set<String>>>	getProfilesForUsers(Object object, UserIdentity user)	Gets the users that have allowed profiles assigned on the given object
Set<String>	hasAnonymousAnyAllowedProfile(Set<? extends Object> rootContexts, Set<String> profileIds)	Returns some profiles that are matching if anonymous user has the allowed profile for any given root context (or any sub context), given some profiles. Only supported objects are transmitted
Set<String>	hasAnyConnectedAnyAllowedProfile(Set<? extends Object> rootContexts, Set<String> profileIds)	Returns some profiles that are matching if any connected user has the allowed profile for any given root context (or any sub context), given some profiles. Only supported objects are transmitted
Set<String>	hasGroupAnyAllowedProfile(Set<? extends Object> rootContexts, Set<GroupIdentity> groups, Set<String> profileIds)	Returns some profiles that are matching if group has the allowed profile for any given root context (or any sub context), given some profiles. Only supported objects are transmitted
Set<String>	hasUserAnyAllowedProfile(Set<? extends Object> rootContexts, UserIdentity user, Set<String> profileIds)	Returns some profiles that are matching if user has the allowed profile for any given root context (or any sub context), given some profiles. Only supported objects are transmitted
boolean	isInheritanceDisallowed(Object object)	Returns true if the inheritance of permissions is disallowed on the given object
boolean	isRootContextSupported(Object rootContext)	Returns true if this profile storage supports the given object as a root context i.e.
boolean	isSupported(Object object)	Returns true if this profile storage supports the given object, i.e.
void	removeAllowedGroups(Set<GroupIdentity> groups, Object object)	Removes the association between some groups and all allowed profiles on a given object
void	removeAllowedGroups(Set<GroupIdentity> groups, Object object, String profileId)	Removes the association between some groups and an allowed profile on a given object
void	removeAllowedProfilesForAnonymous(Object object, Set<String> profileIds)	Removes allowed profiles an anonymous user has on the given object
void	removeAllowedProfilesForAnyConnectedUser(Object object, Set<String> profileIds)	Removes allowed profiles any connected user has on the given object
void	removeAllowedUsers(Set<UserIdentity> users, Object object)	Removes the association between some users and all allowed profiles on a given object
void	removeAllowedUsers(Set<UserIdentity> users, Object object, String profileId)	Removes the association between some users and an allowed profile on a given object
void	removeDeniedGroups(Set<GroupIdentity> groups, Object object)	Removes the association between some groups and all denied profiles on a given object
void	removeDeniedGroups(Set<GroupIdentity> groups, Object object, String profileId)	Removes the association between some groups and a denied profile on a given object
void	removeDeniedProfilesForAnonymous(Object object, Set<String> profileIds)	Removes denied profiles an anonymous user has on the given object
void	removeDeniedProfilesForAnyConnectedUser(Object object, Set<String> profileIds)	Removes denied profiles any connected user has on the given object
void	removeDeniedUsers(Set<UserIdentity> users, Object object)	Removes the association between some users and all denied profiles on a given object
void	removeDeniedUsers(Set<UserIdentity> users, Object object, String profileId)	Removes the association between some users and an denied profile on a given object
void	removeGroup(GroupIdentity group)	Removes all the assignments involving this group
void	removeProfile(String profileId)	Removes all the assignments between this profile and users/groups/anonymous/any connected
void	removeUser(UserIdentity user)	Removes all the assignments involving this user

Methods inherited from class org.ametys.core.datasource.AbstractMyBatisDAO

_configureDatasource, _getDataSourceId, _getMyBatisConfiguration, contextualize, getSession, getSession, reload, service, setPluginInfo

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

_cache

protected final Map<String,org.ametys.plugins.core.impl.right.JdbcProfileAssignmentStorage.Database> _cache

The jdbc cache

_inheritances

protected final Map<String,Boolean> _inheritances

The cache for inheritances

_inheritancesUpToDate

protected boolean _inheritancesUpToDate

If cache of inheritances is up-to-date

_supportedContext

protected String _supportedContext

The handled context

Constructor Details

JdbcProfileAssignmentStorage

public JdbcProfileAssignmentStorage()

Method Details

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Overrides:

configure in class AbstractMyBatisDAO

Throws:

ConfigurationException

_getFullData

protected org.ametys.plugins.core.impl.right.JdbcProfileAssignmentStorage.Database _getFullData(Object context)

Dump the SQL database in an cached object

Parameters:

context - The context to seek

Returns:

The database

_clearCache

protected void _clearCache()

Clear the cache of _getFullData

_clearCache

protected void _clearCache(Object context)

Clear the cache of _getFullData

Parameters:

context - The context to seek

_getInheritances

protected Map<String,Boolean> _getInheritances()

Get the full inheritances from SQL database in an cached object

Returns:

The inheritances

_clearInheritanceCache

protected void _clearInheritanceCache()

Clear the cache of _getFullData

getObjectWithPrefix

protected Object getObjectWithPrefix(Object context)

Get the object context with prefix if necessary

Parameters:

context - The context object

Returns:

The prefixed object

getPrefix

protected String getPrefix()

Get the prefix for object context

Returns:

The prefix. Can be null if no prefix is necessary

hasUserAnyAllowedProfile

public Set<String> hasUserAnyAllowedProfile(Set<? extends Object> rootContexts,
 UserIdentity user,
 Set<String> profileIds)

Description copied from interface: ProfileAssignmentStorage

Returns some profiles that are matching if user has the allowed profile for any given root context (or any sub context), given some profiles.
Only supported objects are transmitted

Specified by:

hasUserAnyAllowedProfile in interface ProfileAssignmentStorage

Parameters:

rootContexts - The root contexts to search rights for

user - The user to test

profileIds - The ids of the profiles

Returns:

If the Set is empty, it means any connected user has no matching profile.
If the Set is non empty, it contains at least one of the given profile BUT it may not contains all the matching profiles for anyconnected user AND it can contains some other profiles that were not in the given profiles

hasGroupAnyAllowedProfile

public Set<String> hasGroupAnyAllowedProfile(Set<? extends Object> rootContexts,
 Set<GroupIdentity> groups,
 Set<String> profileIds)

Description copied from interface: ProfileAssignmentStorage

Returns some profiles that are matching if group has the allowed profile for any given root context (or any sub context), given some profiles.
Only supported objects are transmitted

Specified by:

hasGroupAnyAllowedProfile in interface ProfileAssignmentStorage

Parameters:

rootContexts - The root contexts to search rights for

groups - The groups to test (a single group needs to match)

profileIds - The ids of the profiles

Returns:

If the Set is empty, it means the group has no matching profile.
If the Set is non empty, it contains at least one of the given profile BUT it may not contains all the matching profiles for the group AND it can contains some other profiles that were not in the given profiles

hasAnyConnectedAnyAllowedProfile

public Set<String> hasAnyConnectedAnyAllowedProfile(Set<? extends Object> rootContexts,
 Set<String> profileIds)

Description copied from interface: ProfileAssignmentStorage

Returns some profiles that are matching if any connected user has the allowed profile for any given root context (or any sub context), given some profiles.
Only supported objects are transmitted

Specified by:

hasAnyConnectedAnyAllowedProfile in interface ProfileAssignmentStorage

Parameters:

rootContexts - The root contexts to search rights for

profileIds - The ids of the profiles

Returns:

If the Set is empty, it means the user has no matching profile.
If the Set is non empty, it contains at least one of the given profile BUT it may not contains all the matching profiles for the user AND it can contains some other profiles that were not in the given profiles

hasAnonymousAnyAllowedProfile

public Set<String> hasAnonymousAnyAllowedProfile(Set<? extends Object> rootContexts,
 Set<String> profileIds)

Description copied from interface: ProfileAssignmentStorage

Returns some profiles that are matching if anonymous user has the allowed profile for any given root context (or any sub context), given some profiles.
Only supported objects are transmitted

Specified by:

hasAnonymousAnyAllowedProfile in interface ProfileAssignmentStorage

Parameters:

rootContexts - The root contexts to search rights for

profileIds - The ids of the profiles

Returns:

If the Set is empty, it means anonymous has no matching profile.
If the Set is non empty, it contains at least one of the given profile BUT it may not contains all the matching profiles for anonymous AND it can contains some other profiles that were not in the given profiles

getProfilesForUsers

public Map<UserIdentity,Map<ProfileAssignmentStorage.UserOrGroup,Set<String>>> getProfilesForUsers(Object object,
 UserIdentity user)

Description copied from interface: ProfileAssignmentStorage

Gets the users that have allowed profiles assigned on the given object

Specified by:

getProfilesForUsers in interface ProfileAssignmentStorage

Parameters:

object - The object to test

user - The user to get profiles for. Can be null to get profiles for all users that have rights

Returns:

The map of allowed users with their assigned allowed/denied profiles

addAllowedProfilesForAnyConnectedUser

public void addAllowedProfilesForAnyConnectedUser(Object object,
 Set<String> profileIds)

Description copied from interface: ModifiableProfileAssignmentStorage

Adds allowed profiles any connected user has on the given object

Specified by:

addAllowedProfilesForAnyConnectedUser in interface ModifiableProfileAssignmentStorage

Parameters:

object - The object

profileIds - The profiles to add

removeAllowedProfilesForAnyConnectedUser

public void removeAllowedProfilesForAnyConnectedUser(Object object,
 Set<String> profileIds)

Description copied from interface: ModifiableProfileAssignmentStorage

Removes allowed profiles any connected user has on the given object

Specified by:

removeAllowedProfilesForAnyConnectedUser in interface ModifiableProfileAssignmentStorage

Parameters:

object - The object

profileIds - The profiles to remove

getProfilesForAnonymousAndAnyConnectedUser

public Map<ProfileAssignmentStorage.AnonymousOrAnyConnectedKeys,Set<String>> getProfilesForAnonymousAndAnyConnectedUser(Object object)

Description copied from interface: ProfileAssignmentStorage

Gets the allowed profiles any connected user has on the given object

Specified by:

getProfilesForAnonymousAndAnyConnectedUser in interface ProfileAssignmentStorage

Parameters:

object - The object

Returns:

a map containing allowed/denied profiles that anonymous and any connected user has on the given object

addDeniedProfilesForAnyConnectedUser

public void addDeniedProfilesForAnyConnectedUser(Object object,
 Set<String> profileIds)

Description copied from interface: ModifiableProfileAssignmentStorage

Adds denied profiles any connected user has on the given object

Specified by:

addDeniedProfilesForAnyConnectedUser in interface ModifiableProfileAssignmentStorage

Parameters:

object - The object

profileIds - The profiles to add

removeDeniedProfilesForAnyConnectedUser

public void removeDeniedProfilesForAnyConnectedUser(Object object,
 Set<String> profileIds)

Description copied from interface: ModifiableProfileAssignmentStorage

Removes denied profiles any connected user has on the given object

Specified by:

removeDeniedProfilesForAnyConnectedUser in interface ModifiableProfileAssignmentStorage

Parameters:

object - The object

profileIds - The profiles to remove

addAllowedProfilesForAnonymous

public void addAllowedProfilesForAnonymous(Object object,
 Set<String> profileIds)

Description copied from interface: ModifiableProfileAssignmentStorage

Adds allowed profiles an anonymous user has on the given object

Specified by:

addAllowedProfilesForAnonymous in interface ModifiableProfileAssignmentStorage

Parameters:

object - The object

profileIds - The profiles to add

removeAllowedProfilesForAnonymous

public void removeAllowedProfilesForAnonymous(Object object,
 Set<String> profileIds)

Description copied from interface: ModifiableProfileAssignmentStorage

Removes allowed profiles an anonymous user has on the given object

Specified by:

removeAllowedProfilesForAnonymous in interface ModifiableProfileAssignmentStorage

Parameters:

object - The object

profileIds - The profiles to remove

addDeniedProfilesForAnonymous

public void addDeniedProfilesForAnonymous(Object object,
 Set<String> profileIds)

Description copied from interface: ModifiableProfileAssignmentStorage

Adds denied profiles an anonymous user has on the given object

Specified by:

addDeniedProfilesForAnonymous in interface ModifiableProfileAssignmentStorage

Parameters:

object - The object

profileIds - The profiles to add

removeDeniedProfilesForAnonymous

public void removeDeniedProfilesForAnonymous(Object object,
 Set<String> profileIds)

Description copied from interface: ModifiableProfileAssignmentStorage

Removes denied profiles an anonymous user has on the given object

Specified by:

removeDeniedProfilesForAnonymous in interface ModifiableProfileAssignmentStorage

Parameters:

object - The object

profileIds - The profiles to remove

addAllowedUsers

public void addAllowedUsers(Set<UserIdentity> users,
 Object object,
 String profileId)

Description copied from interface: ModifiableProfileAssignmentStorage

Associates some users with an allowed profile on a given object

Specified by:

addAllowedUsers in interface ModifiableProfileAssignmentStorage

Parameters:

users - The users to add

object - The object

profileId - The id of the profile

removeAllowedUsers

public void removeAllowedUsers(Set<UserIdentity> users,
 Object object,
 String profileId)

Description copied from interface: ModifiableProfileAssignmentStorage

Removes the association between some users and an allowed profile on a given object

Specified by:

removeAllowedUsers in interface ModifiableProfileAssignmentStorage

Parameters:

users - The users to remove

object - The object

profileId - The id of the profile

removeAllowedUsers

public void removeAllowedUsers(Set<UserIdentity> users,
 Object object)

Description copied from interface: ModifiableProfileAssignmentStorage

Removes the association between some users and all allowed profiles on a given object

Specified by:

removeAllowedUsers in interface ModifiableProfileAssignmentStorage

Parameters:

users - The users to remove

object - The object

getProfilesForGroups

public Map<GroupIdentity,Map<ProfileAssignmentStorage.UserOrGroup,Set<String>>> getProfilesForGroups(Object object,
 Set<GroupIdentity> groups)

Description copied from interface: ProfileAssignmentStorage

Gets the groups that have allowed profiles assigned on the given object

Specified by:

getProfilesForGroups in interface ProfileAssignmentStorage

Parameters:

object - The object to test

groups - The group to get profiles for. Can be null to get profiles for all groups that have rights

Returns:

The map of allowed/denied groups with their assigned profiles

addAllowedGroups

public void addAllowedGroups(Set<GroupIdentity> groups,
 Object object,
 String profileId)

Description copied from interface: ModifiableProfileAssignmentStorage

Associates some groups with an allowed profile on a given object

Specified by:

addAllowedGroups in interface ModifiableProfileAssignmentStorage

Parameters:

groups - The groups to add

object - The object

profileId - The id of the profile

removeAllowedGroups

public void removeAllowedGroups(Set<GroupIdentity> groups,
 Object object,
 String profileId)

Description copied from interface: ModifiableProfileAssignmentStorage

Removes the association between some groups and an allowed profile on a given object

Specified by:

removeAllowedGroups in interface ModifiableProfileAssignmentStorage

Parameters:

groups - The groups to remove

object - The object

profileId - The id of the profile

removeAllowedGroups

public void removeAllowedGroups(Set<GroupIdentity> groups,
 Object object)

Description copied from interface: ModifiableProfileAssignmentStorage

Removes the association between some groups and all allowed profiles on a given object

Specified by:

removeAllowedGroups in interface ModifiableProfileAssignmentStorage

Parameters:

groups - The groups to remove

object - The object

addDeniedUsers

public void addDeniedUsers(Set<UserIdentity> users,
 Object object,
 String profileId)

Description copied from interface: ModifiableProfileAssignmentStorage

Associates some users with a denied profile on a given object

Specified by:

addDeniedUsers in interface ModifiableProfileAssignmentStorage

Parameters:

users - The users to add

object - The object

profileId - The id of the profile

removeDeniedUsers

public void removeDeniedUsers(Set<UserIdentity> users,
 Object object,
 String profileId)

Description copied from interface: ModifiableProfileAssignmentStorage

Removes the association between some users and an denied profile on a given object

Specified by:

removeDeniedUsers in interface ModifiableProfileAssignmentStorage

Parameters:

users - The users to remove

object - The object

profileId - The id of the profile

removeDeniedUsers

public void removeDeniedUsers(Set<UserIdentity> users,
 Object object)

Description copied from interface: ModifiableProfileAssignmentStorage

Removes the association between some users and all denied profiles on a given object

Specified by:

removeDeniedUsers in interface ModifiableProfileAssignmentStorage

Parameters:

users - The users to remove

object - The object

addDeniedGroups

public void addDeniedGroups(Set<GroupIdentity> groups,
 Object object,
 String profileId)

Description copied from interface: ModifiableProfileAssignmentStorage

Associates some groups with a denied profile on a given object

Specified by:

addDeniedGroups in interface ModifiableProfileAssignmentStorage

Parameters:

groups - The groups to add

object - The object

profileId - The id of the profile

removeDeniedGroups

public void removeDeniedGroups(Set<GroupIdentity> groups,
 Object object,
 String profileId)

Description copied from interface: ModifiableProfileAssignmentStorage

Removes the association between some groups and a denied profile on a given object

Specified by:

removeDeniedGroups in interface ModifiableProfileAssignmentStorage

Parameters:

groups - The groups to remove

object - The object

profileId - The id of the profile

removeDeniedGroups

public void removeDeniedGroups(Set<GroupIdentity> groups,
 Object object)

Description copied from interface: ModifiableProfileAssignmentStorage

Removes the association between some groups and all denied profiles on a given object

Specified by:

removeDeniedGroups in interface ModifiableProfileAssignmentStorage

Parameters:

groups - The groups to remove

object - The object

disallowInheritance

public void disallowInheritance(Object object,
 boolean disallow)

Description copied from interface: ModifiableProfileAssignmentStorage

Allow or disallow inheritance of permissions on the given object

Specified by:

disallowInheritance in interface ModifiableProfileAssignmentStorage

Parameters:

object - The object

disallow - true to disallow inheritance, false otherwise

isInheritanceDisallowed

public boolean isInheritanceDisallowed(Object object)

Description copied from interface: ProfileAssignmentStorage

Returns true if the inheritance of permissions is disallowed on the given object

Specified by:

isInheritanceDisallowed in interface ProfileAssignmentStorage

Parameters:

object - The object to test

Returns:

true if the inheritance of permissions is disallowed on the given object

removeProfile

public void removeProfile(String profileId)

Description copied from interface: ModifiableProfileAssignmentStorage

Removes all the assignments between this profile and users/groups/anonymous/any connected

Specified by:

removeProfile in interface ModifiableProfileAssignmentStorage

Parameters:

profileId - The profile to remove

removeUser

public void removeUser(UserIdentity user)

Description copied from interface: ModifiableProfileAssignmentStorage

Removes all the assignments involving this user

Specified by:

removeUser in interface ModifiableProfileAssignmentStorage

Parameters:

user - The user

removeGroup

public void removeGroup(GroupIdentity group)

Description copied from interface: ModifiableProfileAssignmentStorage

Removes all the assignments involving this group

Specified by:

removeGroup in interface ModifiableProfileAssignmentStorage

Parameters:

group - The group

isSupported

public boolean isSupported(Object object)

Description copied from interface: ProfileAssignmentStorage

Returns true if this profile storage supports the given object, i.e. if it is able to retrieve the allowed users/groups on that object

Specified by:

isSupported in interface ProfileAssignmentStorage

Parameters:

object - The object to test

Returns:

true if this profile storage supports the given object

isRootContextSupported

public boolean isRootContextSupported(Object rootContext)

Description copied from interface: ProfileAssignmentStorage

Returns true if this profile storage supports the given object as a root context i.e. it can seek any permission under this object

Specified by:

isRootContextSupported in interface ProfileAssignmentStorage

Parameters:

rootContext - The object to start searching

Returns:

true if this profile storage support this a as root context to search in

getPriority

public int getPriority()

Description copied from interface: Prioritizable

Get the priority for the component. On components using Prioritizable interface, each implementation define the order. In most cases, less is the number, more prior is the component.

Specified by:

getPriority in interface Prioritizable

Returns:

the priority