Package org.alfresco.repo.domain.permissions

Class AbstractAclCrudDAOImpl

java.lang.Object

org.alfresco.repo.domain.permissions.AbstractAclCrudDAOImpl

All Implemented Interfaces:

AclCrudDAO

Direct Known Subclasses:

AclCrudDAOImpl

public abstract class AbstractAclCrudDAOImpl
extends Object
implements AclCrudDAO

Abstract implementation for ACL crud DAO.

This provides basic services such as caching, but defers to the underlying implementation for CRUD operations for: alf_access_control_list alf_acl_member alf_acl_change_set alf_access_control_entry alf_permission alf_authority Also, following are currently unused: alf_ace_context alf_authority_alias

Since:

3.4

Author:

janv

Constructor Summary

Constructors

Constructor	Description
AbstractAclCrudDAOImpl()	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	addAclMembersToAcl(long aclId, List<Long> aceIds, int depth)
void	addAclMembersToAcl(long aclId, List<org.alfresco.util.Pair<Long,Integer>> aceIdsWithDepths)
Ace	createAce(Permission permission, Authority authority, ACEType type, org.alfresco.service.cmr.security.AccessStatus accessStatus)
protected abstract long	createAceContextEntity(AceContextEntity entity)
protected abstract long	createAceEntity(AceEntity entity)
AclEntity	createAcl(AclEntity entity)
Long	createAclChangeSet()
protected abstract Long	createAclChangeSetEntity()
protected abstract AclEntity	createAclEntity(AclEntity entity)
protected abstract AclMemberEntity	createAclMemberEntity(AclMemberEntity entity)
Authority	createAuthority(String authorityName)
protected abstract long	createAuthorityAliasEntity(AuthorityAliasEntity entity)
protected abstract AuthorityEntity	createAuthorityEntity(AuthorityEntity entity)
Permission	createPermission(PermissionReference permissionReference)
protected abstract PermissionEntity	createPermissionEntity(PermissionEntity entity)
protected abstract int	deleteAceContextEntity(long aceContextId)
protected abstract int	deleteAceEntities(List<Long> aceIds)
int	deleteAces(List<Long> aceIds)
void	deleteAcl(long id)
void	deleteAclChangeSet(Long changeSetId)
protected abstract int	deleteAclChangeSetEntity(Long id)
protected abstract int	deleteAclEntity(long id)
protected abstract int	deleteAclMemberEntities(List<Long> aclMemberIds)
protected abstract int	deleteAclMemberEntitiesByAcl(long idOfAcl)
int	deleteAclMembers(List<Long> aclMemberIds)
int	deleteAclMembersByAcl(long idOfAcl)
void	deleteAuthority(long id)
protected abstract int	deleteAuthorityAliasEntity(long id)
protected abstract int	deleteAuthorityEntity(long id)
void	deletePermission(long id)
protected abstract int	deletePermissionEntity(long id)
Ace	getAce(long aceEntityId)
Ace	getAce(Permission permission, Authority authority, ACEType type, org.alfresco.service.cmr.security.AccessStatus accessStatus)
protected abstract List<Map<String,Object>>	getAceAndAuthorityEntitiesByAcl(long idOfAcl)
protected abstract AceContextEntity	getAceContextEntity(long aceContextId)
protected abstract List<Ace>	getAceEntitiesByAuthority(long authorityId)
protected abstract AceEntity	getAceEntity(long aceEntityId)
protected abstract AceEntity	getAceEntity(long permissionId, long authorityId, boolean allowed, ACEType type)
List<Map<String,Object>>	getAcesAndAuthoritiesByAcl(long idOfAcl)
List<Ace>	getAcesByAuthority(long authorityId)
Acl	getAcl(Long id)
AclChangeSetEntity	getAclChangeSet(Long changeSetId)
protected abstract AclChangeSetEntity	getAclChangeSetEntity(Long changeSetId)
protected abstract List<Long>	getAclEntitiesThatInheritFromAcl(long idOfAcl)
protected abstract AclEntity	getAclEntity(long id)
AclUpdateEntity	getAclForUpdate(long id)
protected abstract List<AclMemberEntity>	getAclMemberEntitiesByAcl(long idOfAcl)
protected abstract List<AclMemberEntity>	getAclMemberEntitiesByAuthority(String authorityName)
protected abstract AclMemberEntity	getAclMemberEntity(long aclId, long aceId, int pos)
List<AclMember>	getAclMembersByAcl(long idOfAcl)
List<AclMemberEntity>	getAclMembersByAclForUpdate(long idOfAcl)
List<AclMember>	getAclMembersByAuthority(String authorityName)
List<Long>	getAclsThatInheritFromAcl(long aclEntityId)
protected abstract List<Long>	getADMNodeEntityIdsByAcl(long aclEntityId, int maxResults)
List<Long>	getADMNodesByAcl(long aclEntityId, int maxResults)
Authority	getAuthority(long id)
Authority	getAuthority(String authorityName)
protected abstract AuthorityEntity	getAuthorityEntity(long id)
protected abstract AuthorityEntity	getAuthorityEntity(String authorityName)
Long	getLatestAclByGuid(String aclGuid)
protected abstract Long	getLatestAclEntityByGuid(String aclGuid)
Long	getMaxChangeSetCommitTime()
Long	getMaxChangeSetIdByCommitTime(long maxCommitTime)
Ace	getOrCreateAce(Permission permission, Authority authority, ACEType type, org.alfresco.service.cmr.security.AccessStatus accessStatus)
Authority	getOrCreateAuthority(String name)
Permission	getOrCreatePermission(PermissionReference permissionReference)
Permission	getPermission(long id)
Permission	getPermission(PermissionReference permissionReference)
protected abstract PermissionEntity	getPermissionEntity(long id)
protected abstract PermissionEntity	getPermissionEntity(long qnameId, String name)
void	renameAuthority(String before, String after)
void	renamePermission(org.alfresco.service.namespace.QName oldTypeQName, String oldName, org.alfresco.service.namespace.QName newTypeQName, String newName)
protected abstract Long	selectMaxChangeSetCommitTime()
protected abstract Long	selectMaxChangeSetIdBeforeCommitTime(long maxCommitTime)
void	setAclEntityCache(TransactionalCache<Serializable,Object> aclEntityCache)	Set the cache to use for alf_access_control_list lookups (optional).
void	setAuthorityEntityCache(org.alfresco.repo.cache.SimpleCache<Serializable,Object> authorityEntityCache)	Set the cache to use for alf_authority lookups (optional).
void	setBatchSize(int batchSizeOverride)
void	setCheckAclConsistency()	Transaction-scope setting to make the DAO guarantee the validity of all caches: some cache data will be reloaded; some cache data will be considered safe.
void	setPermissionEntityCache(org.alfresco.repo.cache.SimpleCache<Serializable,Object> permissionEntityCache)	Set the cache to use for alf_permission lookups (optional).
void	setQnameDAO(QNameDAO qnameDAO)
protected abstract int	updateAceEntity(AceEntity updatedAceEntity)
void	updateAcl(AclUpdateEntity entity)
void	updateAclChangeSet(Long aclChangeSetEntityId, long commitTimeMs)
protected abstract int	updateAclEntity(AclEntity entity)
void	updateAclMember(AclMemberEntity entity)
protected abstract int	updateAclMemberEntity(AclMemberEntity entity)
protected abstract int	updateAuthorityEntity(AuthorityEntity updateEntity)
protected abstract int	updateChangeSetEntity(Long id, long commitTimeMs)
protected abstract int	updatePermissionEntity(PermissionEntity updateEntity)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractAclCrudDAOImpl

