org.ametys.cms.indexing.solr

Class AbstractSolrHierarchicalRightIndexer<T>

java.lang.Object

org.ametys.cms.indexing.solr.AbstractSolrHierarchicalRightIndexer<T>

Type Parameters:

T - The type of object

All Implemented Interfaces:

SolrFieldNames, Component, Serviceable

Direct Known Subclasses:

SolrContentRightIndexer, SolrPageRightIndexer

public abstract class AbstractSolrHierarchicalRightIndexer<T>
extends Object
implements Component, Serviceable, SolrFieldNames

Component indexing rights (hierarchical computed) for an object.

Field Summary

Fields

Modifier and Type	Field and Description
protected ProfileAssignmentStorageExtensionPoint	_profileAssignmentStorageEP The extension point for the profile assignement storages

Fields inherited from interface org.ametys.cms.content.indexing.solr.SolrFieldNames

ACL_READ_ALLOW_ANONYMOUS, ACL_READ_ALLOW_ANY_CONNECTED_USER, ACL_READ_ALLOWED_GROUPS, ACL_READ_ALLOWED_USERS, ACL_READ_DENIED_GROUPS, ACL_READ_DENIED_USERS, ALL_CONTENT_TYPES, ALL_MIXIN_TYPES, ALL_TAGS, CONTENT_COMMENTS, CONTENT_COMMENTS_NONVALIDATED, CONTENT_COMMENTS_VALIDATED, CONTENT_CREATOR, CONTENT_LANGUAGE, CONTENT_LANGUAGES, CONTENT_LAST_CONTRIBUTOR, CONTENT_NAME, CONTENT_TITLES, CONTENT_TYPE_RESOURCE, CONTENT_TYPES, CREATION_DATE, DATE_FOR_SORTING, DATES_FACET, DC_CONTRIBUTOR, DC_COVERAGE, DC_CREATOR, DC_DATE, DC_DESCRIPTION, DC_FORMAT, DC_IDENTIFIER, DC_LANGUAGE, DC_PUBLISHER, DC_RELATION, DC_RIGHTS, DC_SOURCE, DC_SUBJECT, DC_TITLE, DC_TYPE, DOCUMENT_TYPE, EXCERPT, FILENAME, FULL_EXACT_WS, FULL_GENERAL, FULL_PREFIX, FULL_STEMMED_PREFIX, ID, LAST_MAJOR_VALIDATION, LAST_MODIFIED, LAST_VALIDATION, LENGTH, MIME_TYPES, MIXIN_TYPES, PATH, REPEATER_ENTRY_POSITION, RESOURCE_CREATOR, RESOURCE_DATE, RESOURCE_LAST_MODIFIED, RESOURCE_ROOT_ID, SUB_CONTENT, TAGS, TITLE, TITLE_SORT, TYPE_CONTENT, TYPE_REPEATER, TYPE_RESOURCE, TYPE_WF_ENTRY, TYPE_WF_STEP, WORKFLOW_CURRENT_STEPS, WORKFLOW_CURRENT_STEPS_DV, WORKFLOW_ENTRY_STATE, WORKFLOW_HISTORY_STEPS, WORKFLOW_HISTORY_STEPS_DV, WORKFLOW_NAME, WORKFLOW_REF, WORKFLOW_REF_DV, WORKFLOW_STEP, WORKFLOW_STEP_ACTIONID, WORKFLOW_STEP_CALLER, WORKFLOW_STEP_DUEDATE, WORKFLOW_STEP_FINISHDATE, WORKFLOW_STEP_ID, WORKFLOW_STEP_OWNER, WORKFLOW_STEP_STARTDATE, WORKFLOW_STEP_STATUS

Constructor Summary

Constructors

Constructor and Description
AbstractSolrHierarchicalRightIndexer()

Method Summary

Modifier and Type	Method and Description
protected abstract Set<T>	_getParents(T object) Gets the parent of the object
protected AccessController.AccessResult	_getPermissionForAnonymous(Set<String> profileIds, T object) Gets the permissions for anonymous of the given object, resolving the hierarchy
protected AccessController.AccessResult	_getPermissionForAnyConnectedUser(Set<String> profileIds, T object) Gets the permissions for any connected user of the given object, resolving the hierarchy
protected Map<GroupIdentity,AccessController.AccessResult>	_getPermissionsByGroup(Set<String> profileIds, T object) Gets the permissions by group of the given object, resolving the hierarchy
protected Map<UserIdentity,AccessController.AccessResult>	_getPermissionsByUser(Set<String> profileIds, T object) Gets the permissions by user of the given object, resolving the hierarchy
protected Set<String>	_groupIdentitiesToStrings(Set<GroupIdentity> groupIdentities) Converts a set of identities to a set of their string representations
protected Set<String>	_userIdentitiesToStrings(Set<UserIdentity> userIdentities) Converts a set of identities to a set of their string representations
protected void	indexAcls(T object, SolrInputDocument document, Set<String> profiles) Indexes the ACLs of the object (resolving the hierarchy)
void	service(ServiceManager serviceManager)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_profileAssignmentStorageEP

protected ProfileAssignmentStorageExtensionPoint _profileAssignmentStorageEP

The extension point for the profile assignement storages

Constructor Detail

AbstractSolrHierarchicalRightIndexer

public AbstractSolrHierarchicalRightIndexer()

Method Detail

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

indexAcls

protected void indexAcls(T object,
                         SolrInputDocument document,
                         Set<String> profiles)

Indexes the ACLs of the object (resolving the hierarchy)

Parameters:

object - The object to index

document - The document to index

profiles - The profiles to check

_getParents

protected abstract Set<T> _getParents(T object)

Gets the parent of the object

Parameters:

object - The object

Returns:

the parent of the object

_getPermissionForAnonymous

protected AccessController.AccessResult _getPermissionForAnonymous(Set<String> profileIds,
                                                                   T object)

Gets the permissions for anonymous of the given object, resolving the hierarchy

Parameters:

profileIds - The profiles to check

object - The object

Returns:

the permissions for anonymous

_getPermissionForAnyConnectedUser

protected AccessController.AccessResult _getPermissionForAnyConnectedUser(Set<String> profileIds,
                                                                          T object)

Gets the permissions for any connected user of the given object, resolving the hierarchy

Parameters:

profileIds - The profiles to check

object - The object

Returns:

the permissions for any connected user

_getPermissionsByUser

protected Map<UserIdentity,AccessController.AccessResult> _getPermissionsByUser(Set<String> profileIds,
                                                                                T object)

Gets the permissions by user of the given object, resolving the hierarchy

Parameters:

profileIds - The profiles to check

object - The object

Returns:

the permissions by user

_getPermissionsByGroup

protected Map<GroupIdentity,AccessController.AccessResult> _getPermissionsByGroup(Set<String> profileIds,
                                                                                  T object)

Gets the permissions by group of the given object, resolving the hierarchy

Parameters:

profileIds - The profiles to check

object - The object

Returns:

the permissions by group

_userIdentitiesToStrings

protected Set<String> _userIdentitiesToStrings(Set<UserIdentity> userIdentities)

Converts a set of identities to a set of their string representations

Parameters:

userIdentities - The identities

Returns:

a set of string representing the identities

_groupIdentitiesToStrings

protected Set<String> _groupIdentitiesToStrings(Set<GroupIdentity> groupIdentities)

Converts a set of identities to a set of their string representations

Parameters:

groupIdentities - The identities

Returns:

a set of string representing the identities