Package org.ametys.plugins.workspaces.project.rights.accesscontroller

Class BackOfficeAccessController

java.lang.Object

org.ametys.plugins.workspaces.project.rights.accesscontroller.BackOfficeAccessController

All Implemented Interfaces:

AccessController, ProfileBasedAccessController, PluginAware, Supporter<Object>, Initializable, Contextualizable, Serviceable

public class BackOfficeAccessController
extends Object
implements ProfileBasedAccessController, Serviceable, Contextualizable, PluginAware, Initializable

Automatically grand access to CMS on site related to a project where the user is manager AND has "Plugins_Workspaces_Rights_Project_BOAccess" right on general site context of catalog site. Grants the right on general context and sitemap context with the default admin profile

Nested Class Summary

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

AccessController.AccessResult, AccessController.ExplanationObject, AccessController.Permission

Field Summary

Fields

Modifier and Type	Field	Description
protected RightsExtensionPoint	_rightsEP	The rights extension point

Constructor Summary

Constructors

Constructor	Description
BackOfficeAccessController()

Method Summary

Modifier and Type	Method	Description
void	contextualize(Context context)
Map<AccessController.ExplanationObject,Map<AccessController.Permission,AccessExplanation>>	explainAllPermissions(UserIdentity identity, Set<GroupIdentity> groups, Set<Object> workspacesContexts)	Get AccessExplanation for each permission given to the user by this access controller.
Map<GroupIdentity,Map<AccessController.Permission,AccessExplanation>>	explainAllPermissionsByGroup(Object object)	Get all the permissions granted to groups on the object.
Map<UserIdentity,Map<AccessController.Permission,AccessExplanation>>	explainAllPermissionsByUser(Object object)	Get all the permissions granted to users on the object.
Map<AccessController.Permission,AccessExplanation>	explainAllPermissionsForAnonymous(Object object)	Get all the permissions granted to an anonymous user on the object.
Map<AccessController.Permission,AccessExplanation>	explainAllPermissionsForAnyConnected(Object object)	Get all the permissions granted to any connected user on the object.
Map<AccessController.ExplanationObject,AccessExplanation>	explainAllProfileUsesForAnonymousOnWorkspaces(String profileId, Set<Object> workspacesContexts)	Get an access explanation for every context handled by this controller where the given profile is used to grant a permission to an anonymous user
Map<AccessController.ExplanationObject,AccessExplanation>	explainAllProfileUsesForAnyConnectedOnWorkspaces(String profileId, Set<Object> workspacesContexts)	Get an access explanation for every context handled by this controller where the given profile is used to grant a permission to any connected user
Map<AccessController.ExplanationObject,Map<GroupIdentity,AccessExplanation>>	explainAllProfileUsesOnWorkspacesByGroups(String profileId, Set<Object> workspacesContexts)	Get an access explanation for every context handled by this controller where the given profile is used to grant a permission to a group
Map<AccessController.ExplanationObject,Map<UserIdentity,AccessExplanation>>	explainAllProfileUsesOnWorkspacesByUser(String profileId, Set<Object> workspacesContexts)	Get an access explanation for every context handled by this controller where the given profile is used to grant a permission to a user
AccessExplanation	explainPermission(UserIdentity user, Set<GroupIdentity> groups, String rightId, Object object)	Explain the permission for a user on the given object.
AccessExplanation	explainReadAccessPermission(UserIdentity user, Set<GroupIdentity> groups, Object object)	Explain the read access permission for a user on the given object.
String	getId()	Get the id of this controller
I18nizableText	getObjectCategory(Object object)	Get a label classifying the object handled by this access controller
I18nizableText	getObjectLabel(Object object)	Get a label describing the object handled by this access controller
int	getObjectPriority(Object object)	Get the priority of the object to order it in its category
AccessController.AccessResult	getPermission(UserIdentity user, Set<GroupIdentity> userGroups, String rightId, Object object)	Gets the kind of access a user has on an object for a given right
Map<GroupIdentity,AccessController.AccessResult>	getPermissionByGroup(String rightId, Object object)	Gets the permission by group only on an object for the given right.
Map<String,AccessController.AccessResult>	getPermissionByRight(UserIdentity user, Set<GroupIdentity> userGroups, Object object)	Gets the kind of access a user has on an object for all rights
Map<UserIdentity,AccessController.AccessResult>	getPermissionByUser(String rightId, Object object)	Gets the permission by user only on an object for the given right.
AccessController.AccessResult	getPermissionForAnonymous(String rightId, Object object)	Gets the permission for Anonymous only on an object for a given right
AccessController.AccessResult	getPermissionForAnyConnectedUser(String rightId, Object object)	Gets the permission for any connected user only on an object for a given right
AccessController.AccessResult	getReadAccessPermission(UserIdentity user, Set<GroupIdentity> userGroups, Object object)	Gets the kind of access a user has on an object for thye read access
Map<GroupIdentity,AccessController.AccessResult>	getReadAccessPermissionByGroup(Object object)	Gets the read access permission by group only on an object.
Map<UserIdentity,AccessController.AccessResult>	getReadAccessPermissionByUser(Object object)	Gets the read access permission by user only on an object.
AccessController.AccessResult	getReadAccessPermissionForAnonymous(Object object)	Gets the read access permission for Anonymous only on an object
AccessController.AccessResult	getReadAccessPermissionForAnyConnectedUser(Object object)	Gets the read access permission for any connected user only on an object
boolean	hasAnonymousAnyPermissionOnWorkspace(Set<Object> workspacesContexts, String rightId)	Returns true if anonymous has a permission on at least one object, directly or though groups, for a given rights and if the object is attached to the given context that is /${WorkspaceName} and its conversions.
boolean	hasAnonymousAnyReadAccessPermissionOnWorkspace(Set<Object> workspacesContexts)	Returns true if anonymous has a read access permission on at least one object, directly or though groups, for a given rights and if the object is attached to the given context that is /${WorkspaceName} and its conversions.
boolean	hasAnyConnectedUserAnyPermissionOnWorkspace(Set<Object> workspacesContexts, String rightId)	Returns true if any connected user has a permission on at least one object, directly or though groups, for a given rights and if the object is attached to the given context that is /${WorkspaceName} and its conversions.
boolean	hasAnyConnectedUserAnyReadAccessPermissionOnWorkspace(Set<Object> workspacesContexts)	Returns true if any connected user has a read access permission on at least one object, directly or though groups, for a given rights and if the object is attached to the given context that is /${WorkspaceName} and its conversions.
boolean	hasUserAnyPermissionOnWorkspace(Set<Object> workspacesContexts, UserIdentity user, Set<GroupIdentity> userGroups, String rightId)	Returns true if the user has a permission on at least one object, directly or though groups, for a given rights and if the object is attached to the given context that is /${WorkspaceName} and its conversions.
boolean	hasUserAnyReadAccessPermissionOnWorkspace(Set<Object> workspacesContexts, UserIdentity user, Set<GroupIdentity> userGroups)	Returns true if the user has a read access permission on at least one object, directly or though groups, for a given rights and if the object is attached to the given context that is /${WorkspaceName} and its conversions.
void	initialize()
void	service(ServiceManager manager)
void	setPluginInfo(String pluginName, String featureName, String id)	Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.
boolean	supports(Object object)	Check if an element is supported

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.core.right.AccessController