public AbstractAclCrudDAOImpl()

Default constructor.

This sets up the DAO accessors to bypass any caching to handle the case where the caches are not supplied in the setters.

Method Detail

setQnameDAO

public void setQnameDAO(QNameDAO qnameDAO)

setBatchSize

public void setBatchSize(int batchSizeOverride)

setAclEntityCache

public void setAclEntityCache(TransactionalCache<Serializable,Object> aclEntityCache)

Set the cache to use for alf_access_control_list lookups (optional).

Parameters:

aclEntityCache - the cache of IDs to AclEntities

setAuthorityEntityCache

public void setAuthorityEntityCache(org.alfresco.repo.cache.SimpleCache<Serializable,Object> authorityEntityCache)

Set the cache to use for alf_authority lookups (optional).

Parameters:

authorityEntityCache - the cache of IDs to AclEntities

setPermissionEntityCache

public void setPermissionEntityCache(org.alfresco.repo.cache.SimpleCache<Serializable,Object> permissionEntityCache)

Set the cache to use for alf_permission lookups (optional).

Parameters:

permissionEntityCache - the cache of IDs to PermissionEntities

createAcl

public AclEntity createAcl(AclEntity entity)

Specified by:

createAcl in interface AclCrudDAO

getAcl

public Acl getAcl(Long id)

