lumis.portal.acl

Interface IPortalAclManager

All Superinterfaces:

IAclManager, IConfigKeyChecker

All Known Implementing Classes:

PortalAclManager

@StableMinor(version="12.5",
             sinceVersion="4.0")
public interface IPortalAclManager
extends IAclManager

Since:

4.0.0

Version:

$Revision: 24140 $ $Date: 2020-09-14 21:50:42 +0000 (Mon, 14 Sep 2020) $

Field Summary

Fields

Modifier and Type	Field and Description
static int	PERMISSION_DEFAULT
static String	PORTAL_ACL_ID

Method Summary

Modifier and Type	Method and Description
boolean	checkPermission(SessionConfig sessionConfig, IPermission permission, ITransaction transaction) This method verifies if the permission is valid.
AccessControlList	get(SessionConfig sessionConfig, ITransaction transaction) Get the Portal's Access Control List.
void	update(SessionConfig sessionConfig, AccessControlList acl, ITransaction transaction) Update the Portal'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

PORTAL_ACL_ID

static final String PORTAL_ACL_ID

See Also:

Constant Field Values

PERMISSION_DEFAULT

static final int PERMISSION_DEFAULT

See Also:

Constant Field Values

Method Detail

get

AccessControlList get(SessionConfig sessionConfig,
                      ITransaction transaction)
               throws PortalException

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

Parameters:

sessionConfig -

transaction -

Returns:

Return the Access Control List of the user.

Throws:

PortalException

update

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

Update the Portal's ACL. To access this method, the user needs the PERMISSION_TYPE_MANAGE_PORTAL_SECURITY permission.

Parameters:

sessionConfig -

acl -

transaction -

Throws:

PortalException

checkPermission

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

This method verifies if the permission is valid.

Parameters:

sessionConfig -

permission -

transaction -

Returns:

Returns true if the permission is valid and false it is denied.

Throws:

ManagerException

PortalException