senselogic.sitevision.api.security

Interface PermissionUtil

@Requireable(value="PermissionUtil")
public interface PermissionUtil

Permissions utilities interface for checking permissions.

An instance of the SiteVision class implementing this interface can be obtained via Utils.getPermissionUtil(). See Utils for how to obtain an instance of the Utils interface.

Since:

SiteVision 2.6

Author:

Magnus Lövgren

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PermissionUtil.Permission The named permission demarcation, used by PermissionUtil.

Method Summary

Modifier and Type	Method and Description
boolean	hasAnonymousReadPermission() Checks if a non-authenticated user has read permission on current page.
boolean	hasAnonymousReadPermission(Node aPageNode) Checks if a non-authenticated user has read permission on a certain page tree node.
boolean	hasCreateArchivePermission(Node aParentNode, Node aUserNode) Checks if a certain user has create archive permission on a certain page tree node.
boolean	hasCreateArticlePermission(Node aParentNode, Node aUserNode) Checks if a certain user has create article permission on a certain page tree node.
boolean	hasCreateFolderPermission(Node aParentNode, Node aUserNode) Checks if a certain user has create folder permission on a certain page tree node.
boolean	hasCreatePagePermission(Node aParentNode, Node aUserNode) Checks if a certain user has create page permission on a certain page tree node.
boolean	hasDeletePermission(Node aNode, Node aUserNode) Checks if a certain user has delete permission on a certain page tree node.
boolean	hasPermission(Node aNode, Node aUserNode, PermissionUtil.Permission aPermission) Checks if a certain user has a certain permission on a certain node.
boolean	hasPermission(Node aNode, PermissionUtil.Permission aPermission) Checks if current user has certain permission on a certain node.
boolean	hasPermission(PermissionUtil.Permission aPermission) Checks if current user has a certain permission on current page.
boolean	hasPermissions(Node aNode, Node aUserNode, PermissionUtil.Permission... aPermissions) Checks if a certain user has certain permissions on a certain node.
boolean	hasPermissions(Node aNode, PermissionUtil.Permission... aPermissions) Checks if current user has certain permissions on a certain node.
boolean	hasPermissions(PermissionUtil.Permission... aPermissions) Checks if current user has certain permissions on current page.
boolean	hasPublishPermission(Node aNode, Node aUserNode) Checks if a certain user has publish permission on a certain page tree node.
boolean	hasReadPermission() Checks if current user has read permission on current page.
boolean	hasReadPermission(Node aPageNode, Node aUserNode) Checks if a certain user has read permission on a certain page tree node.
boolean	hasWritePermission() Checks if current user has write permission (i.e. permission to edit page content) on current page.
boolean	hasWritePermission(Node aPageNode, Node aUserNode) Checks if a certain user has write permission (i.e. permission to edit page content) on a certain page tree node.
boolean	hasWriteSubscriptionPermission(Node aNode, Node aUserNode) Checks if a certain user has write subscription permission on a certain page tree node.

Method Detail

hasAnonymousReadPermission

boolean hasAnonymousReadPermission()

Checks if a non-authenticated user has read permission on current page.

Returns:

true if an anonymous user has read permission on current page (e.g. "page is public"), false if not or if indeterminable (i.e. current page can not be determined)

Since:

SiteVision 2.6.2_05

hasAnonymousReadPermission

boolean hasAnonymousReadPermission(Node aPageNode)

Checks if a non-authenticated user has read permission on a certain page tree node.

Note! If you want to check if an anonymous user has read permissions on current page, you should use the hasAnonymousReadPermission() method instead.

Parameters:

aPageNode - a node in the page tree

Returns:

true if an anonymous user has read permission on aPageNode (e.g. "page is public"), false if not or if indeterminable (i.e. aPageNode is not a page tree node)

Since:

SiteVision 2.6.2_05

See Also:

hasAnonymousReadPermission()

hasReadPermission

boolean hasReadPermission()

Checks if current user has read permission on current page.

Returns:

true if current user has read permission on current page, false if not or if indeterminable (i.e. current user or current page can not be determined)

hasReadPermission

boolean hasReadPermission(Node aPageNode,
                          Node aUserNode)

Checks if a certain user has read permission on a certain page tree node.

Note! If you want to check if current user has read permissions on current page, you should use the hasReadPermission() method instead.

Parameters:

aPageNode - a node in the page tree

aUserNode - a user node (or a user identity node)

Returns:

true if aUserNode has read permission on aPageNode, false if not or if indeterminable (i.e. aPageNode is not a page tree node or aUserNode is not a user)

See Also:

hasReadPermission()

hasWritePermission

boolean hasWritePermission()

Checks if current user has write permission (i.e. permission to edit page content) on current page.

Note! This method is appropriate to use in all your custom portlets that uses the SiteVision "config" portlet mode. Use this method to ensure that only users with write permissions can access the SiteVision config mode and save portlet preferences.

Returns:

true if current user has write permission on current page, false if not

hasWritePermission

boolean hasWritePermission(Node aPageNode,
                           Node aUserNode)

Checks if a certain user has write permission (i.e. permission to edit page content) on a certain page tree node.

Note! If you want to check if current user has write permissions on current page, you should use the hasWritePermission() method instead.

Parameters:

aPageNode - a node in the page tree

aUserNode - a user node (or a user identity node)

Returns:

true if aUserNode has write permission on aPageNode, false if not or if indeterminable (i.e. aPageNode is not a page tree node or aUserNode is not a user)

See Also:

hasWritePermission()

hasPublishPermission

boolean hasPublishPermission(Node aNode,
                             Node aUserNode)

