Package org.ametys.core.right

Interface ProfileAssignmentStorage

All Known Subinterfaces:

ModifiableProfileAssignmentStorage

All Known Implementing Classes:

ACLAmetysObjectProfileAssignmentStorage, JdbcProfileAssignmentStorage, ModifiableACLAmetysObjectProfileAssignmentStorage

public interface ProfileAssignmentStorage

This interface is for read-only profile assignments storage

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ProfileAssignmentStorage.AnonymousOrAnyConnectedKeys	Keys for method that can return profiles of anonymous or any connected user
static class	ProfileAssignmentStorage.UserOrGroup	Keys for method that can return profiles of user or groups

Field Summary

Fields

Modifier and Type	Field	Description
static int	MAX_PRIORITY	Maximum priority.
static int	MIN_PRIORITY	Minimum priority.

Method Summary

Modifier and Type	Method	Description
int	getPriority()	Returns the priority of this profile storage The ProfileAssignmentStorageExtensionPoint will take the profile storage which supports the object with the highest priority to return the allowed/denied users/groups
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.

Field Detail

MIN_PRIORITY

static final int MIN_PRIORITY

Minimum priority.

See Also:

Constant Field Values

MAX_PRIORITY

static final int MAX_PRIORITY

Maximum priority.

See Also:

Constant Field Values

Method Detail

hasAnonymousAnyAllowedProfile

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

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

hasAnyConnectedAnyAllowedProfile

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

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

hasUserAnyAllowedProfile

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

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

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

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

getProfilesForAnonymousAndAnyConnectedUser

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

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

Parameters:

object - The object

Returns:

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

getProfilesForUsers

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

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

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

getProfilesForGroups

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

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

isSupported

boolean isSupported(Object object)

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

Parameters:

object - The object to test

Returns:

true if this profile storage supports the given object

isRootContextSupported

boolean isRootContextSupported(Object rootContext)

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

Parameters:

rootContext - The object to start searching

Returns:

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

getPriority

int getPriority()

Returns the priority of this profile storage The ProfileAssignmentStorageExtensionPoint will take the profile storage which supports the object with the highest priority to return the allowed/denied users/groups

Returns:

the priority of this profile storage

isInheritanceDisallowed

boolean isInheritanceDisallowed(Object object)

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

Parameters:

object - The object to test

Returns:

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