Package org.alfresco.repo.domain.permissions

Class AclDAOImpl

java.lang.Object

org.alfresco.repo.domain.permissions.AclDAOImpl

All Implemented Interfaces:

AclDAO

public class AclDAOImpl
extends Object
implements AclDAO

DAO to manage ACL persistence Note: based on earlier AclDaoComponentImpl

Since:

3.4

Author:

Andy Hind, janv

Constructor Summary

Constructors

Constructor	Description
AclDAOImpl()

Method Summary

Modifier and Type	Method	Description
Long	createAccessControlList()	Create a new ACL with default properties
Acl	createAccessControlList(AccessControlListProperties properties)	Create a new ACL with the given properties.
Acl	createAccessControlList(AccessControlListProperties properties, List<AccessControlEntry> aces, Long inherited)
Acl	createLayeredAcl(Long indirectedAcl)
List<AclChange>	deleteAccessControlEntries(Long id, AccessControlEntry pattern)	Delete some locally set ACLs according to the pattern
List<AclChange>	deleteAccessControlEntries(String authority)	Delete all ACEs that reference this authority as no longer valid.
List<AclChange>	deleteAccessControlList(Long id)	Delete an ACL
void	deleteAclForNode(long aclId)
List<AclChange>	deleteInheritedAccessControlEntries(Long id)	Delete the ACEs in position > 0 (those not set directly on the ACL but inherited) No affect on any other acl
List<AclChange>	deleteLocalAccessControlEntries(Long id)	Delete the ACEs in position 0 (those set directly on the ACL and not inherited) Cleans up existing acls
List<AclChange>	disableInheritance(Long id, boolean setInheritedOnAcl)	Disable inheritance
List<AclChange>	enableInheritance(Long id, Long parent)	Enable inheritance
void	fixSharedAcl(Long shared, Long defining)
AccessControlList	getAccessControlList(Long id)	Get an ACL (including entries)
AccessControlListProperties	getAccessControlListProperties(Long id)	Get the ACL properties
Acl	getAcl(Long id)	Get an ACL
Acl	getAclCopy(Long toCopy, Long toInheritFrom, ACLCopyMode mode)
List<Long>	getADMNodesByAcl(long aclEntityId, int maxResults)
Long	getCurrentChangeSetCommitTime()
AccessControlListProperties	getDefaultProperties()	Get the default ACL properties
Long	getInheritedAccessControlList(Long id)	Get the id of the ACL inherited from the one given May return null if there is nothing to inherit -> OLD world where nodes have their own ACL and we walk the parent chain
Long	getMaxChangeSetCommitTime()
Long	getMaxChangeSetIdByCommitTime(long maxCommitTime)
List<AclChange>	mergeInheritedAccessControlList(Long inherited, Long target)	Merge inherited ACEs in to target - the merged ACEs will go in at their current position +1
void	renameAuthority(String before, String after)
List<AclChange>	setAccessControlEntry(Long id, AccessControlEntry ace)	Add an access control entry
void	setAclCache(SimpleCache<Serializable,AccessControlList> aclCache)	Set the ACL cache
void	setAclCrudDAO(AclCrudDAO aclCrudDAO)
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	setNodeDAO(NodeDAO nodeDAO)
void	setQnameDAO(QNameDAO qnameDAO)
void	setTenantService(TenantService tenantService)

Methods inherited from class java.lang.Object

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

Constructor Details

AclDAOImpl

public AclDAOImpl()

Method Details

setQnameDAO

public void setQnameDAO(QNameDAO qnameDAO)

setTenantService

public void setTenantService(TenantService tenantService)

setAclCrudDAO

public void setAclCrudDAO(AclCrudDAO aclCrudDAO)

setNodeDAO

public void setNodeDAO(NodeDAO nodeDAO)

setAclCache

public void setAclCache(SimpleCache<Serializable,AccessControlList> aclCache)

Set the ACL cache

createAccessControlList

public Long createAccessControlList()

Create a new ACL with default properties

Specified by:

createAccessControlList in interface AclDAO

See Also:

• AclDAO.getDefaultProperties()
• AclDAO.createAccessControlList(AccessControlListProperties)

getDefaultProperties

public AccessControlListProperties getDefaultProperties()

Get the default ACL properties

Specified by:

getDefaultProperties in interface AclDAO

Returns:

the default properties

createAccessControlList

public Acl createAccessControlList(AccessControlListProperties properties)

Create a new ACL with the given properties. Unset properties are assigned defaults.

Specified by:

createAccessControlList in interface AclDAO

Returns:

Acl

createAccessControlList

public Acl createAccessControlList(AccessControlListProperties properties,
 List<AccessControlEntry> aces,
 Long inherited)

Specified by:

createAccessControlList in interface AclDAO

Returns:

Acl

See Also:

• AclDAO.createAccessControlList(AccessControlListProperties)

