Package org.ametys.plugins.thesaurus.right

Class ThesaurusAccessController

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

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

org.ametys.plugins.thesaurus.right.ThesaurusAccessController

All Implemented Interfaces:

AccessController, LogEnabled, PluginAware, Initializable, Contextualizable, Serviceable

public class ThesaurusAccessController
extends AbstractProfileStorageBasedAccessController
implements Contextualizable

AccessController for a thesaurus objects. The rights are checked on '/cms' context. Read access is allowed to any connected user.

Nested Class Summary

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 RightsExtensionPoint	_rightEP	The right extension point

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
ThesaurusAccessController()

Method Summary

Modifier and Type	Method	Description
protected Object	_convertContext(Object initialContext)	For methods getXXXXPermissionYYY allow to have a modification of the context before transferring it to the profile assignment storage extension point The default implemenation keep the context as it is
protected String	_convertRightId(String rightId)	Convert the asked right id to the real right to check
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 Map<String,I18nizableTextParameter>	_getExplanationI18nParams(AbstractProfileStorageBasedAccessController.PermissionDetails details)	Get the i18n parameters for the explanation label
protected I18nizableText	_getExplanationI18nText(AbstractProfileStorageBasedAccessController.PermissionDetails details)	Get the i18n text for the explanation based on the provided details
protected boolean	_isSupportedStoredContext(Object storedObject)	Determine if a stored context is handled by this controller.
void	contextualize(Context context)
Map<AccessController.ExplanationObject,Map<AccessController.Permission,AccessExplanation>>	explainAllPermissions(UserIdentity identity, Set<GroupIdentity> groups)	Get AccessExplanation for each permission given to the user by this access controller.
AccessExplanation	explainPermission(UserIdentity user, Set<GroupIdentity> groups, String rightId, Object object)	Explain the permission for a user on the given object.
AccessExplanation	explainPermissionForAnonymous(String rightId, Object object)	Explain the permission for anonymous on the given object.
AccessExplanation	explainPermissionForAnyConnectedUser(String rightId, Object object)	Explain the permission for any connected 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.
AccessExplanation	explainReadAccessPermissionForAnonymous(Object object)	Explain the read access permission for anonymous on the given object.
AccessExplanation	explainReadAccessPermissionForAnyConnectedUser(Object object)	Explain the read access permission for any connected user on the given object.
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
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	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.AbstractProfileStorageBasedAccessController

_buildExplanation, _explainPermission, _explainPermissionForAnonymous, _explainPermissionForAnyConnectedUser, _getAccessExplanationI18nKey, _getPermission, _getPermissionByGroup, _getPermissionByUser, _getPermissionDetails, _getPermissionDetailsForAnonymous, _getPermissionDetailsForAnyConnectedUser, _getPermissionForAnonymous, _getPermissionForAnyConnectedUser, _hasRightResultInFirstCache, _hasRightResultInSecondCache, _putInFirstCache, _putInSecondCache, _unconvertContext, getId, 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

_rightEP

protected RightsExtensionPoint _rightEP

The right extension point

Constructor Details

ThesaurusAccessController

public ThesaurusAccessController()

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

_convertContext

protected Object _convertContext(Object initialContext)

Description copied from class: AbstractProfileStorageBasedAccessController

For methods getXXXXPermissionYYY allow to have a modification of the context before transferring it to the profile assignment storage extension point The default implemenation keep the context as it is

Overrides:

_convertContext in class AbstractProfileStorageBasedAccessController

Parameters:

initialContext - The right context that is supported

Returns:

the context modified

_convertRightId

protected String _convertRightId(String rightId)

Convert the asked right id to the real right to check

Parameters:

rightId - The asked right id

Returns:

the right to check

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

Overrides:

getPermission in class AbstractProfileStorageBasedAccessController

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

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

Overrides:

explainPermission in class AbstractProfileStorageBasedAccessController

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

_getExplanationI18nText

protected I18nizableText _getExplanationI18nText(AbstractProfileStorageBasedAccessController.PermissionDetails details)

Description copied from class: AbstractProfileStorageBasedAccessController

Get the i18n text for the explanation based on the provided details

Overrides:

_getExplanationI18nText in class AbstractProfileStorageBasedAccessController

Parameters:

details - the permission details

Returns:

the explanation

_getExplanationI18nParams

