Package lumis.portal.channel.acl

Interface IChannelAclManager

All Superinterfaces:

IAclManager, IConfigKeyChecker

All Known Implementing Classes:

ChannelAclManager

@StableMinor(version="16.1",
             sinceVersion="4.0")
public interface IChannelAclManager
extends IAclManager

Since:

4.0.0

Version:

$Revision: 26156 $ $Date: 2024-01-13 10:26:46 -0300 (Sat, 13 Jan 2024) $

Field Summary

Fields

Modifier and Type	Field	Description
static int	PERMISSION_DEFAULT

Method Summary

Modifier and Type	Method	Description
java.lang.String	add(SessionConfig sessionConfig, ChannelConfig channelConfig, ITransaction transaction)	Add an Access Control List to the Channel.
void	checkRequiredPermissions(AccessControlList acl)	Checks if the required permissions were given for someone.
AccessControlList	get(SessionConfig sessionConfig, java.lang.String channelId, ITransaction transaction)	Get the Channel's Access Control List Channel.
void	update(SessionConfig sessionConfig, java.lang.String channelId, AccessControlList acl, ITransaction transaction)	Update the Channel'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

Method Detail

add

java.lang.String add(SessionConfig sessionConfig,
                     ChannelConfig channelConfig,
                     ITransaction transaction)
              throws ManagerException,
                     PortalException

Add an Access Control List to the Channel. To access this method, the user needs the PERMISSION_TYPE_MANAGE_CHANNEL_SECURITY permission in the channel.

Parameters:

sessionConfig -

channelConfig -

transaction -

Returns:

Returns the aclID of the channel.

Throws:

ManagerException

PortalException

get

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

Get the Channel's Access Control List Channel. To access this method, the user needs the PERMISSION_TYPE_MANAGE_CHANNEL_SECURITY permission in the channel.

Parameters:

sessionConfig -

channelId -

transaction -

Returns:

Returns the channel's ACL.

Throws:

ManagerException

PortalException

update

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

Update the Channel's ACL. To access this method, the user needs the PERMISSION_TYPE_MANAGE_CHANNEL_SECURITY permission in the channel.

Parameters:

sessionConfig -

channelId -

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.