Checks if a certain user has publish permission on a certain page tree node.

Parameters:

aNode - a publishable node in the page tree

aUserNode - a user node (or a user identity node)

Returns:

true if aUserNode has publish permission on aNode, false if not or if indeterminable (i.e. aNode is not a publishable page tree node or aUserNode is not a user)

Since:

SiteVision 2.6.1_04

hasWriteSubscriptionPermission

boolean hasWriteSubscriptionPermission(Node aNode,
                                       Node aUserNode)

Checks if a certain user has write subscription permission on a certain page tree node.

Parameters:

aNode - a subscriptionable node in the page tree

aUserNode - a user node (or a user identity node)

Returns:

true if aUserNode has write subscription permission on aNode, false if not or if indeterminable (i.e. aNode is not a subscriptionable page tree node or aUserNode is not a user)

Since:

SiteVision 2.6.2_05

hasDeletePermission

boolean hasDeletePermission(Node aNode,
                            Node aUserNode)

Checks if a certain user has delete permission on a certain page tree node.

Parameters:

aNode - a page tree node

aUserNode - a user node (or a user identity node)

Returns:

true if aUserNode has delete permission on aNode, false if not or if indeterminable (i.e. aNode is not a page tree node or aUserNode is not a user)

Since:

SiteVision 2.6.1_04

hasCreatePagePermission

boolean hasCreatePagePermission(Node aParentNode,
                                Node aUserNode)

Checks if a certain user has create page permission on a certain page tree node.

Parameters:

aParentNode - a parent node (the parent of the page that should be created)

aUserNode - a user node (or a user identity node)

Returns:

true if aUserNode has create page permission on aParentNode, false if not or if indeterminable (i.e. aParentNode is not a page tree node that can have a page as child or aUserNode is not a user)

Since:

SiteVision 2.6.1_04

hasCreateArticlePermission

boolean hasCreateArticlePermission(Node aParentNode,
                                   Node aUserNode)

Checks if a certain user has create article permission on a certain page tree node.

Parameters:

aParentNode - a parent node (the parent of the article that should be created)

aUserNode - a user node (or a user identity node)

Returns:

true if aUserNode has create article permission on aParentNode, false if not or if indeterminable (i.e. aParentNode is not a page tree node that can have an article as child or aUserNode is not a user)

Since:

SiteVision 2.6.1_04

hasCreateArchivePermission

boolean hasCreateArchivePermission(Node aParentNode,
                                   Node aUserNode)

Checks if a certain user has create archive permission on a certain page tree node.

Parameters:

aParentNode - a parent node (the parent of the archive that should be created)

aUserNode - a user node (or a user identity node)

Returns:

true if aUserNode has create archive permission on aParentNode, false if not or if indeterminable (i.e. aParentNode is not a page tree node that can have an archive as child or aUserNode is not a user)

Since:

SiteVision 2.6.1_04

hasCreateFolderPermission

boolean hasCreateFolderPermission(Node aParentNode,
                                  Node aUserNode)

Checks if a certain user has create folder permission on a certain page tree node.

Parameters:

aParentNode - a parent node (the parent of the folder that should be created)

aUserNode - a user node (or a user identity node)

Returns:

true if aUserNode has create folder permission on aParentNode, false if not or if indeterminable (i.e. aParentNode is not a page tree node that can have a folder as child or aUserNode is not a user)

Since:

SiteVision 2.6.1_04

hasPermission

boolean hasPermission(PermissionUtil.Permission aPermission)

Checks if current user has a certain permission on current page.

Parameters:

aPermission - the permission to check

Returns:

true if current user has aPermission on current page, false if not or if indeterminable (e.g. current user or current page can not be determined)

Since:

SiteVision 3.6

hasPermissions

boolean hasPermissions(PermissionUtil.Permission... aPermissions)

Checks if current user has certain permissions on current page.

Parameters:

aPermissions - the permissions to check

Returns:

true if current user has aPermissions on current page, false if not or if indeterminable (e.g. current user or current page can not be determined)

Since:

SiteVision 3.6

hasPermission

boolean hasPermission(Node aNode,
                      PermissionUtil.Permission aPermission)

Checks if current user has certain permission on a certain node.

Parameters:

aNode - the page node

aPermission - the permission to check

Returns:

true if current user has aPermission on aNode, false if not or if indeterminable (e.g. current user can not be determined)

Since:

SiteVision 3.6

hasPermissions

boolean hasPermissions(Node aNode,
                       PermissionUtil.Permission... aPermissions)

Checks if current user has certain permissions on a certain node.

Parameters:

aNode - the page node

aPermissions - the permissions to check

Returns:

true if current user has aPermissions on aNode, false if not or if indeterminable (e.g. current user can not be determined)

Since:

SiteVision 3.6

hasPermission

boolean hasPermission(Node aNode,
                      Node aUserNode,
                      PermissionUtil.Permission aPermission)

Checks if a certain user has a certain permission on a certain node.

Parameters:

aNode - the page node

aUserNode - a user node (or a user identity node)

aPermission - the permission to check

Returns:

true if aUserNode has aPermission on aNode, false if not or if indeterminable

Since:

SiteVision 3.6

hasPermissions

boolean hasPermissions(Node aNode,
                       Node aUserNode,
                       PermissionUtil.Permission... aPermissions)

Checks if a certain user has certain permissions on a certain node.

Parameters:

aNode - the page node

aUserNode - a user node (or a user identity node)

aPermissions - the permissions to check

Returns:

true if aUserNode has aPermissions on aNode, false if not or if indeterminable

Since:

SiteVision 3.6