Package org.ametys.odf.rights

Class ODFContentHierarchicalAccessController

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

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

org.ametys.plugins.core.impl.right.AbstractHierarchicalWithPermissionContextAccessController<AmetysObject,ODFRightHelper.PermissionContext>

org.ametys.odf.rights.ODFContentHierarchicalAccessController

All Implemented Interfaces:

AccessController, LogEnabled, PluginAware, Initializable, Serviceable

public class ODFContentHierarchicalAccessController
extends AbstractHierarchicalWithPermissionContextAccessController<AmetysObject,ODFRightHelper.PermissionContext>

AccessController for a ODF Content

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 ContentHelper	_contentHelper	The helper for contents
protected ODFContentsTreeHelper	_odfContentTreeHelper	The ODF contents tree helper
protected ODFHelper	_odfHelper	The helper for root content
protected ODFRightHelper	_odfRightHelper	The right helper for ODF contents
protected AmetysObjectResolver	_resolver	Ametys Object Resolver
static final I18nizableText	ODF_CONTEXT_CATEGORY	the odf 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
ODFContentHierarchicalAccessController()

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, ODFRightHelper.PermissionContext permissionCtx)	Gets the parents of the object.
protected ODFRightHelper.PermissionContext	_getPermissionContext(AmetysObject initialObject)	Get the permission context.
static I18nizableText	getContentObjectLabel(Content content, ODFContentsTreeHelper helper)	Get a standardized object label for an ODF content
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
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.AbstractHierarchicalWithPermissionContextAccessController

_getExplanationI18nText, _getPermission, _getPermission, _getPermissionByGroup, _getPermissionByGroup, _getPermissionByUser, _getPermissionByUser, _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, _isSupportedStoredContext, _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

ODF_CONTEXT_CATEGORY

public static final I18nizableText ODF_CONTEXT_CATEGORY

the odf context category

_odfHelper

protected ODFHelper _odfHelper

The helper for root content

_contentHelper

protected ContentHelper _contentHelper

The helper for contents

_resolver

protected AmetysObjectResolver _resolver

Ametys Object Resolver

_odfRightHelper

protected ODFRightHelper _odfRightHelper

The right helper for ODF contents

_odfContentTreeHelper

protected ODFContentsTreeHelper _odfContentTreeHelper

The ODF contents tree helper

Constructor Details

ODFContentHierarchicalAccessController

public ODFContentHierarchicalAccessController()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractProfileStorageBasedAccessController

Throws:

ServiceException

isSupported

public boolean isSupported(Object object)

Description copied from interface: AccessController

Returns true if this access controller supports the given object

Parameters:

object - The object to test

Returns:

true if this access controller supports the given object

_getParents

protected Set<AmetysObject> _getParents(AmetysObject object,
 ODFRightHelper.PermissionContext permissionCtx)

Description copied from class: AbstractHierarchicalWithPermissionContextAccessController

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 AbstractHierarchicalWithPermissionContextAccessController<AmetysObject,ODFRightHelper.PermissionContext>

Parameters:

object - The object

permissionCtx - The permission context

Returns:

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

_getPermissionContext

protected ODFRightHelper.PermissionContext _getPermissionContext(AmetysObject initialObject)

Description copied from class: AbstractHierarchicalWithPermissionContextAccessController

Get the permission context. By default the permission context is the initial object context

Overrides:

_getPermissionContext in class AbstractHierarchicalWithPermissionContextAccessController<AmetysObject,ODFRightHelper.PermissionContext>

Parameters:

initialObject - the initial object context

Returns:

the permission context.

_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)

Description copied from interface: AccessController

Get a label describing the object handled by this access controller

Parameters:

object - the object

Returns:

the label

getObjectCategory

public I18nizableText getObjectCategory(Object object)

Description copied from interface: AccessController

Get a label classifying the object handled by this access controller

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

Parameters:

object - the object

Returns:

the priority

getContentObjectLabel

public static I18nizableText getContentObjectLabel(Content content,
 ODFContentsTreeHelper helper)

Get a standardized object label for an ODF content

Parameters:

content - the content

helper - the ODF content tree helper

Returns:

the label