Package com.canto.cumulus.usermanagement

The Cumulus User Management package.

See: Description

Class Summary

Class	Description
AuthenticationManager	This class provides access to the Cumulus user management API.
AuthenticationManager.Department	This class describes a single department and provides access to the child departments.
AuthenticationManager.ServerSettings	This class enables accessing some configuration specifics of the server this authentication manager is connected to.
CatalogLiveFilter	This class manages the live filter settings for a single catalog.
CatalogLiveFilterQuery	This class manages all query related live filter settings for a single catalog.
EntityRestrictor	This class manages access to an entity for the entire server or a specific catalog.
ExternalUser
FieldValue	This class manages a single field value of a user.
FieldValues	This class manages the field values of a user.
LiveFiltering	This class manages the live filter settings for a role.
OpenCatalogClientGroup	This class manages a Open Catalog client group which groups a list of products under a unique name.
PredefinedPermissions	This class provides access to all predefined permissions of Cumulus.
Product	This class represents a single product.
ProductList	This class manages a list of products.
Role	Instances of this class represent a single role.
RolePermissions	This class manages permissions for catalogs.
ServerPermissions	This class manages the server permissions assigned to a role.
User	Instances of this class represent a single user.
User.RoleNames	Manages the roles a user is assigned to.
UserFieldDefinition	Instances of this class describe a field definition of the $Users catalog.
UserFieldDefinition.FieldNames	Wrapper class for field names.
UserFieldDefinition.StringEnums	Manager class for the string enum values.

Enum Summary

Enum	Description
AuthenticationManager.UserType

Package com.canto.cumulus.usermanagement Description

The Cumulus User Management package.

This package provides access to the entire permission and user management system of Cumulus.
The starting point for working with the user management API is the AuthenticationManager class. The following code shows how to access the rolenames and usernames currently available in Cumulus:

        AuthenticationManager authenticationManager = AuthenticationManager.getAuthenticationManager(cumulusServer);
        if (authenticationManager.isSimpleMode)
        {
            System.out.println ("No roles available because user system is running in simple mode.");
        }
        else
        {
            String[] roles = authenticationManager.getRoleNamesAsArray();
            System.out.println ("Roles available:");
            for (int i = 0; i < roles.length; i++)
            {
                String role = roles[i];
                System.out.println ("found Role = " + role);
            }
        }
        String[] users = authenticationManager.getUserNamesAsArray();
        System.out.println ("Users available:");
        for (int i = 0; i < users.length; i++)
        {
            String user = users[i];
            System.out.println ("found User = " + user);
        }
    

Architecture

The Cumulus user management system is based on users and roles with assigned permissions. When running in Simple Mode each user has its own role using the same name as the users login name. When running in Advanced Mode each user can be assigned to many roles and the permissions of all roles will be cumulatively available for the user.
There is no way to remove a specific permission for a user by not setting this permission in a role and assigning the user to that role.

Simple Mode

To change user permissions when running in Simple Mode one needs to make all permission changes at the role using the same name as the user. The user instance itself only carries metadata like an address or email. Adding additional roles to the system by using this API and adding users to it will not work as the server will skip such invalid assignments.

Advanced Mode

When running in advanced mode the admin really sees the roles available and can manage those roles using the User Manager application. When using the API one can also simply edit the roles freely and assign the permissions needed.

© 2002-2021, Canto GmbH. All Rights Reserved.