protected Map<String,I18nizableTextParameter> _getExplanationI18nParams(AbstractProfileStorageBasedAccessController.PermissionDetails details)

Description copied from class: AbstractProfileStorageBasedAccessController

Get the i18n parameters for the explanation label

Overrides:

_getExplanationI18nParams in class AbstractProfileStorageBasedAccessController

Parameters:

details - the permission details

Returns:

the map of parameters

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

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

Overrides:

getReadAccessPermission in class AbstractProfileStorageBasedAccessController

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

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

Overrides:

explainReadAccessPermission in class AbstractProfileStorageBasedAccessController

Parameters:

user - the user to test

groups - the groups of the user

object - the object to test

Returns:

an explanation of the 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

Overrides:

getPermissionByRight in class AbstractProfileStorageBasedAccessController

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

Overrides:

getPermissionForAnonymous in class AbstractProfileStorageBasedAccessController

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

explainPermissionForAnonymous

public AccessExplanation explainPermissionForAnonymous(String rightId,
 Object object)

Description copied from interface: AccessController

Explain the permission for anonymous on the given object. The access result in the explanation MUST be the same value as the one returned by AccessController.getPermissionForAnonymous(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:

explainPermissionForAnonymous in interface AccessController

Overrides:

explainPermissionForAnonymous in class AbstractProfileStorageBasedAccessController

Parameters:

rightId - the right to test

object - the object to test

Returns:

an explanation of the access

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

Overrides:

getReadAccessPermissionForAnonymous in class AbstractProfileStorageBasedAccessController

Parameters:

object - The object

Returns:

the read access permission for Anonymous only on an object

explainReadAccessPermissionForAnonymous

public AccessExplanation explainReadAccessPermissionForAnonymous(Object object)

Description copied from interface: AccessController

Explain the read access permission for anonymous on the given object. The access result in the explanation MUST be the same value as the one returned by AccessController.getReadAccessPermissionForAnonymous(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:

explainReadAccessPermissionForAnonymous in interface AccessController

Overrides:

explainReadAccessPermissionForAnonymous in class AbstractProfileStorageBasedAccessController

Parameters:

object - the object to test

Returns:

an explanation of the access

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

Overrides:

getPermissionForAnyConnectedUser in class AbstractProfileStorageBasedAccessController

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

explainPermissionForAnyConnectedUser

public AccessExplanation explainPermissionForAnyConnectedUser(String rightId,
 Object object)

Description copied from interface: AccessController

Explain the permission for any connected user on the given object. The access result in the explanation MUST be the same value as the one returned by AccessController.getPermissionForAnyConnectedUser(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:

explainPermissionForAnyConnectedUser in interface AccessController

Overrides:

explainPermissionForAnyConnectedUser in class AbstractProfileStorageBasedAccessController

Parameters:

rightId - the right to test

object - the object to test

Returns:

an explanation of the access

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

Overrides:

getReadAccessPermissionForAnyConnectedUser in class AbstractProfileStorageBasedAccessController

Parameters:

object - The object

Returns:

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

explainReadAccessPermissionForAnyConnectedUser

public AccessExplanation explainReadAccessPermissionForAnyConnectedUser(Object object)

Description copied from interface: AccessController

Explain the read access permission for any connected user on the given object. The access result in the explanation MUST be the same value as the one returned by AccessController.getReadAccessPermissionForAnyConnectedUser(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:

explainReadAccessPermissionForAnyConnectedUser in interface AccessController

Overrides:

explainReadAccessPermissionForAnyConnectedUser in class AbstractProfileStorageBasedAccessController

Parameters:

object - the object to test

Returns:

an explanation of the access

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

Overrides:

getPermissionByUser in class AbstractProfileStorageBasedAccessController

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

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

Overrides:

getReadAccessPermissionByGroup in class AbstractProfileStorageBasedAccessController

Parameters:

object - The object

Returns:

the read access permission by group only on an object

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

Overrides:

getReadAccessPermissionByUser in class AbstractProfileStorageBasedAccessController

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

Overrides:

getPermissionByGroup in class AbstractProfileStorageBasedAccessController

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

_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

explainAllPermissions

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

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

Overrides:

explainAllPermissions in class AbstractProfileStorageBasedAccessController

Parameters:

identity - the user identity

groups - the groups the user belongs to.

Returns:

all the user's permissions handled by this controller

_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

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