Specified by:

getAcl in interface AclCrudDAO

setCheckAclConsistency

public void setCheckAclConsistency()

Description copied from interface: AclCrudDAO

Transaction-scope setting to make the DAO guarantee the validity of all caches: some cache data will be reloaded; some cache data will be considered safe.

Specified by:

setCheckAclConsistency in interface AclCrudDAO

getAclForUpdate

public AclUpdateEntity getAclForUpdate(long id)

Specified by:

getAclForUpdate in interface AclCrudDAO

getAclsThatInheritFromAcl

public List<Long> getAclsThatInheritFromAcl(long aclEntityId)

Specified by:

getAclsThatInheritFromAcl in interface AclCrudDAO

getLatestAclByGuid

public Long getLatestAclByGuid(String aclGuid)

Specified by:

getLatestAclByGuid in interface AclCrudDAO

getADMNodesByAcl

public List<Long> getADMNodesByAcl(long aclEntityId,
                                   int maxResults)

Specified by:

getADMNodesByAcl in interface AclCrudDAO

updateAcl

public void updateAcl(AclUpdateEntity entity)

Specified by:

updateAcl in interface AclCrudDAO

deleteAcl

public void deleteAcl(long id)

Specified by:

deleteAcl in interface AclCrudDAO

createAclEntity

protected abstract AclEntity createAclEntity(AclEntity entity)

getAclEntity

protected abstract AclEntity getAclEntity(long id)

getAclEntitiesThatInheritFromAcl

protected abstract List<Long> getAclEntitiesThatInheritFromAcl(long idOfAcl)

getLatestAclEntityByGuid

protected abstract Long getLatestAclEntityByGuid(String aclGuid)

updateAclEntity

protected abstract int updateAclEntity(AclEntity entity)

updateAceEntity

protected abstract int updateAceEntity(AceEntity updatedAceEntity)

deleteAclEntity

protected abstract int deleteAclEntity(long id)

getADMNodeEntityIdsByAcl

protected abstract List<Long> getADMNodeEntityIdsByAcl(long aclEntityId,
                                                       int maxResults)

addAclMembersToAcl

public void addAclMembersToAcl(long aclId,
                               List<Long> aceIds,
                               int depth)

Specified by:

addAclMembersToAcl in interface AclCrudDAO

addAclMembersToAcl

public void addAclMembersToAcl(long aclId,
                               List<org.alfresco.util.Pair<Long,Integer>> aceIdsWithDepths)

Specified by:

addAclMembersToAcl in interface AclCrudDAO

getAclMembersByAcl

public List<AclMember> getAclMembersByAcl(long idOfAcl)

Specified by:

getAclMembersByAcl in interface AclCrudDAO

getAclMembersByAclForUpdate

public List<AclMemberEntity> getAclMembersByAclForUpdate(long idOfAcl)

Specified by:

getAclMembersByAclForUpdate in interface AclCrudDAO

getAclMembersByAuthority

public List<AclMember> getAclMembersByAuthority(String authorityName)

Specified by:

getAclMembersByAuthority in interface AclCrudDAO

updateAclMember

public void updateAclMember(AclMemberEntity entity)

