Package org.ametys.web.rights

Class PageAccessController

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.core.impl.right.AbstractProfileStorageBasedAccessController

org.ametys.plugins.core.impl.right.AbstractHierarchicalWithPermissionContextAccessController<T,T>

org.ametys.plugins.core.impl.right.AbstractHierarchicalAccessController<AmetysObject>

org.ametys.web.rights.PageAccessController

All Implemented Interfaces:

AccessController, LogEnabled, PluginAware, Initializable, Contextualizable, Serviceable

public class PageAccessController
extends AbstractHierarchicalAccessController<AmetysObject>
implements Contextualizable

AccessController for a Page

Nested Class Summary

Nested classes/interfaces inherited from class org.ametys.plugins.core.impl.right.AbstractHierarchicalWithPermissionContextAccessController

AbstractHierarchicalWithPermissionContextAccessController.HierarchicalAccessResultDetails

Nested classes/interfaces inherited from class org.ametys.plugins.core.impl.right.AbstractProfileStorageBasedAccessController

AbstractProfileStorageBasedAccessController.CacheKind, AbstractProfileStorageBasedAccessController.PermissionDetails

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 SiteManager	_siteManager	The web site manager
static final I18nizableText	PAGE_CONTEXT_CATEGORY	the page context category

Fields inherited from class org.ametys.plugins.core.impl.right.AbstractProfileStorageBasedAccessController

__ANONYMOUS_USER_IDENTITY, __ANY_CONTECTED_USER_IDENTITY, _cacheManager, _groupManager, _profileAssignmentStorageEP, _rightProfileDAO

Constructor Summary

Constructors

Constructor	Description
PageAccessController()

Method Summary

Modifier and Type	Method	Description
protected Set<? extends Object>	_convertWorkspaceToRootRightContexts(Set<Object> workspacesContexts)	Get the current workspaces contexts and turn it into root contexts in order to allow methods hasXXXAnyPermissionOnWorkspace to work
protected Set<AmetysObject>	_getParents(AmetysObject object)	Gets the parents of the object.
protected boolean	_isSupportedStoredContext(Object storedObject)	Determine if a stored context is handled by this controller.
void	contextualize(Context context)
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
protected I18nizableText	getObjectLabelForExplanation(Object object)	Get the label describing the object in the explanation sentence.
int	getObjectPriority(Object object)	Get the priority of the object to order it in its category
static String	getPageObjectLabel(Page page)	Get an object label for a page.
boolean	isSupported(Object object)	Returns true if this access controller supports the given object
void	service(ServiceManager manager)

Methods inherited from class org.ametys.plugins.core.impl.right.AbstractHierarchicalAccessController

_getParents

Methods inherited from class org.ametys.plugins.core.impl.right.AbstractHierarchicalWithPermissionContextAccessController

_getExplanationI18nText, _getPermission, _getPermission, _getPermissionByGroup, _getPermissionByGroup, _getPermissionByUser, _getPermissionByUser, _getPermissionContext, _getPermissionDetails, _getPermissionDetails, _getPermissionDetailsForAnonymous, _getPermissionDetailsForAnonymous, _getPermissionDetailsForAnyConnectedUser, _getPermissionDetailsForAnyConnectedUser, _getPermissionForAnonymous, _getPermissionForAnonymous, _getPermissionForAnyConnectedUser, _getPermissionForAnyConnectedUser, getPermissionByRight, getPermissionByRight, isInheritanceAllowed

Methods inherited from class org.ametys.plugins.core.impl.right.AbstractProfileStorageBasedAccessController

