Package org.ametys.odf.rights

Class ODFRightHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.odf.rights.ODFRightHelper

All Implemented Interfaces:

LogEnabled, Initializable, Component, Contextualizable, Serviceable

Direct Known Subclasses:

ODFRightHelper

public class ODFRightHelper
extends AbstractLogEnabled
implements Serviceable, Component, Contextualizable, Initializable

Helper for ODF right

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ODFRightHelper.ContextualizedContent	Record representing a contextualized content
static class	ODFRightHelper.ContextualizedPermissionContext	Class representing the permission context for parents computation for a contextualized content.
static class	ODFRightHelper.PermissionContext	Class representing the permission context for parents computation.
class	ODFRightHelper.RoleExpression	Expression for ODF role expression

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractCacheManager	_cacheManager	The cache manager
protected Context	_context	The avalon context
protected ODFHelper	_odfHelper	The ODF helper
protected AmetysObjectResolver	_resolver	Ametys Object Resolver
static final String	CONTRIBUTORS_FIELD_PATH	Attribute path for contributor role
static final String	MANAGERS_FIELD_PATH	Attribute path for manager role
static final String	REQUEST_ATTR_EDUCATIONAL_PATHS	Request attribute name for storing current educational paths
static final String	ROLE	The avalon role

Constructor Summary

Constructors

Constructor	Description
ODFRightHelper()

Method Summary

Modifier and Type	Method	Description
protected List<OrgUnit>	computeOrgUnits(ProgramItem programItem, ODFRightHelper.PermissionContext permissionCtx)	Get the orgunits of a program item
protected List<ProgramItem>	computeParentProgramItem(Course course, ODFRightHelper.PermissionContext permissionCtx)	Get the parents of a course from a rights perspective
protected List<ProgramItem>	computeParentProgramItem(ProgramItem programItem, ODFRightHelper.PermissionContext permissionCtx)	Get the parents of a program item from a rights perspective
protected Set<AmetysObject>	computeParents(Content content, ODFRightHelper.PermissionContext permissionCtx)	Compute the parents of a ODF content from a rights perspective
void	contextualize(Context context)
AmetysObjectIterable<Content>	getContentsWithRole(String roleAttributePath)	Get the ODF contents with users with given role
AmetysObjectIterable<Content>	getContentsWithUserAsRole(UserIdentity user, String roleAttributePath)	Get the programs items the user is set with a role
String	getContributorProfileId()	Get the id of profile for contributors
UserIdentity[]	getContributors(Content content)	Get the contributors of a ProgramItem or a OrgUnit
Query	getContributorsQuery(UserIdentity... users)	Build a user query on contributors field
String	getManagerProfileId()	Get the id of profile for managers
UserIdentity[]	getManagers(Content content)	Get the managers of a ProgramItem or a OrgUnit
Query	getManagersQuery(UserIdentity... users)	Build a user query on managers field
Set<AmetysObject>	getParents(Content content, ODFRightHelper.PermissionContext permissionCtx)	Get the parents of a ODF content from a rights perspective
Query	getRolesQuery(UserIdentity user)	Get the query to search for contents for which the user has a role
void	initialize()
void	service(ServiceManager smanager)

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

Field Details

ROLE

public static final String ROLE

The avalon role

REQUEST_ATTR_EDUCATIONAL_PATHS

public static final String REQUEST_ATTR_EDUCATIONAL_PATHS

Request attribute name for storing current educational paths

CONTRIBUTORS_FIELD_PATH

public static final String CONTRIBUTORS_FIELD_PATH

Attribute path for contributor role

See Also:

• Constant Field Values

MANAGERS_FIELD_PATH

public static final String MANAGERS_FIELD_PATH

Attribute path for manager role

See Also:

• Constant Field Values

_odfHelper

protected ODFHelper _odfHelper

The ODF helper

_context

protected Context _context

The avalon context

_resolver

protected AmetysObjectResolver _resolver

Ametys Object Resolver

_cacheManager

protected AbstractCacheManager _cacheManager

The cache manager

Constructor Details

ODFRightHelper

public ODFRightHelper()

Method Details

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

getContributorProfileId

public String getContributorProfileId()

Get the id of profile for contributors

Returns:

the id of profile for contributors

getManagerProfileId

public String getManagerProfileId()

Get the id of profile for managers

Returns:

the id of profile for managers

getContributors

public UserIdentity[] getContributors(Content content)

Get the contributors of a ProgramItem or a OrgUnit

Parameters:

content - the program item or the orgunit

Returns:

the contributors or null if not found

getContributorsQuery

public Query getContributorsQuery(UserIdentity... users)

Build a user query on contributors field

Parameters:

users - The users to test.

Returns:

the user query

getManagers

public UserIdentity[] getManagers(Content content)

Get the managers of a ProgramItem or a OrgUnit

Parameters:

content - the program item or the orgunit

Returns:

the managers or null if not found

getManagersQuery

public Query getManagersQuery(UserIdentity... users)

Build a user query on managers field

Parameters:

users - The users to test.

Returns:

the user query

getRolesQuery

public Query getRolesQuery(UserIdentity user)

Get the query to search for contents for which the user has a role

Parameters:

user - the user

Returns:

the query to filter on user permission

getContentsWithRole

public AmetysObjectIterable<Content> getContentsWithRole(String roleAttributePath)

Get the ODF contents with users with given role

Parameters:

roleAttributePath - the attribute path for role

Returns:

the contents with user(s) set with a role

getContentsWithUserAsRole

public AmetysObjectIterable<Content> getContentsWithUserAsRole(UserIdentity user,
 String roleAttributePath)

Get the programs items the user is set with a role

Parameters:

user - The user

roleAttributePath - the attribute path for role

Returns:

the program items the user is set with a role

getParents

public Set<AmetysObject> getParents(Content content,
 ODFRightHelper.PermissionContext permissionCtx)

Get the parents of a ODF content from a rights perspective

Parameters:

content - the content

permissionCtx - The permission context to compute rights. The permission context allows to restrict parents to parents which are part of a given ancestor. See #withAncestor method of ODFRightHelper.PermissionContext

Returns:

the parents of the content for rights computing

computeParents

protected Set<AmetysObject> computeParents(Content content,
 ODFRightHelper.PermissionContext permissionCtx)

Compute the parents of a ODF content from a rights perspective

Parameters:

content - the content

permissionCtx - The permission context to compute rights.

Returns:

the parents of the content for rights computing

computeParentProgramItem

protected List<ProgramItem> computeParentProgramItem(ProgramItem programItem,
 ODFRightHelper.PermissionContext permissionCtx)

Get the parents of a program item from a rights perspective

Parameters:

programItem - the program item

permissionCtx - The permission context to compute rights.

Returns:

the parent program items for rights computing

computeParentProgramItem

protected List<ProgramItem> computeParentProgramItem(Course course,
 ODFRightHelper.PermissionContext permissionCtx)

Get the parents of a course from a rights perspective

Parameters:

course - the course

permissionCtx - The permission context to compute rights.

Returns:

the course parents for rights computing

computeOrgUnits

protected List<OrgUnit> computeOrgUnits(ProgramItem programItem,
 ODFRightHelper.PermissionContext permissionCtx)

Get the orgunits of a program item

Parameters:

programItem - the program item

permissionCtx - The permission context to compute rights.

Returns:

the orgunits