Specified by:

updateAclMember in interface AclCrudDAO

deleteAclMembers

public int deleteAclMembers(List<Long> aclMemberIds)

Specified by:

deleteAclMembers in interface AclCrudDAO

deleteAclMembersByAcl

public int deleteAclMembersByAcl(long idOfAcl)

Specified by:

deleteAclMembersByAcl in interface AclCrudDAO

createAclMemberEntity

protected abstract AclMemberEntity createAclMemberEntity(AclMemberEntity entity)

getAclMemberEntitiesByAcl

protected abstract List<AclMemberEntity> getAclMemberEntitiesByAcl(long idOfAcl)

getAclMemberEntitiesByAuthority

protected abstract List<AclMemberEntity> getAclMemberEntitiesByAuthority(String authorityName)

updateAclMemberEntity

protected abstract int updateAclMemberEntity(AclMemberEntity entity)

deleteAclMemberEntities

protected abstract int deleteAclMemberEntities(List<Long> aclMemberIds)

deleteAclMemberEntitiesByAcl

protected abstract int deleteAclMemberEntitiesByAcl(long idOfAcl)

getAclMemberEntity

protected abstract AclMemberEntity getAclMemberEntity(long aclId,
                                                      long aceId,
                                                      int pos)

createAclChangeSet

public Long createAclChangeSet()

Specified by:

createAclChangeSet in interface AclCrudDAO

updateAclChangeSet

public void updateAclChangeSet(Long aclChangeSetEntityId,
                               long commitTimeMs)

Specified by:

updateAclChangeSet in interface AclCrudDAO

getAclChangeSet

public AclChangeSetEntity getAclChangeSet(Long changeSetId)

Specified by:

getAclChangeSet in interface AclCrudDAO

deleteAclChangeSet

public void deleteAclChangeSet(Long changeSetId)

Specified by:

deleteAclChangeSet in interface AclCrudDAO

createAclChangeSetEntity

protected abstract Long createAclChangeSetEntity()

getAclChangeSetEntity

protected abstract AclChangeSetEntity getAclChangeSetEntity(Long changeSetId)

deleteAclChangeSetEntity

protected abstract int deleteAclChangeSetEntity(Long id)

updateChangeSetEntity

protected abstract int updateChangeSetEntity(Long id,
                                             long commitTimeMs)

createAce

public Ace createAce(Permission permission,
                     Authority authority,
                     ACEType type,
                     org.alfresco.service.cmr.security.AccessStatus accessStatus)

Specified by:

createAce in interface AclCrudDAO

getAce

public Ace getAce(Permission permission,
                  Authority authority,
                  ACEType type,
                  org.alfresco.service.cmr.security.AccessStatus accessStatus)

Specified by:

getAce in interface AclCrudDAO

getAce

public Ace getAce(long aceEntityId)

Specified by:

getAce in interface AclCrudDAO

getOrCreateAce

public Ace getOrCreateAce(Permission permission,
                          Authority authority,
                          ACEType type,
                          org.alfresco.service.cmr.security.AccessStatus accessStatus)

Specified by:

getOrCreateAce in interface AclCrudDAO

getAcesByAuthority

public List<Ace> getAcesByAuthority(long authorityId)

Specified by:

getAcesByAuthority in interface AclCrudDAO

getAcesAndAuthoritiesByAcl

public List<Map<String,Object>> getAcesAndAuthoritiesByAcl(long idOfAcl)

Specified by:

getAcesAndAuthoritiesByAcl in interface AclCrudDAO

deleteAces

public int deleteAces(List<Long> aceIds)

Specified by:

deleteAces in interface AclCrudDAO

createAceEntity

protected abstract long createAceEntity(AceEntity entity)

getAceEntity

protected abstract AceEntity getAceEntity(long aceEntityId)

getAceEntity

protected abstract AceEntity getAceEntity(long permissionId,
                                          long authorityId,
                                          boolean allowed,
                                          ACEType type)

getAceEntitiesByAuthority

protected abstract List<Ace> getAceEntitiesByAuthority(long authorityId)