deleteAccessControlEntries

public List<AclChange> deleteAccessControlEntries(String authority)

Delete all ACEs that reference this authority as no longer valid. THIS DOES NOT CAUSE ANY ACL TO VERSION Used when deleting a user. No ACL is updated - the user has gone the aces and all related info is deleted.

Specified by:

deleteAccessControlEntries in interface AclDAO

Returns:

- the id of all ACLs affected

deleteAclForNode

public void deleteAclForNode(long aclId)

Specified by:

deleteAclForNode in interface AclDAO

deleteAccessControlList

public List<AclChange> deleteAccessControlList(Long id)

Delete an ACL

Specified by:

deleteAccessControlList in interface AclDAO

Returns:

- the id of all ACLs affected

deleteLocalAccessControlEntries

public List<AclChange> deleteLocalAccessControlEntries(Long id)

Delete the ACEs in position 0 (those set directly on the ACL and not inherited) Cleans up existing acls

Specified by:

deleteLocalAccessControlEntries in interface AclDAO

Returns:

- the id of all ACLs affected

deleteInheritedAccessControlEntries

public List<AclChange> deleteInheritedAccessControlEntries(Long id)

Delete the ACEs in position > 0 (those not set directly on the ACL but inherited) No affect on any other acl

Specified by:

deleteInheritedAccessControlEntries in interface AclDAO

Returns:

- the id of all ACLs affected

deleteAccessControlEntries

public List<AclChange> deleteAccessControlEntries(Long id,
 AccessControlEntry pattern)

Delete some locally set ACLs according to the pattern

Specified by:

deleteAccessControlEntries in interface AclDAO

pattern - - non null elements are used for the match

Returns:

- the id of all ACLs affected

getAcl

public Acl getAcl(Long id)

Get an ACL

Specified by:

getAcl in interface AclDAO

getAccessControlListProperties

public AccessControlListProperties getAccessControlListProperties(Long id)

Get the ACL properties

Specified by:

getAccessControlListProperties in interface AclDAO

Returns:

- the id of all ACLs affected

setCheckAclConsistency

public void setCheckAclConsistency()

Description copied from interface: AclDAO

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 AclDAO

getAccessControlList

public AccessControlList getAccessControlList(Long id)

Get an ACL (including entries)

Specified by:

getAccessControlList in interface AclDAO

getInheritedAccessControlList

public Long getInheritedAccessControlList(Long id)

Get the id of the ACL inherited from the one given May return null if there is nothing to inherit -> OLD world where nodes have their own ACL and we walk the parent chain

Specified by:

getInheritedAccessControlList in interface AclDAO

mergeInheritedAccessControlList

public List<AclChange> mergeInheritedAccessControlList(Long inherited,
 Long target)

Merge inherited ACEs in to target - the merged ACEs will go in at their current position +1

Specified by:

mergeInheritedAccessControlList in interface AclDAO

setAccessControlEntry

public List<AclChange> setAccessControlEntry(Long id,
 AccessControlEntry ace)

Add an access control entry

Specified by:

setAccessControlEntry in interface AclDAO

enableInheritance

public List<AclChange> enableInheritance(Long id,
 Long parent)

Enable inheritance

Specified by:

enableInheritance in interface AclDAO

disableInheritance

public List<AclChange> disableInheritance(Long id,
 boolean setInheritedOnAcl)

Disable inheritance

Specified by:

disableInheritance in interface AclDAO

getAclCopy

public Acl getAclCopy(Long toCopy,
 Long toInheritFrom,
 ACLCopyMode mode)

Specified by:

getAclCopy in interface AclDAO

getADMNodesByAcl

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

Specified by:

getADMNodesByAcl in interface AclDAO

createLayeredAcl

public Acl createLayeredAcl(Long indirectedAcl)

Specified by:

createLayeredAcl in interface AclDAO

getCurrentChangeSetCommitTime

public Long getCurrentChangeSetCommitTime()

Specified by:

getCurrentChangeSetCommitTime in interface AclDAO

Returns:

the commit time of the current ACL change set entry or null if there have not been any modifications.

renameAuthority

public void renameAuthority(String before,
 String after)

Specified by:

renameAuthority in interface AclDAO

fixSharedAcl

public void fixSharedAcl(Long shared,
 Long defining)

Specified by:

fixSharedAcl in interface AclDAO

Parameters:

shared - Long

defining - Long

getMaxChangeSetCommitTime

public Long getMaxChangeSetCommitTime()

Specified by:

getMaxChangeSetCommitTime in interface AclDAO

Returns:

Long

getMaxChangeSetIdByCommitTime

public Long getMaxChangeSetIdByCommitTime(long maxCommitTime)

Specified by:

getMaxChangeSetIdByCommitTime in interface AclDAO

Parameters:

maxCommitTime - long

Returns:

Long