Package org.ametys.core.right

Interface ProfileBasedAccessController

All Superinterfaces:

AccessController, Supporter<Object>

All Known Implementing Classes:

AbstractHierarchicalAccessController, AbstractHierarchicalWithPermissionContextAccessController, AbstractODFRoleAccessController, AbstractProfileStorageBasedAccessController, BackOfficeAccessController, CartAccessController, ContentAccessController, ContentTypeAccessController, ExtractionAccessController, FormAccessController, LinkDirectoryAccessController, ModuleResourceAccessController, ODFContentHierarchicalAccessController, ODFContextualizedContentHierarchicalAccessController, ODFContributorAccessController, ODFManagerAccessController, ODFMCCManagerAccessController, PageAccessController, QueryAccessController, ResourceAccessController, SiteWorkspaceAccessController, StringHierarchicalAccessController, SurveyAccessController, SynchronizedContentAccessController, ThesaurusAccessController, UserDirectoryContentAccessController, WebContentAccessController, WebContentTypeAccessController, WebWorkspaceAccessController, WorkspaceAccessController, WorkspaceAccessController

public interface ProfileBasedAccessController
extends AccessController

An access controller based on profile

Nested Class Summary

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

AccessController.AccessResult, AccessController.ExplanationObject, AccessController.Permission

Method Summary

Modifier and Type	Method	Description
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

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

explainAllPermissions, explainAllPermissionsByGroup, explainAllPermissionsByUser, explainAllPermissionsForAnonymous, explainAllPermissionsForAnyConnected, explainPermission, explainPermissionForAnonymous, explainPermissionForAnyConnectedUser, explainReadAccessPermission, explainReadAccessPermissionForAnonymous, explainReadAccessPermissionForAnyConnectedUser, getExplanationObject, getId, getObjectCategory, getObjectLabel, getObjectPriority, getPermission, getPermissionByGroup, getPermissionByRight, getPermissionByUser, getPermissionForAnonymous, getPermissionForAnyConnectedUser, getReadAccessPermission, getReadAccessPermissionByGroup, getReadAccessPermissionByUser, getReadAccessPermissionForAnonymous, getReadAccessPermissionForAnyConnectedUser, hasAnonymousAnyPermissionOnWorkspace, hasAnonymousAnyReadAccessPermissionOnWorkspace, hasAnyConnectedUserAnyPermissionOnWorkspace, hasAnyConnectedUserAnyReadAccessPermissionOnWorkspace, hasUserAnyPermissionOnWorkspace, hasUserAnyReadAccessPermissionOnWorkspace

Methods inherited from interface org.ametys.runtime.plugin.component.Supporter

supports

Method Details

explainAllProfileUsesForAnonymousOnWorkspaces

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

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

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

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

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

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

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

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