getAceAndAuthorityEntitiesByAcl

protected abstract List<Map<String,Object>> getAceAndAuthorityEntitiesByAcl(long idOfAcl)

deleteAceEntities

protected abstract int deleteAceEntities(List<Long> aceIds)

createPermission

public Permission createPermission(PermissionReference permissionReference)

Specified by:

createPermission in interface AclCrudDAO

getPermission

public Permission getPermission(long id)

Specified by:

getPermission in interface AclCrudDAO

getPermission

public Permission getPermission(PermissionReference permissionReference)

Specified by:

getPermission in interface AclCrudDAO

getOrCreatePermission

public Permission getOrCreatePermission(PermissionReference permissionReference)

Specified by:

getOrCreatePermission in interface AclCrudDAO

renamePermission

public void renamePermission(org.alfresco.service.namespace.QName oldTypeQName,
                             String oldName,
                             org.alfresco.service.namespace.QName newTypeQName,
                             String newName)

Specified by:

renamePermission in interface AclCrudDAO

deletePermission

public void deletePermission(long id)

Specified by:

deletePermission in interface AclCrudDAO

createPermissionEntity

protected abstract PermissionEntity createPermissionEntity(PermissionEntity entity)

getPermissionEntity

protected abstract PermissionEntity getPermissionEntity(long id)

getPermissionEntity

protected abstract PermissionEntity getPermissionEntity(long qnameId,
                                                        String name)

updatePermissionEntity

protected abstract int updatePermissionEntity(PermissionEntity updateEntity)

deletePermissionEntity

protected abstract int deletePermissionEntity(long id)

createAuthority

public Authority createAuthority(String authorityName)

getAuthority

public Authority getAuthority(long id)

Specified by:

getAuthority in interface AclCrudDAO

getAuthority

public Authority getAuthority(String authorityName)

Specified by:

getAuthority in interface AclCrudDAO

getOrCreateAuthority

public Authority getOrCreateAuthority(String name)

Specified by:

getOrCreateAuthority in interface AclCrudDAO

renameAuthority

public void renameAuthority(String before,
                            String after)

Specified by:

renameAuthority in interface AclCrudDAO

deleteAuthority

public void deleteAuthority(long id)

Specified by:

deleteAuthority in interface AclCrudDAO

createAuthorityEntity

protected abstract AuthorityEntity createAuthorityEntity(AuthorityEntity entity)

getAuthorityEntity

protected abstract AuthorityEntity getAuthorityEntity(long id)

getAuthorityEntity

protected abstract AuthorityEntity getAuthorityEntity(String authorityName)

updateAuthorityEntity

protected abstract int updateAuthorityEntity(AuthorityEntity updateEntity)

deleteAuthorityEntity

protected abstract int deleteAuthorityEntity(long id)

createAceContextEntity

protected abstract long createAceContextEntity(AceContextEntity entity)

getAceContextEntity

protected abstract AceContextEntity getAceContextEntity(long aceContextId)

deleteAceContextEntity

protected abstract int deleteAceContextEntity(long aceContextId)

createAuthorityAliasEntity

protected abstract long createAuthorityAliasEntity(AuthorityAliasEntity entity)

deleteAuthorityAliasEntity

protected abstract int deleteAuthorityAliasEntity(long id)

getMaxChangeSetCommitTime

public Long getMaxChangeSetCommitTime()

Specified by:

getMaxChangeSetCommitTime in interface AclCrudDAO

Returns:

Long

selectMaxChangeSetCommitTime

protected abstract Long selectMaxChangeSetCommitTime()

Returns:

Long

getMaxChangeSetIdByCommitTime

public Long getMaxChangeSetIdByCommitTime(long maxCommitTime)

Specified by:

getMaxChangeSetIdByCommitTime in interface AclCrudDAO

Parameters:

maxCommitTime - long

Returns:

Long

selectMaxChangeSetIdBeforeCommitTime

protected abstract Long selectMaxChangeSetIdBeforeCommitTime(long maxCommitTime)

Parameters:

maxCommitTime - long

Returns:

Long