_buildExplanation, _convertContext, _explainPermission, _explainPermissionForAnonymous, _explainPermissionForAnyConnectedUser, _getAccessExplanationI18nKey, _getExplanationI18nParams, _hasRightResultInFirstCache, _hasRightResultInSecondCache, _putInFirstCache, _putInSecondCache, _unconvertContext, explainAllPermissions, explainPermission, explainPermissionForAnonymous, explainPermissionForAnyConnectedUser, explainReadAccessPermission, explainReadAccessPermissionForAnonymous, explainReadAccessPermissionForAnyConnectedUser, getId, getPermission, getPermissionByGroup, getPermissionByUser, getPermissionForAnonymous, getPermissionForAnyConnectedUser, getReadAccessPermission, getReadAccessPermissionByGroup, getReadAccessPermissionByUser, getReadAccessPermissionForAnonymous, getReadAccessPermissionForAnyConnectedUser, hasAnonymousAnyPermissionOnWorkspace, hasAnonymousAnyReadAccessPermissionOnWorkspace, hasAnyConnectedUserAnyPermissionOnWorkspace, hasAnyConnectedUserAnyReadAccessPermissionOnWorkspace, hasUserAnyPermissionOnWorkspace, hasUserAnyReadAccessPermissionOnWorkspace, initialize, 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

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

getExplanationObject, getStandardAccessExplanation

Field Details

PAGE_CONTEXT_CATEGORY

public static final I18nizableText PAGE_CONTEXT_CATEGORY

the page context category

_siteManager

protected SiteManager _siteManager

The web site manager

Constructor Details

PageAccessController

public PageAccessController()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractProfileStorageBasedAccessController

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

isSupported

public boolean isSupported(Object object)

Description copied from interface: AccessController

Returns true if this access controller supports the given object

Specified by:

isSupported in interface AccessController

Parameters:

object - The object to test

Returns:

true if this access controller supports the given object

_isSupportedStoredContext

protected boolean _isSupportedStoredContext(Object storedObject)

Description copied from class: AbstractProfileStorageBasedAccessController

Determine if a stored context is handled by this controller. Default implementation returns the result of AccessController.isSupported(Object) as no conversion is done by default on object context before storage (see AbstractProfileStorageBasedAccessController._convertContext(Object))

Overrides:

_isSupportedStoredContext in class AbstractProfileStorageBasedAccessController

Parameters:

storedObject - a stored object

Returns:

true if the context is supported

_getParents

protected Set<AmetysObject> _getParents(AmetysObject object)

Description copied from class: AbstractHierarchicalAccessController

Gets the parents of the object. Must return null when the object is the "root" (where "root" means here the root of the hierarchy of the access controller)

Specified by:

_getParents in class AbstractHierarchicalAccessController<AmetysObject>

Parameters:

object - The object

Returns:

the parents of the object, or null if the object is the "root" of the hierarchy

_convertWorkspaceToRootRightContexts

protected Set<? extends Object> _convertWorkspaceToRootRightContexts(Set<Object> workspacesContexts)

Description copied from class: AbstractProfileStorageBasedAccessController

Get the current workspaces contexts and turn it into root contexts in order to allow methods hasXXXAnyPermissionOnWorkspace to work

Specified by:

_convertWorkspaceToRootRightContexts in class AbstractProfileStorageBasedAccessController

Parameters:

workspacesContexts - The workspace contexts. Such as '/${WorkspaceName}', '/admin'

Returns:

A null or empty set if the current AccessController does not apply to any workspace context, or the root object where ProfileAssignmentStorageExtension should start looking at to find any permission

getObjectLabelForExplanation

protected I18nizableText getObjectLabelForExplanation(Object object)
                                               throws RightsException

Description copied from class: AbstractProfileStorageBasedAccessController

Get the label describing the object in the explanation sentence.

Overrides:

getObjectLabelForExplanation in class AbstractProfileStorageBasedAccessController

Parameters:

object - the object that granted the right

Returns:

the label

Throws:

RightsException - when the object is not supported by the controller

getObjectLabel

public I18nizableText getObjectLabel(Object object)
                              throws RightsException

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

Throws:

RightsException

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

getPageObjectLabel

public static String getPageObjectLabel(Page page)

Get an object label for a page. This label will include the path to the page in the sitemap.

Parameters:

page - the page

Returns:

the label