com.canto.cumulus.db.permissions

Class PermissionManager

java.lang.Object

com.canto.cumulus.db.permissions.PermissionManager

public class PermissionManager
extends java.lang.Object

Manager to create, list and delete permissions.

Since:

8.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	SOURCE_TYPE_CATALOG
static int	SOURCE_TYPE_CATEGORY
static int	SOURCE_TYPE_ITEM
static int	SOURCE_TYPE_RECORD
static java.lang.String	UUID_CURRENT_USER Static key for the Current User.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyPermissionTemplate(CategoryItem categoryItem, PermissionTemplate permissionTemplate) Applies the given permission template on to the given category.
void	applyPermissionTemplate(Item item, PermissionTemplate permissionTemplate) Applies the given permission template on to the given record.
User	getCurrentUserTemplate() Returns a descriptor for the 'Current User' which is a placeholder for permission template where this user will be replaced by the user applying the template.
static PermissionManager	getInstance(Server server) Returns a permission manager singleton instance for the given server connection.
Permissions	getPermissions(Item item) Returns the permissions for the given record item.
PermissionsList	getPermissionsList(Item item) Returns a permissions list containing only the permissions for the specified record item.
PermissionsList	getPermissionsList(ItemCollection itemCollection, java.util.Set<ItemIdentifier> idList) Returns a permissions list for a number of records.
PermissionsList	getPermissionsList(MultiItemCollection multiItemCollection, java.util.Set<ItemIdentifier> idList) Returns a permissions list for a number of records.
PermissionsList	getPermissionsList(java.lang.String tableName, java.util.Set<ItemIdentifier> idList) Returns a permissions list for a number of records.
Roles	getRoles() Returns the list of roles available at the server.
Server	getServer() Returns the server of this instance.
User	getUserByLoginName(java.lang.String loginName) Returns a user by his login name.
Users	getUsers(java.lang.String match) Returns a list of users that match the given query string.
Users	getUsers(java.lang.String match, boolean activeUsersOnly) Returns a list of users that match the given query string.
boolean	isAdvancedMode() Returns whether the Cumulus user management runs in advanced mode using roles.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SOURCE_TYPE_RECORD

public static final int SOURCE_TYPE_RECORD

See Also:

Constant Field Values

SOURCE_TYPE_CATEGORY

public static final int SOURCE_TYPE_CATEGORY

See Also:

Constant Field Values

SOURCE_TYPE_CATALOG

public static final int SOURCE_TYPE_CATALOG

See Also:

Constant Field Values

SOURCE_TYPE_ITEM

public static final int SOURCE_TYPE_ITEM

See Also:

Constant Field Values

UUID_CURRENT_USER

public static final java.lang.String UUID_CURRENT_USER

Static key for the Current User.

See Also:

Constant Field Values

Method Detail

getServer

public Server getServer()

Returns the server of this instance.

Returns:

server of this instance

Since:

8.6

getInstance

public static PermissionManager getInstance(Server server)

Returns a permission manager singleton instance for the given server connection.

Parameters:

server - server to work with

Returns:

permission manager instance

getCurrentUserTemplate

public User getCurrentUserTemplate()

Returns a descriptor for the 'Current User' which is a placeholder for permission template where this user will be replaced by the user applying the template.

Returns:

'Current User' template

getRoles

public Roles getRoles()
               throws CumulusException

Returns the list of roles available at the server.

Returns:

list of roles

Throws:

CumulusException - in case of an error

getUsers

public Users getUsers(java.lang.String match)
               throws CumulusException

Returns a list of users that match the given query string.

Parameters:

match - the query against a user name must match

Returns:

list of matching users

Throws:

CumulusException - in case of an error

getUsers

public Users getUsers(java.lang.String match,
             boolean activeUsersOnly)
               throws CumulusException

Returns a list of users that match the given query string.

Parameters:

match - the query against a user name must match

Returns:

list of matching users

Throws:

CumulusException - in case of an error

Since:

9.2

getUserByLoginName

public User getUserByLoginName(java.lang.String loginName)
                        throws CumulusException

Returns a user by his login name.

Parameters:

loginName - the users login nam

Returns:

the user or null if not found

Throws:

CumulusException - in case of an error

isAdvancedMode

public boolean isAdvancedMode()

Returns whether the Cumulus user management runs in advanced mode using roles.

Returns:

true if roles are used at the server

getPermissions

public Permissions getPermissions(Item item)
                           throws InvalidStateException,
                                  CumulusException

Returns the permissions for the given record item.

Parameters:

item - the item to get the permissions for

Returns:

permissions for given record

Throws:

InvalidStateException - in case of an error

CumulusException - in case of an error

getPermissionsList

public PermissionsList getPermissionsList(Item item)
                                   throws InvalidStateException,
                                          CumulusException

Returns a permissions list containing only the permissions for the specified record item.

Parameters:

item - The item to get the permissions for

Returns:

permissions list

Throws:

InvalidStateException - in case of an error

CumulusException - in case of an error

getPermissionsList

public PermissionsList getPermissionsList(ItemCollection itemCollection,
                                 java.util.Set<ItemIdentifier> idList)
                                   throws InvalidStateException,
                                          CumulusException

Returns a permissions list for a number of records.

Parameters:

itemCollection - The item collection that contains the items

idList - The identifiers of the items to get the permissions for

Returns:

permissions list for all records of the collection

Throws:

InvalidStateException - in case of an error

CumulusException - in case of an error

Since:

8.0

getPermissionsList

public PermissionsList getPermissionsList(MultiItemCollection multiItemCollection,
                                 java.util.Set<ItemIdentifier> idList)
                                   throws InvalidStateException,
                                          CumulusException

Returns a permissions list for a number of records.

Parameters:

multiItemCollection - The multiple item collection that contains the items

idList - The identifiers of the items to get the permissions for

Returns:

permissions list for all records of the collection

Throws:

InvalidStateException - in case of an error

CumulusException - in case of an error

Since:

8.0

getPermissionsList

public PermissionsList getPermissionsList(java.lang.String tableName,
                                 java.util.Set<ItemIdentifier> idList)
                                   throws InvalidStateException,
                                          CumulusException

Returns a permissions list for a number of records.

Parameters:

tableName - The name of the table that the items come from. For record items this is Cumulus.TABLE_NAME_ASSET_RECORDS and for category items it is Cumulus.TABLE_NAME_CATEGORIES.

idList - The identifiers of the record items to get the permissions

Returns:

permissions list for all records of the collection

Throws:

InvalidStateException - in case of an error

CumulusException - in case of an error

Since:

8.0

applyPermissionTemplate

public void applyPermissionTemplate(Item item,
                           PermissionTemplate permissionTemplate)
                             throws InvalidStateException,
                                    CumulusException

Applies the given permission template on to the given record.

Parameters:

item - the item to apply the template to

permissionTemplate - the template to apply

Throws:

InvalidStateException - in case of an error

CumulusException - in case of an error

applyPermissionTemplate

public void applyPermissionTemplate(CategoryItem categoryItem,
                           PermissionTemplate permissionTemplate)
                             throws InvalidStateException,
                                    CumulusException

Applies the given permission template on to the given category.

Parameters:

categoryItem - the category to apply the template to

permissionTemplate - the template to apply

Throws:

InvalidStateException - in case of an error

CumulusException - in case of an error