lumis.portal.page.acl
Interface IPageAclManager

Package class diagram package IPageAclManager
All Superinterfaces:
IAclManager, IConfigKeyChecker
All Known Implementing Classes:
PageAclManager

@StableMinor(version="6.2",
             sinceVersion="4.0")
public interface IPageAclManager
extends IAclManager

Since:
4.0.0

Field Summary
static int PERMISSION_DEFAULT
           
 
Method Summary
 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, String pageId, ITransaction transaction)
          Get the Page's Access Control List.
 void update(SessionConfig sessionConfig, String pageId, AccessControlList acl, ITransaction transaction)
          Update the Page'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

String 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_SECURITY permission in the page.

Parameters:
sessionConfig -
pageConfig -
transaction -
Returns:
a String.
Throws:
ManagerException
PortalException

get

AccessControlList get(SessionConfig sessionConfig,
                      String pageId,
                      ITransaction transaction)
                      throws ManagerException,
                             PortalException
Get the Page's Access Control List. To access this method, the user needs the PERMISSION_TYPE_VIEW_PAGE permission in the page.

Parameters:
sessionConfig -
pageId -
transaction -
Returns:
a AccessControlList.
Throws:
ManagerException
PortalException

update

void update(SessionConfig sessionConfig,
            String pageId,
            AccessControlList acl,
            ITransaction transaction)
            throws ManagerException,
                   PortalException
Update the Page's ACL. To access this method, the user needs the PERMISSION_TYPE_MANAGE_PAGE_SECURITY permission in the page.

Parameters:
sessionConfig -
pageId -
acl -
transaction -
Throws:
ManagerException
PortalException

checkRequiredPermissions

void checkRequiredPermissions(AccessControlList acl)
                              throws PortalException
Checks if the required permissions were given for someone. If not an exception is thrown.

Parameters:
acl - the acl to be checked.
Throws:
PortalException - if the required permissions were not given.


Lumisportal  6.2.0.120405 - Copyright © 2006–2012 Lumis EIP Tecnologia da Informação LTDA. All Rights Reserved.