lumis.util.security.acl
Interface IAclManager

All Superinterfaces:

IConfigKeyChecker

All Known Subinterfaces:

IChannelAclManager, IGenericAclManager, IGroupAclManager, IPageAclManager, IPageTemplateAclManager, IPortalAclManager, IServiceAclManager, IServiceInstanceAclManager

All Known Implementing Classes:

AclManager, ChannelAclManager, GenericAclManager, GroupAclManager, PageAclManager, PageTemplateAclManager, PortalAclManager, ServiceAclManager, ServiceInstanceAclManager

public interface IAclManager
extends IConfigKeyChecker

Interface common to all acl managers. Specific acl manager interfaces should extend this one.

Since:

4.0.0

Method Summary

void	add(AccessControlList acl, ITransaction transaction)
void	addOrUpdate(AccessControlList acl, ITransaction transaction)
boolean	checkPermission(SessionConfig sessionConfig, String itemId, IPermission permission, ITransaction transaction) Verify if the permission is valid for the sessionConfig's user.
boolean	checkPermission(SessionConfig sessionConfig, String userId, String itemId, IPermission permission, ITransaction transaction) Verify if the permission if valid for the specified userId.
void	clearCache(ITransaction transaction) Clears all ACL cache.
void	delete(String aclId, ITransaction transaction) Deletes an acl.
void	deleteAclEntryByPrincipalId(String principalId, ITransaction transaction) Delete ACL entries in all ACLs for the specified principal.
String	deserialize(SessionConfig sessionConfig, DeserializationConfig deserializationConfig, Node accessControlListNode, boolean onlyAddSimpleAcls, ITransaction transaction)
boolean	exists(String aclId, ITransaction transaction)
void	removeFromCache(String aclId, ITransaction transaction) Allows removal of cached items
void	serialize(SessionConfig sessionConfig, String securableId, OutputStream outputStream, ITransaction transaction)

Methods inherited from interface lumis.portal.serialization.operation.IConfigKeyChecker

keyExists

Method Detail

serialize

void serialize(SessionConfig sessionConfig,
               String securableId,
               OutputStream outputStream,
               ITransaction transaction)
               throws ManagerException,
                      PortalException

Throws:

ManagerException

PortalException

deserialize

String deserialize(SessionConfig sessionConfig,
                   DeserializationConfig deserializationConfig,
                   Node accessControlListNode,
                   boolean onlyAddSimpleAcls,
                   ITransaction transaction)
                   throws ManagerException,
                          PortalException

Throws:

ManagerException

PortalException

checkPermission

boolean checkPermission(SessionConfig sessionConfig,
                        String itemId,
                        IPermission permission,
                        ITransaction transaction)
                        throws ManagerException,
                               PortalException

Verify if the permission is valid for the sessionConfig's user.

Parameters:

sessionConfig -

channelId -

permission -

transaction -

Returns:

Returns the true or false value.

Throws:

ManagerException

PortalException

checkPermission

boolean checkPermission(SessionConfig sessionConfig,
                        String userId,
                        String itemId,
                        IPermission permission,
                        ITransaction transaction)
                        throws ManagerException,
                               PortalException

Verify if the permission if valid for the specified userId.

Parameters:

sessionConfig -

userId -

itemId -

permission -

transaction -

Returns:

Throws:

ManagerException

PortalException

delete

void delete(String aclId,
            ITransaction transaction)
            throws PortalException

Deletes an acl.

This method does not delete the acl's children. They must have been deleted or the foreign key constraints will not allow their parent to be deleted.

Parameters:

aclId - the id of the acl to be deleted from persistence.

transaction - the transaction for persistence access.

Throws:

PortalException

removeFromCache

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

Allows removal of cached items

Parameters:

aclId -

transaction -

Throws:

DaoException

PortalException

clearCache

void clearCache(ITransaction transaction)
                throws PortalException

Clears all ACL cache.

Parameters:

transaction - the transaction for persistence access. If null, the cache is just cleared, else it is cleared as a transactional operation as specified in PortalCache.clear(ITransaction).

Throws:

PortalException

Since:

4.1.0

deleteAclEntryByPrincipalId

void deleteAclEntryByPrincipalId(String principalId,
                                 ITransaction transaction)
                                 throws PortalException

Delete ACL entries in all ACLs for the specified principal.

Parameters:

principalId -

transaction -

Throws:

DaoException

PortalException

addOrUpdate

void addOrUpdate(AccessControlList acl,
                 ITransaction transaction)
                 throws ManagerException,
                        PortalException

Throws:

ManagerException

PortalException

add

void add(AccessControlList acl,
         ITransaction transaction)
         throws PortalException

Throws:

PortalException

exists

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

Throws:

DaoException

PortalException