Package lumis.portal.page.acl

Class PageAclManager

java.lang.Object

lumis.util.security.acl.AclManager

lumis.portal.page.acl.PageAclManager

All Implemented Interfaces:

IPageAclManager, IConfigKeyChecker, IAclManager

public class PageAclManager
extends AclManager
implements IPageAclManager

Manager for Page's Acl operations

Since:

4.0.0

Version:

$Revision: 23244 $ $Date: 2019-10-04 18:53:23 -0300 (Fri, 04 Oct 2019) $

Field Summary

Fields inherited from class lumis.util.security.acl.AclManager

aclCache, checkRequiredPermissionsInternalFlag

Fields inherited from interface lumis.portal.page.acl.IPageAclManager

PERMISSION_DEFAULT

Constructor Summary

Constructors

Constructor	Description
PageAclManager()

Method Summary

Modifier and Type	Method	Description
java.lang.String	add(SessionConfig sessionConfig, PageConfig pageConfig, ITransaction transaction)	Add an Access Control List to the Page.
void	checkRequiredPermissions(AccessControlList acl)	Checks if the required permissions were given for someone.
AccessControlList	get(SessionConfig sessionConfig, java.lang.String pageId, ITransaction transaction)	Get the Page's Access Control List.
protected AccessControlList	getAclInternal(SessionConfig sessionConfig, java.lang.String pageId, ITransaction transaction)
protected int	getRequiredPermissions()
void	update(SessionConfig sessionConfig, java.lang.String pageId, AccessControlList acl, ITransaction transaction)	Update the Page's ACL.

Methods inherited from class lumis.util.security.acl.AclManager

add, add, addOrUpdate, checkPermission, checkPermission, checkRequiredPermissionsInternal, cleanupInvalidData, clearCache, delete, deleteAclEntryByPrincipalId, deserialize, exists, keyExists, removeFromCache, serialize, update

Methods inherited from class java.lang.Object

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

Methods inherited from interface lumis.util.security.acl.IAclManager

add, addOrUpdate, checkPermission, checkPermission, clearCache, delete, deleteAclEntryByPrincipalId, deserialize, exists, removeFromCache, serialize

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

keyExists

Constructor Detail

PageAclManager

public PageAclManager()

Method Detail

add

public java.lang.String add(SessionConfig sessionConfig,
                            PageConfig pageConfig,
                            ITransaction transaction)
                     throws ManagerException,
                            PortalException

Description copied from interface: IPageAclManager

Add an Access Control List to the Page. To access this method, the user needs the PERMISSION_TYPE_MANAGE_PAGE_SECURITY permission in the page.

Specified by:

add in interface IPageAclManager

Returns:

a String.

Throws:

ManagerException

PortalException

get

public AccessControlList get(SessionConfig sessionConfig,
                             java.lang.String pageId,
                             ITransaction transaction)
                      throws ManagerException,
                             PortalException

Description copied from interface: IPageAclManager

Get the Page's Access Control List. To access this method, the user needs the PERMISSION_TYPE_VIEW_PAGE permission in the page.

Specified by:

get in interface IPageAclManager

Specified by:

get in class AclManager

Returns:

a AccessControlList.

Throws:

ManagerException

PortalException

update

public void update(SessionConfig sessionConfig,
                   java.lang.String pageId,
                   AccessControlList acl,
                   ITransaction transaction)
            throws ManagerException,
                   PortalException

Description copied from interface: IPageAclManager

Update the Page's ACL. To access this method, the user needs the PERMISSION_TYPE_MANAGE_PAGE_SECURITY permission in the page.

Specified by:

update in interface IPageAclManager

Throws:

ManagerException

PortalException

getAclInternal

protected AccessControlList getAclInternal(SessionConfig sessionConfig,
                                           java.lang.String pageId,
                                           ITransaction transaction)
                                    throws ManagerException,
                                           PortalException

Specified by:

getAclInternal in class AclManager

Throws:

ManagerException

PortalException

getRequiredPermissions

protected int getRequiredPermissions()
                              throws PortalException

Specified by:

getRequiredPermissions in class AclManager

Throws:

PortalException

checkRequiredPermissions

public void checkRequiredPermissions(AccessControlList acl)
                              throws PortalException

Description copied from interface: IPageAclManager

Checks if the required permissions were given for someone. If not an exception is thrown.

Specified by:

checkRequiredPermissions in interface IPageAclManager

Parameters:

acl - the acl to be checked.

Throws:

PortalException - if the required permissions were not given.