IAccessControlDao

All Known Implementing Classes:

AccessControlDaoJdbc
```
public interface IAccessControlDao
```
Dao Interface for ACL entity

Since:

4.0.7

Version:

$Revision: 10825 $ $Date: 2009-08-04 15:36:40 +0000 (Tue, 04 Aug 2009) $

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`add(AccessControlList acl, ITransaction transaction)` Add the ACL (Access Control List).
`void`	`addAclEntry(String parentAclId, AccessControlEntry aclEntry, ITransaction transaction)` Add the ACL entry.
`void`	`delete(String aclId, ITransaction transaction)` Delete the ACL entry.
`void`	`deleteAclEntry(String aclId, String principalId, ITransaction transaction)` Delete the ACL entry.
`void`	`deleteAclEntryByPrincipalId(String principalId, ITransaction transaction)` Delete the ACL list for the specified principal.
`void`	`deleteInheritingEntriesWithoutParent(ITransaction transaction)` Deletes all inheriting ACL entries that does not have a parent to inherit from.
`boolean`	`exists(String aclId, ITransaction transaction)`
`AccessControlList`	`get(String aclId, ITransaction transaction)` Get the ACL (Access Control List).
`Collection<String>`	`getAclIdsByPrincipalId(String principalId, ITransaction transaction)` Get the ACL list for the specified principal.
`Collection<String>`	`getIdsByParentId(String parentId, ITransaction transaction)` Return the Ids of the ACLs that has the given parentId.
`void`	`update(AccessControlList acl, ITransaction transaction)` Update the ACL (Access Control List).

Method Detail

add

void add(AccessControlList acl,
         ITransaction transaction)
  throws DaoException,
         PortalException

Add the ACL (Access Control List).

Parameters:: acl -; transaction -
Throws:: DaoException; PortalException

get

AccessControlList get(String aclId,
                      ITransaction transaction)
               throws DaoException,
                      PortalException

Get the ACL (Access Control List).

Parameters:: aclId -; transaction -
Returns:
Throws:: DaoException; PortalException

update

void update(AccessControlList acl,
            ITransaction transaction)
     throws DaoException,
            PortalException

Update the ACL (Access Control List).

Parameters:: acl -; transaction -
Throws:: DaoException; PortalException

getIdsByParentId

Collection<String> getIdsByParentId(String parentId,
                                    ITransaction transaction)
                             throws PortalException

Return the Ids of the ACLs that has the given parentId.

Parameters:: parentId - the parent Id.; transaction - the transaction for data access.
Returns:: the Ids.
Throws:: PortalException

delete

void delete(String aclId,
            ITransaction transaction)
     throws DaoException,
            PortalException

Delete the ACL entry.

Parameters:: aclId -; transaction -
Throws:: DaoException; PortalException

addAclEntry

void addAclEntry(String parentAclId,
                 AccessControlEntry aclEntry,
                 ITransaction transaction)
          throws DaoException,
                 PortalException

Add the ACL entry.

Parameters:: parentAclId -; aclEntry -; transaction -
Throws:: DaoException; PortalException

deleteAclEntry

void deleteAclEntry(String aclId,
                    String principalId,
                    ITransaction transaction)
             throws DaoException,
                    PortalException

Delete the ACL entry.

Parameters:: aclId -; principalId -; transaction -
Throws:: DaoException; PortalException

getAclIdsByPrincipalId

Collection<String> getAclIdsByPrincipalId(String principalId,
                                          ITransaction transaction)
                                   throws DaoException,
                                          PortalException

Get the ACL list for the specified principal.

Parameters:: principalId -; transaction -
Throws:: DaoException; PortalException

deleteAclEntryByPrincipalId

void deleteAclEntryByPrincipalId(String principalId,
                                 ITransaction transaction)
                          throws DaoException,
                                 PortalException

Delete the ACL list for the specified principal.

Parameters:: principalId -; transaction -
Throws:: DaoException; PortalException

exists

boolean exists(String aclId,
               ITransaction transaction)
        throws DaoException,
               PortalException

Throws:: DaoException; PortalException

deleteInheritingEntriesWithoutParent
```
void deleteInheritingEntriesWithoutParent(ITransaction transaction)
                                   throws PortalException
```
Deletes all inheriting ACL entries that does not have a parent to inherit from.

Parameters:

transaction - the transaction for persistence access.

Throws:

PortalException

Since:

5.0.0

Interface IAccessControlDao