Files
alfresco-community-repo/source/java/org/alfresco/repo/domain/permissions/AclCrudDAO.java
Raluca Munteanu 6afb44e712 Merged 5.1.N (5.1.2) to 5.2.N (5.2.1)
125606 rmunteanu: Merged 5.1.1 (5.1.1) to 5.1.N (5.1.2)
      125515 slanglois: MNT-16155 Update source headers - add new Copyrights for Java and JSP source files + automatic check in the build


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/DEV/5.2.N/root@125788 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2016-04-26 13:45:01 +00:00

140 lines
5.3 KiB
Java

/*
* #%L
* Alfresco Repository
* %%
* Copyright (C) 2005 - 2016 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* If the software was purchased under a paid Alfresco license, the terms of
* the paid license agreement will prevail. Otherwise, the software is
* provided under the following open source license terms:
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
* #L%
*/
package org.alfresco.repo.domain.permissions;
import java.util.List;
import java.util.Map;
import org.alfresco.repo.security.permissions.ACEType;
import org.alfresco.repo.security.permissions.PermissionReference;
import org.alfresco.service.cmr.security.AccessStatus;
import org.alfresco.service.namespace.QName;
import org.alfresco.util.Pair;
/**
* This provides basic services such as caching, but defers to the underlying implementation
* for CRUD operations.
*
* <b>alf_access_control_list</b>
* <b>alf_acl_member</b>
* <b>alf_acl_change_set</b>
* <b>alf_access_control_entry</b>
* <b>alf_ace_context</b>
* <b>alf_permission</b>
* <b>alf_authority</b>
* <b>alf_authority_alias</b>
*
* @since 3.4
* @author janv
*/
public 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.
*/
public void setCheckAclConsistency();
//
// Access Control List (ACL)
//
public Acl createAcl(AclEntity entity);
public Acl getAcl(Long aclEntityId);
public AclUpdateEntity getAclForUpdate(long aclEntityId);
public List<Long> getAclsThatInheritFromAcl(long aclEntityId);
public Long getLatestAclByGuid(String aclGuid);
public void updateAcl(AclUpdateEntity entity);
public void deleteAcl(long aclEntityId);
public List<Long> getADMNodesByAcl(long aclEntityId, int maxResults);
//
// Access Control Entry (ACE)
//
public Ace createAce(Permission permission, Authority authority, ACEType type, AccessStatus accessStatus);
public Ace getAce(Permission permission, Authority authority, ACEType type, AccessStatus accessStatus);
public Ace getAce(long aceEntityId);
public Ace getOrCreateAce(Permission permission, Authority authority, ACEType type, AccessStatus accessStatus);
public List<Ace> getAcesByAuthority(long authorityEntityId);
public List<Map<String, Object>> getAcesAndAuthoritiesByAcl(long aclEntityId);
public int deleteAces(List<Long> aceEntityIds);
//
// ACL Change Set
//
public Long createAclChangeSet();
public void updateAclChangeSet(Long aclChangeSetEntityId, long commitTimeMs);
public AclChangeSet getAclChangeSet(Long aclChangeSetEntityId);
public void deleteAclChangeSet(Long aclChangeSetEntityId);
//
// ACL Member
//
public void addAclMembersToAcl(long aclId, List<Long> aceIds, int depth);
public void addAclMembersToAcl(long aclId, List<Pair<Long, Integer>> aceIdsWithDepths);
public List<AclMember> getAclMembersByAcl(long aclEntityId);
public List<AclMemberEntity> getAclMembersByAclForUpdate(long aclEntityId);
public List<AclMember> getAclMembersByAuthority(String authorityName);
public void updateAclMember(AclMemberEntity entity);
public int deleteAclMembers(List<Long> aclMemberIds);
public int deleteAclMembersByAcl(long aclEntityId);
//
// Permission
//
public Permission createPermission(PermissionReference permissionReference);
public Permission getPermission(long permissionEntityId);
public Permission getPermission(PermissionReference permissionReference);
public Permission getOrCreatePermission(PermissionReference permissionReference);
public void renamePermission(QName oldTypeQName, String oldName, QName newTypeQName, String newName);
public void deletePermission(long permissionEntityId);
//
// Authority
//
public Authority getAuthority(long authorityEntityId);
public Authority getAuthority(String authorityName);
public Authority getOrCreateAuthority(String authorityName);
public void renameAuthority(String authorityNameBefore, String authorityAfter);
public void deleteAuthority(long authorityEntityId);
/**
* @return Long
*/
public Long getMaxChangeSetCommitTime();
/**
* @param maxCommitTime long
* @return Long
*/
public Long getMaxChangeSetIdByCommitTime(long maxCommitTime);
// AceContext (NOTE: currently unused - intended for possible future enhancement)
// AuthorityAlias (NOTE: currently unused - intended for possible future enhancement)
}