explainPermissionForAnonymous, explainPermissionForAnyConnectedUser, explainReadAccessPermissionForAnonymous, explainReadAccessPermissionForAnyConnectedUser, getExplanationObject

Field Details

_rightsEP

protected RightsExtensionPoint _rightsEP

The rights extension point

Constructor Details

BackOfficeAccessController

public BackOfficeAccessController()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

setPluginInfo

public void setPluginInfo(String pluginName,
 String featureName,
 String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

supports

public boolean supports(Object object)

Description copied from interface: Supporter

Check if an element is supported

Specified by:

supports in interface Supporter<Object>

Parameters:

object - The element

Returns:

true if the element is supported, false otherwise

getPermission

public AccessController.AccessResult getPermission(UserIdentity user,
 Set<GroupIdentity> userGroups,
 String rightId,
 Object object)

Description copied from interface: AccessController

Gets the kind of access a user has on an object for a given right

Specified by:

getPermission in interface AccessController

Parameters:

user - The user. Cannot be null.

userGroups - The groups the user belongs to

rightId - The id of the right of the user

object - The context object to check the access

Returns:

the kind of access a user has on an object for a right

getReadAccessPermission

public AccessController.AccessResult getReadAccessPermission(UserIdentity user,
 Set<GroupIdentity> userGroups,
 Object object)

Description copied from interface: AccessController

Gets the kind of access a user has on an object for thye read access

Specified by:

getReadAccessPermission in interface AccessController

Parameters:

user - The user. Cannot be null.

userGroups - The groups the user belongs to

object - The context object to check the access

Returns:

the kind of access a user has on an object for the read access

getPermissionByRight

public Map<String,AccessController.AccessResult> getPermissionByRight(UserIdentity user,
 Set<GroupIdentity> userGroups,
 Object object)

Description copied from interface: AccessController

Gets the kind of access a user has on an object for all rights

Specified by:

getPermissionByRight in interface AccessController

Parameters:

user - The user. Cannot be null.

userGroups - The groups the user belongs to

object - The context object to check the access

Returns:

the kind of access a user has on an object for all rights

getPermissionForAnonymous

public AccessController.AccessResult getPermissionForAnonymous(String rightId,
 Object object)

Description copied from interface: AccessController

Gets the permission for Anonymous only on an object for a given right

Specified by:

getPermissionForAnonymous in interface AccessController

Parameters:

rightId - The id of the right to check

object - The object

Returns:

the permission for Anonymous only on an object for a given right

getReadAccessPermissionForAnonymous

public AccessController.AccessResult getReadAccessPermissionForAnonymous(Object object)

Description copied from interface: AccessController

Gets the read access permission for Anonymous only on an object

Specified by:

getReadAccessPermissionForAnonymous in interface AccessController

Parameters:

object - The object

Returns:

the read access permission for Anonymous only on an object

getPermissionForAnyConnectedUser

public AccessController.AccessResult getPermissionForAnyConnectedUser(String rightId,
 Object object)

Description copied from interface: AccessController

Gets the permission for any connected user only on an object for a given right

Specified by:

getPermissionForAnyConnectedUser in interface AccessController

Parameters:

rightId - The id of the right to check

object - The object

Returns:

the permission for any connected user only on an object for a given right

getReadAccessPermissionForAnyConnectedUser

public AccessController.AccessResult getReadAccessPermissionForAnyConnectedUser(Object object)

Description copied from interface: AccessController

Gets the read access permission for any connected user only on an object

Specified by:

getReadAccessPermissionForAnyConnectedUser in interface AccessController

Parameters:

object - The object

Returns:

the read access permission for any connected user only on an object

getPermissionByUser

public Map<UserIdentity,AccessController.AccessResult> getPermissionByUser(String rightId,
 Object object)

Description copied from interface: AccessController

Gets the permission by user only on an object for the given right. It does not take account of the groups of the user, etc.

Specified by:

getPermissionByUser in interface AccessController

Parameters:

rightId - The id of the right to check

object - The object

Returns:

the permission by user only on an object for the given right

getReadAccessPermissionByUser

public Map<UserIdentity,AccessController.AccessResult> getReadAccessPermissionByUser(Object object)

Description copied from interface: AccessController

Gets the read access permission by user only on an object. It does not take account of the groups of the user, etc.

Specified by:

getReadAccessPermissionByUser in interface AccessController

Parameters:

object - The object

Returns:

the read access permission by user only on an object

getPermissionByGroup

public Map<GroupIdentity,AccessController.AccessResult> getPermissionByGroup(String rightId,
 Object object)

Description copied from interface: AccessController

Gets the permission by group only on an object for the given right.

Specified by:

getPermissionByGroup in interface AccessController

Parameters:

rightId - The id of the right to check

object - The object

Returns:

the permission by group only on an object for the given right

getReadAccessPermissionByGroup

public Map<GroupIdentity,AccessController.AccessResult> getReadAccessPermissionByGroup(Object object)

Description copied from interface: AccessController

Gets the read access permission by group only on an object.

Specified by:

getReadAccessPermissionByGroup in interface AccessController

Parameters:

object - The object

Returns:

the read access permission by group only on an object

hasUserAnyPermissionOnWorkspace

public boolean hasUserAnyPermissionOnWorkspace(Set<Object> workspacesContexts,
 UserIdentity user,
 Set<GroupIdentity> userGroups,
 String rightId)

Description copied from interface: AccessController

Returns true if the user has a permission on at least one object, directly or though groups, for a given rights and if the object is attached to the given context that is /${WorkspaceName} and its conversions.

Specified by:

hasUserAnyPermissionOnWorkspace in interface AccessController

Parameters:

workspacesContexts - The contexts to tests such as {"/${WorkspaceName}", "/repository", "/admin"}

user - The user

userGroups - The groups

rightId - The id of the right to check

Returns:

true if the user has a permission on at least one object, directly or though groups, for a given right

hasUserAnyReadAccessPermissionOnWorkspace

public boolean hasUserAnyReadAccessPermissionOnWorkspace(Set<Object> workspacesContexts,
 UserIdentity user,
 Set<GroupIdentity> userGroups)

Description copied from interface: AccessController

Returns true if the user has a read access permission on at least one object, directly or though groups, for a given rights and if the object is attached to the given context that is /${WorkspaceName} and its conversions.

Specified by:

hasUserAnyReadAccessPermissionOnWorkspace in interface AccessController

Parameters:

workspacesContexts - The contexts to tests such as {"/${WorkspaceName}", "/repository", "/admin"}

user - The user

userGroups - The groups

Returns:

true if the user has a permission on at least one object, directly or though groups, for a given right

hasAnonymousAnyPermissionOnWorkspace

public boolean hasAnonymousAnyPermissionOnWorkspace(Set<Object> workspacesContexts,
 String rightId)

Description copied from interface: AccessController

Returns true if anonymous has a permission on at least one object, directly or though groups, for a given rights and if the object is attached to the given context that is /${WorkspaceName} and its conversions.

Specified by:

hasAnonymousAnyPermissionOnWorkspace in interface AccessController

Parameters:

workspacesContexts - The contexts to tests such as {"/${WorkspaceName}", "/repository", "/admin"}

rightId - The id of the right to check

Returns:

true if anonymous has a permission on at least one object, directly or though groups, for a given right

hasAnonymousAnyReadAccessPermissionOnWorkspace

public boolean hasAnonymousAnyReadAccessPermissionOnWorkspace(Set<Object> workspacesContexts)

Description copied from interface: AccessController

Returns true if anonymous has a read access permission on at least one object, directly or though groups, for a given rights and if the object is attached to the given context that is /${WorkspaceName} and its conversions.

Specified by:

hasAnonymousAnyReadAccessPermissionOnWorkspace in interface AccessController

Parameters:

workspacesContexts - The contexts to tests such as {"/${WorkspaceName}", "/repository", "/admin"}

Returns:

true if anonymous has a permission on at least one object, directly or though groups, for a given right

hasAnyConnectedUserAnyPermissionOnWorkspace

public boolean hasAnyConnectedUserAnyPermissionOnWorkspace(Set<Object> workspacesContexts,
 String rightId)

Description copied from interface: AccessController

Returns true if any connected user has a permission on at least one object, directly or though groups, for a given rights and if the object is attached to the given context that is /${WorkspaceName} and its conversions.

Specified by:

hasAnyConnectedUserAnyPermissionOnWorkspace in interface AccessController

Parameters:

workspacesContexts - The contexts to tests such as {"/${WorkspaceName}", "/repository", "/admin"}

rightId - The id of the right to check

Returns:

true if any connected user has a permission on at least one object, directly or though groups, for a given right

hasAnyConnectedUserAnyReadAccessPermissionOnWorkspace

public boolean hasAnyConnectedUserAnyReadAccessPermissionOnWorkspace(Set<Object> workspacesContexts)

Description copied from interface: AccessController

Returns true if any connected user has a read access permission on at least one object, directly or though groups, for a given rights and if the object is attached to the given context that is /${WorkspaceName} and its conversions.

Specified by:

hasAnyConnectedUserAnyReadAccessPermissionOnWorkspace in interface AccessController

Parameters:

workspacesContexts - The contexts to tests such as {"/${WorkspaceName}", "/repository", "/admin"}

Returns:

true if any connected user has a permission on at least one object, directly or though groups, for a given right

explainReadAccessPermission

public AccessExplanation explainReadAccessPermission(UserIdentity user,
 Set<GroupIdentity> groups,
 Object object)

Description copied from interface: AccessController

Explain the read access permission for a user on the given object. The access result in the explanation MUST be the same value as the one returned by AccessController.getReadAccessPermission(UserIdentity, Set, Object). And the explanation should described the actual object that granted the right to allow final user to see if any context conversion happened

Specified by:

explainReadAccessPermission in interface AccessController

Parameters:

user - the user to test

groups - the groups of the user

object - the object to test

Returns:

an explanation of the access

explainPermission

public AccessExplanation explainPermission(UserIdentity user,
 Set<GroupIdentity> groups,
 String rightId,
 Object object)

Description copied from interface: AccessController

Explain the permission for a user on the given object. The access result in the explanation MUST be the same value as the one returned by AccessController.getPermission(UserIdentity, Set, String, Object). And the explanation should described the actual object that granted the right to allow final user to see if any context conversion happened

Specified by:

explainPermission in interface AccessController

Parameters:

user - the user to test

groups - the groups of the user

rightId - the right to test

object - the object to test

Returns:

an explanation of the access

getObjectLabel

public I18nizableText getObjectLabel(Object object)

Description copied from interface: AccessController

Get a label describing the object handled by this access controller

Specified by:

getObjectLabel in interface AccessController

Parameters:

object - the object

Returns:

the label

explainAllPermissions

public Map<AccessController.ExplanationObject,Map<AccessController.Permission,AccessExplanation>> explainAllPermissions(UserIdentity identity,
 Set<GroupIdentity> groups,
 Set<Object> workspacesContexts)

Description copied from interface: AccessController

Get AccessExplanation for each permission given to the user by this access controller. Returns a pair of permission/access explanation for each object with a granted or denied permission to this user by this access controller. Each explanation should be equivalent to calling the AccessController.explainPermission(UserIdentity, Set, String, Object) or AccessController.explainReadAccessPermission(UserIdentity, Set, Object) for the user, on the object with the corresponding right

Specified by:

explainAllPermissions in interface AccessController

Parameters:

identity - the user identity

groups - the groups the user belongs to.

workspacesContexts - The contexts to tests such as {"/${WorkspaceName}", "/repository", "/admin"}

Returns:

all the user's permissions handled by this controller

explainAllPermissionsForAnonymous

public Map<AccessController.Permission,AccessExplanation> explainAllPermissionsForAnonymous(Object object)

Description copied from interface: AccessController

Get all the permissions granted to an anonymous user on the object.

Specified by:

explainAllPermissionsForAnonymous in interface AccessController

Parameters:

object - the right context to check. it must be supported by the controller (see Supporter.supports(T)

Returns:

the permissions with their associated explanation

explainAllPermissionsForAnyConnected

public Map<AccessController.Permission,AccessExplanation> explainAllPermissionsForAnyConnected(Object object)

Description copied from interface: AccessController

Get all the permissions granted to any connected user on the object. The result must only include permissions specific to any connected user

Specified by:

explainAllPermissionsForAnyConnected in interface AccessController

Parameters:

object - the right context to check. it must be supported by the controller (see Supporter.supports(T)

Returns:

the permissions with their associated explanation

explainAllPermissionsByUser

public Map<UserIdentity,Map<AccessController.Permission,AccessExplanation>> explainAllPermissionsByUser(Object object)

Description copied from interface: AccessController

Get all the permissions granted to users on the object. The result must only include permissions specific to a user

Specified by:

explainAllPermissionsByUser in interface AccessController

Parameters:

object - the right context to check. it must be supported by the controller (see Supporter.supports(T)

Returns:

the permissions with their associated explanation for each user

explainAllPermissionsByGroup

public Map<GroupIdentity,Map<AccessController.Permission,AccessExplanation>> explainAllPermissionsByGroup(Object object)

Description copied from interface: AccessController

Get all the permissions granted to groups on the object. The result must only include permissions specific to a group

Specified by:

explainAllPermissionsByGroup in interface AccessController

Parameters:

object - the right context to check. it must be supported by the controller (see Supporter.supports(T)

Returns:

the permissions with their associated explanation for each group

getObjectCategory

public I18nizableText getObjectCategory(Object object)

Description copied from interface: AccessController

Get a label classifying the object handled by this access controller

Specified by:

getObjectCategory in interface AccessController

Parameters:

object - the object

Returns:

the label

getObjectPriority

public int getObjectPriority(Object object)

Description copied from interface: AccessController

Get the priority of the object to order it in its category

Specified by:

getObjectPriority in interface AccessController

Parameters:

object - the object

Returns:

the priority

getId

public String getId()

Description copied from interface: AccessController

Get the id of this controller

Specified by:

getId in interface AccessController

Returns:

the id of this controller

explainAllProfileUsesForAnonymousOnWorkspaces

public Map<AccessController.ExplanationObject,AccessExplanation> explainAllProfileUsesForAnonymousOnWorkspaces(String profileId,
 Set<Object> workspacesContexts)

Description copied from interface: ProfileBasedAccessController

Get an access explanation for every context handled by this controller where the given profile is used to grant a permission to an anonymous user

Specified by:

explainAllProfileUsesForAnonymousOnWorkspaces in interface ProfileBasedAccessController

Parameters:

profileId - the profile id

workspacesContexts - The contexts to tests such as {"/${WorkspaceName}", "/repository", "/admin"}

Returns:

a map of the objects with its explanation

explainAllProfileUsesForAnyConnectedOnWorkspaces

public Map<AccessController.ExplanationObject,AccessExplanation> explainAllProfileUsesForAnyConnectedOnWorkspaces(String profileId,
 Set<Object> workspacesContexts)

Description copied from interface: ProfileBasedAccessController

Get an access explanation for every context handled by this controller where the given profile is used to grant a permission to any connected user

Specified by:

explainAllProfileUsesForAnyConnectedOnWorkspaces in interface ProfileBasedAccessController

Parameters:

profileId - the profile id

workspacesContexts - The contexts to tests such as {"/${WorkspaceName}", "/repository", "/admin"}

Returns:

a map of the object with its explanation

explainAllProfileUsesOnWorkspacesByGroups

public Map<AccessController.ExplanationObject,Map<GroupIdentity,AccessExplanation>> explainAllProfileUsesOnWorkspacesByGroups(String profileId,
 Set<Object> workspacesContexts)

Description copied from interface: ProfileBasedAccessController

Get an access explanation for every context handled by this controller where the given profile is used to grant a permission to a group

Specified by:

explainAllProfileUsesOnWorkspacesByGroups in interface ProfileBasedAccessController

Parameters:

profileId - the profile id

workspacesContexts - The contexts to tests such as {"/${WorkspaceName}", "/repository", "/admin"}

Returns:

a map of the object with its explanation for each group

explainAllProfileUsesOnWorkspacesByUser

public Map<AccessController.ExplanationObject,Map<UserIdentity,AccessExplanation>> explainAllProfileUsesOnWorkspacesByUser(String profileId,
 Set<Object> workspacesContexts)

Description copied from interface: ProfileBasedAccessController

Get an access explanation for every context handled by this controller where the given profile is used to grant a permission to a user

Specified by:

explainAllProfileUsesOnWorkspacesByUser in interface ProfileBasedAccessController

Parameters:

profileId - the profile id

workspacesContexts - The contexts to tests such as {"/${WorkspaceName}", "/repository", "/admin"}

Returns:

a map of the object with its explanation for each user