Package lumis.portal.page.template.acl

Interface IPageTemplateAclManager

All Superinterfaces:

IAclManager, IConfigKeyChecker

All Known Implementing Classes:

PageTemplateAclManager

@StableMinor(version="14.0",
             sinceVersion="4.0")
public interface IPageTemplateAclManager
extends IAclManager

Since:

4.0.0

Version:

$Revision: 24477 $ $Date: 2021-04-28 11:30:36 -0300 (Wed, 28 Apr 2021) $

Field Summary

Fields

Modifier and Type	Field	Description
static int	PERMISSION_DEFAULT

Method Summary

Modifier and Type	Method	Description
void	add(SessionConfig sessionConfig, PageConfig pageConfig, ITransaction transaction)	Add an Access Control List to the Page.
AccessControlList	get(SessionConfig sessionConfig, String pageTemplateId, ITransaction transaction)	Get the Page Template's Access Control List.
void	parentAclUpdated(SessionConfig sessionConfig, String parentChannelId, AccessControlList parentChannelAcl, ITransaction transaction)	Update Page Template's inheriting permissions.
void	setInheritance(SessionConfig sessionConfig, String pageId, boolean inherit, ITransaction transaction)	Specifies if the page template inherits its parent channel`s ACL.
void	update(SessionConfig sessionConfig, String pageTemplateId, AccessControlList acl, ITransaction transaction)	Update the Page Template's ACL.

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

Field Detail

PERMISSION_DEFAULT

static final int PERMISSION_DEFAULT

See Also:

Constant Field Values

Method Detail

add

void add(SessionConfig sessionConfig,
         PageConfig pageConfig,
         ITransaction transaction)
  throws ManagerException,
         PortalException

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

Parameters:

sessionConfig -

pageConfig -

transaction -

Throws:

ManagerException

PortalException

get

AccessControlList get(SessionConfig sessionConfig,
                      String pageTemplateId,
                      ITransaction transaction)
               throws ManagerException,
                      PortalException

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

Parameters:

sessionConfig -

pageTemplateId -

transaction -

Returns:

Returns the AccessControlList.

Throws:

ManagerException

PortalException

update

void update(SessionConfig sessionConfig,
            String pageTemplateId,
            AccessControlList acl,
            ITransaction transaction)
     throws ManagerException,
            PortalException

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

Parameters:

sessionConfig -

pageTemplateId -

acl -

transaction -

Throws:

ManagerException

PortalException

setInheritance

void setInheritance(SessionConfig sessionConfig,
                    String pageId,
                    boolean inherit,
                    ITransaction transaction)
             throws ManagerException,
                    PortalException

Specifies if the page template inherits its parent channel`s ACL. To access this method, the user needs the PERMISSION_TYPE_MANAGE_PAGE_TEMPLATE_SECURITY permission in the page template.

Parameters:

sessionConfig -

pageId -

inherit -

transaction -

Throws:

ManagerException

PortalException

parentAclUpdated

void parentAclUpdated(SessionConfig sessionConfig,
                      String parentChannelId,
                      AccessControlList parentChannelAcl,
                      ITransaction transaction)
               throws ManagerException,
                      PortalException

Update Page Template's inheriting permissions. To access this method, the user needs the PERMISSION_TYPE_MANAGE_PAGE_TEMPLATE_SECURITY permission in the page.

Parameters:

sessionConfig -

parentChannelId -

parentChannelAcl -

transaction -

Throws:

ManagerException

PortalException