AuthenticationManager (Cumulus Java Classes Documentation)

java.lang.Object
- com.canto.cumulus.usermanagement.AuthenticationManager

public class AuthenticationManager
extends java.lang.Object

This class provides access to the Cumulus user management API. To get the user names available you can execute code like this:

       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);
       }

Since:: 7.0

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`AuthenticationManager.Department` This class describes a single department and provides access to the child departments.
`static class`	`AuthenticationManager.ServerSettings` This class enables accessing some configuration specifics of the server this authentication manager is connected to.
`static class`	`AuthenticationManager.UserType`

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String TABLE_PERMISSION_SEPARATOR

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`TABLE_PERMISSION_SEPARATOR`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addAuthenticatorListener(AuthenticatorListener<AuthenticationManager> listener)` Adds a listener for authentication events.
`static java.lang.String`	`buildTablePermission(java.lang.String tableName, boolean forSubTables, java.lang.String permission)` Create a permission string for a specific table.
`void`	`clearFieldDefinitionCache()` Clears the field definition cache which is populated with the first access to `getFieldDefinition(com.canto.cumulus.GUID)`.
`ExternalUser`	`createExternalUser(java.lang.String loginName, java.lang.String emailAddress)` Creates a new external user.
`UserFieldDefinition`	`createFieldDefinition(java.lang.String sName, int type)` Creates a new field definition.
`OpenCatalogClientGroup`	`createOpenCatalogClientGroup(java.lang.String name)` Creates a new Open Catalog Client Group.
`Role`	`createRole(java.lang.String sRoleName)` Create a new Role.
`User`	`createUser(java.lang.String sUserName)` Create a new user.
`void`	`deleteFieldDefinition(GUID guid)` Deletes a field definition.
`void`	`deleteOpenCatalogClientGroup(java.lang.String name)` Delete the specified group at the server.
`void`	`deleteRole(java.lang.String sRoleName)` Delete an existing role.
`void`	`deleteUser(java.lang.String sUserName)` Delete an existing user
`OpenCatalogClientGroup`	`duplicate(java.lang.String newName, OpenCatalogClientGroup clientGroup)` Duplicates the given group using the specified name as the name of the copy.
`Role`	`duplicateRole(java.lang.String sOldName, java.lang.String newName)` Duplicates the specified role as a new role.
`User`	`duplicateUser(java.lang.String sOldName, java.lang.String newName)` Duplicates the specified user as a new user.
`Users`	`findUsers(java.lang.String searchToken)` Returns the found users for the given search token.
`Users`	`findUsers(java.lang.String searchToken, boolean activeUsersOnly)` Returns the found users for the given search token.
`static AuthenticationManager`	`getAuthenticationManager(Server server)` Get the authentication manager for the specified server instance.
`ProductList`	`getAvailableProductList()` Returns the available products of the server.
`CumulusSession`	`getCumulusSession()` Returns the CumulusSession object.
`java.util.Map<java.lang.Integer,java.lang.String>`	`getDepartmentIDs()` Returns a map of all department ids pointing to their name.
`AuthenticationManager.Department`	`getDepartments()` Returns the configured departments if the feature is enabled for the server.
`UserFieldDefinition`	`getFieldDefinition(GUID guid)` Returns a field definition by GUID from the global field definition cache.
`GUID[]`	`getFieldDefinitionGUIDsAsArray()` Returns an array containing the field GUIDs.
`UserFieldDefinition[]`	`getFieldDefinitions()` Returns all field definitions available at the server for user management (those fields are part of the $Users catalog).
`boolean`	`getHasFeature(Feature feature)` Check whether a given feature is available.
`OpenCatalogClientGroup`	`getOpenCatalogClientGroup(java.lang.String name)` Returns the group instance for the specified name.
`java.util.List<java.lang.String>`	`getOpenCatalogClientGroupNames()` Get a list of names of all existing groups.
`Role`	`getRole(java.lang.String sRole)` Returns a role by name.
`java.lang.String[]`	`getRoleNamesAsArray()` Returns an array containing the list of roles.
`Server`	`getServer()` Returns the server of this connection.
`AuthenticationManager.ServerSettings`	`getServerSettings()` Returns the `AuthenticationManager.ServerSettings` which provide additional information about the server.
`java.util.List<User>`	`getStrippedUsers(AuthenticationManager.UserType userType, GUID[] guids)` Returns a list of `User` objects which only contain the information for the specified list of fields.
`java.util.List<User>`	`getStrippedUsers(GUID[] guids)` Returns a list of `User` objects which only contain the information for the specified list of fields.
`User`	`getUser(java.lang.String sUser)` Returns a user by name.
`java.lang.String[]`	`getUserNamesAsArray()` Returns an array containing the list of users.
`java.lang.String[]`	`getUserRoleNamesAsArray(java.lang.String sUser)` Returns an array containing the list of roles for a specific user.
`boolean`	`isAdmin()` Return whether you are connected as the Cumulus administrator.
`boolean`	`isSimpleMode()` Returns whether the user management at the server runs in Simple Mode (no support for roles).
`void`	`removeAuthenticatorListener(AuthenticatorListener<AuthenticationManager> listener)` Removes a previously registered listener.
`void`	`renameOpenCatalogClientGroup(java.lang.String oldName, java.lang.String newName)` Renames the group to the specified new name.
`void`	`renameRole(java.lang.String sRoleName, java.lang.String sNewRoleName)` Renames a role.
`void`	`saveFieldDefinition(UserFieldDefinition field)` Save the changes for the field definition back to the server.
`void`	`saveOpenCatalogClientGroup(OpenCatalogClientGroup clientGroup)` Save all changes for the group back to the server.
`void`	`saveRole(Role role)` Save the changes for the specified role back to the server.
`void`	`saveUser(User user)` Save the changes for the specified user back to the server.
`void`	`setAdvancedMode()` Calling this function switches the server to Advanced Mode if this feature is available at the server.
`void`	`setDepartments(AuthenticationManager.Department department)` Saves all departments.
`void`	`setUserSettings(java.lang.String sourceUserUID, java.lang.String[] targetUserUIDs)` Copies the Cumulus application user settings from the source user to all provided target users.
`boolean`	`supportsDepartments()` Returns whether the connected server supports departments.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TABLE_PERMISSION_SEPARATOR
```
public static final java.lang.String TABLE_PERMISSION_SEPARATOR
```
    See Also:
    Constant Field Values
- Method Detail
  - getAuthenticationManager
```
public static AuthenticationManager getAuthenticationManager(Server server)
                                                      throws CumulusException
```
    Get the authentication manager for the specified server instance.
    
    Parameters:
    server - the server to work with
    
    Returns:
    the instance to work with
    
    Throws:
    
    CumulusException - in case of an error
  - getCumulusSession
```
public CumulusSession getCumulusSession()
```
    Returns the CumulusSession object.
    
    Returns:
    the CumulusSession object.
  - getFieldDefinitionGUIDsAsArray
```
public GUID[] getFieldDefinitionGUIDsAsArray()
                                      throws CumulusException
```
    Returns an array containing the field GUIDs.
    
    Returns:
    an array containing the field GUIDs.
    
    Throws:
    
    CumulusException - in case of an error
  - getUserNamesAsArray
```
public java.lang.String[] getUserNamesAsArray()
                                       throws CumulusException
```
    Returns an array containing the list of users.
    
    Returns:
    array containing the list of users
    
    Throws:
    
    CumulusException - in case of an error
  - getRoleNamesAsArray
```
public java.lang.String[] getRoleNamesAsArray()
                                       throws CumulusException
```
    Returns an array containing the list of roles.
    
    Returns:
    array containing the list of roles
    
    Throws:
    
    CumulusException - in case of an error
  - getUserRoleNamesAsArray
```
public java.lang.String[] getUserRoleNamesAsArray(java.lang.String sUser)
                                           throws CumulusException
```
    Returns an array containing the list of roles for a specific user.
    
    Parameters:
    sUser - the user name.
    
    Returns:
    an array containing the list of roles for a specific user.
    
    Throws:
    
    CumulusException - in case of an error
  - getStrippedUsers
```
public java.util.List<User> getStrippedUsers(GUID[] guids)
                                      throws CumulusException
```
    Returns a list of User objects which only contain the information for the specified list of fields.
    
    Parameters:
    guids - the list of field guids to get the information for
    
    Returns:
    list of User objects
    
    Throws:
    
    CumulusException - in case of an error
  - getStrippedUsers
```
public java.util.List<User> getStrippedUsers(AuthenticationManager.UserType userType,
                                    GUID[] guids)
                                      throws CumulusException
```
    Returns a list of User objects which only contain the information for the specified list of fields.
    
    Parameters:
    userType - type of users to get
    guids - the list of field guids to get the information for
    
    Returns:
    list of User objects
    
    Throws:
    
    CumulusException - in case of an error
  - getServerSettings
```
public AuthenticationManager.ServerSettings getServerSettings()
                                                       throws CumulusException
```
    Returns the AuthenticationManager.ServerSettings which provide additional information about the server.
    
    Returns:
    server settings
    
    Throws:
    
    CumulusException - in case of an error
  - getFieldDefinitions
```
public UserFieldDefinition[] getFieldDefinitions()
                                          throws CumulusException
```
    Returns all field definitions available at the server for user management (those fields are part of the $Users catalog).
    
    Returns:
    array of field definitions
    
    Throws:
    
    CumulusException - in case of an error
  - getFieldDefinition
```
public UserFieldDefinition getFieldDefinition(GUID guid)
                                       throws CumulusException
```
    Returns a field definition by GUID from the global field definition cache. To clear the cache call clearFieldDefinitionCache().
    
    Parameters:
    guid - the field GUID.
    
    Returns:
    the field definition by GUID or null if not found
    
    Throws:
    
    CumulusException - in case of an error
  - clearFieldDefinitionCache
```
public void clearFieldDefinitionCache()
```
    Clears the field definition cache which is populated with the first access to getFieldDefinition(com.canto.cumulus.GUID).
  - createFieldDefinition
```
public UserFieldDefinition createFieldDefinition(java.lang.String sName,
                                        int type)
                                          throws CumulusException
```
    Creates a new field definition.
    
    Parameters:
    sName - the field name.
    type - the field type.
    
    Returns:
    the new field GUID.
    
    Throws:
    
    CumulusException - in case of an error
  - deleteFieldDefinition
```
public void deleteFieldDefinition(GUID guid)
                           throws CumulusException
```
    Deletes a field definition.
    
    Parameters:
    guid - the field guid.
    
    Throws:
    
    CumulusException - in case of an error
  - getUser
```
public User getUser(java.lang.String sUser)
             throws CumulusException
```
    Returns a user by name.
    
    Parameters:
    sUser - the user name.
    
    Returns:
    a user by name.
    
    Throws:
    
    CumulusException - in case of an error
  - createUser
```
public User createUser(java.lang.String sUserName)
                throws CumulusException
```
    Create a new user.
    When running in Simple Mode you need to create a role as well using the same name.
    
    Parameters:
    sUserName - The name of the new user to create.
    
    Returns:
    the new User
    
    Throws:
    
    CumulusException - in case the user name exists already or something went wrong
  - deleteUser
```
public void deleteUser(java.lang.String sUserName)
                throws CumulusException
```
    Delete an existing user
    
    Parameters:
    sUserName - the user to delete
    
    Throws:
    
    CumulusException - in case the user name does not exists.
  - getRole
```
public Role getRole(java.lang.String sRole)
             throws CumulusException
```
    Returns a role by name.
    
    Parameters:
    sRole - the role name.
    
    Returns:
    a role by name.
    
    Throws:
    
    CumulusException - in case of an error
  - createRole
```
public Role createRole(java.lang.String sRoleName)
                throws CumulusException
```
    Create a new Role.
    
    Parameters:
    sRoleName - the new role name.
    
    Returns:
    a new Role.
    
    Throws:
    
    CumulusException - in case the name exists already or something went wrong
  - renameRole
```
public void renameRole(java.lang.String sRoleName,
              java.lang.String sNewRoleName)
                throws CumulusException
```
    Renames a role.
    
    Parameters:
    sRoleName - the old role name
    sNewRoleName - the new role name
    
    Throws:
    
    CumulusException - in case the name exists already or something went wrong
  - deleteRole
```
public void deleteRole(java.lang.String sRoleName)
                throws CumulusException
```
    Delete an existing role.
    
    Parameters:
    sRoleName - the role name
    
    Throws:
    
    CumulusException - in case the role name does not exists.
  - isAdmin
```
public boolean isAdmin()
                throws CumulusException
```
    Return whether you are connected as the Cumulus administrator.
    
    Returns:
    true when you are connected as the Cumulus administrator
    
    Throws:
    
    CumulusException - in case of an error
  - isSimpleMode
```
public boolean isSimpleMode()
                     throws CumulusException
```
    Returns whether the user management at the server runs in Simple Mode (no support for roles).
    
    Returns:
    true if running in Simple Mode
    
    Throws:
    
    CumulusException - in case of an error
  - setAdvancedMode
```
public void setAdvancedMode()
                     throws CumulusException
```
    Calling this function switches the server to Advanced Mode if this feature is available at the server. This call is irreversible.
    
    Throws:
    
    CumulusException - in case of an error
  - saveRole
```
public void saveRole(Role role)
              throws CumulusException
```
    Save the changes for the specified role back to the server.
    
    Parameters:
    role - the role to save
    
    Throws:
    
    CumulusException - in case of an error
  - saveUser
```
public void saveUser(User user)
              throws CumulusException
```
    Save the changes for the specified user back to the server.
    
    Parameters:
    user - the user to save.
    
    Throws:
    
    CumulusException - in case of an error
  - saveFieldDefinition
```
public void saveFieldDefinition(UserFieldDefinition field)
                         throws CumulusException
```
    Save the changes for the field definition back to the server.
    
    Parameters:
    field - the field to save
    
    Throws:
    
    CumulusException - in case of an error
  - getAvailableProductList
```
public ProductList getAvailableProductList()
                                    throws CumulusException
```
    Returns the available products of the server.
    
    Returns:
    instance to get a list of possible products at the server
    
    Throws:
    
    CumulusException - in case of an error
  - createOpenCatalogClientGroup
```
public OpenCatalogClientGroup createOpenCatalogClientGroup(java.lang.String name)
                                                    throws CumulusException
```
    Creates a new Open Catalog Client Group.
    
    Parameters:
    name - name of the new group
    
    Returns:
    the new created group
    
    Throws:
    
    CumulusException - in case of an error
  - duplicate
```
public OpenCatalogClientGroup duplicate(java.lang.String newName,
                               OpenCatalogClientGroup clientGroup)
                                 throws CumulusException
```
    Duplicates the given group using the specified name as the name of the copy.
    
    Parameters:
    newName - name of the group to create
    clientGroup - source group for the group to create
    
    Returns:
    the new group
    
    Throws:
    
    CumulusException - in case of an error
  - renameOpenCatalogClientGroup
```
public void renameOpenCatalogClientGroup(java.lang.String oldName,
                                java.lang.String newName)
                                  throws CumulusException
```
    Renames the group to the specified new name.
    
    Parameters:
    oldName - old name of the group.
    newName - new name of the group.
    
    Throws:
    
    CumulusException - in case of an error
  - saveOpenCatalogClientGroup
```
public void saveOpenCatalogClientGroup(OpenCatalogClientGroup clientGroup)
                                throws CumulusException
```
    Save all changes for the group back to the server.
    
    Parameters:
    clientGroup - the group to save
    
    Throws:
    
    CumulusException - in case of an error
  - deleteOpenCatalogClientGroup
```
public void deleteOpenCatalogClientGroup(java.lang.String name)
                                  throws CumulusException
```
    Delete the specified group at the server.
    
    Parameters:
    name - the name of the group to delete
    
    Throws:
    
    CumulusException - in case of an error
  - getOpenCatalogClientGroupNames
```
public java.util.List<java.lang.String> getOpenCatalogClientGroupNames()
                                                                throws CumulusException
```
    Get a list of names of all existing groups.
    
    Returns:
    list of names
    
    Throws:
    
    CumulusException - in case of an error
  - getOpenCatalogClientGroup
```
public OpenCatalogClientGroup getOpenCatalogClientGroup(java.lang.String name)
                                                 throws CumulusException
```
    Returns the group instance for the specified name.
    
    Parameters:
    name - the name of the group to get from the server
    
    Returns:
    the instance representing this group
    
    Throws:
    
    CumulusException - in case of an error
  - supportsDepartments
```
public boolean supportsDepartments()
```
    Returns whether the connected server supports departments.
    
    Returns:
    true if the connected server supports departments
    Since:
    
    8.5
  - getDepartments
```
public AuthenticationManager.Department getDepartments()
                                                throws CumulusException
```
    Returns the configured departments if the feature is enabled for the server.
    
    Returns:
    configured departments or null if feature is not available
    
    Throws:
    
    CumulusException - error happened
    Since:
    
    8.5
  - setDepartments
```
public void setDepartments(AuthenticationManager.Department department)
                    throws CumulusException
```
    Saves all departments.
    
    Parameters:
    department - root department to save
    
    Throws:
    
    CumulusException - error happened
    Since:
    
    8.5
  - getDepartmentIDs
```
public java.util.Map<java.lang.Integer,java.lang.String> getDepartmentIDs()
                                                                   throws CumulusException
```
    Returns a map of all department ids pointing to their name.
    
    Returns:
    map of all department ids pointing to their name
    
    Throws:
    
    CumulusException - in case of an error
    Since:
    
    8.5
  - findUsers
```
public Users findUsers(java.lang.String searchToken)
```
    Returns the found users for the given search token. The returned list might be limited in number of search results. In addition the different permissions to browse for users also influence the search results.
    
    Parameters:
    searchToken - part of the name to search for
    
    Returns:
    found user descriptors
    Since:
    
    9.0
  - findUsers
```
public Users findUsers(java.lang.String searchToken,
              boolean activeUsersOnly)
```
    Returns the found users for the given search token. The returned list might be limited in number of search results. In addition the different permissions to browse for users also influence the search results.
    
    Parameters:
    searchToken - part of the name to search for
    activeUsersOnly - true if only users with an active account should be returned
    
    Returns:
    found user descriptors
    Since:
    
    9.2
  - createExternalUser
```
public ExternalUser createExternalUser(java.lang.String loginName,
                              java.lang.String emailAddress)
```
    Creates a new external user.
    
    Parameters:
    loginName - login name of the new external user
    emailAddress - email address of the new external user
    
    Returns:
    create instance
    Since:
    
    9.0
  - duplicateUser
```
public User duplicateUser(java.lang.String sOldName,
                 java.lang.String newName)
                   throws CumulusException
```
    Duplicates the specified user as a new user.
    
    Parameters:
    sOldName - the user being the source for the copy
    newName - the new user name being created
    
    Returns:
    the new user
    
    Throws:
    
    CumulusException - in case of an error
  - duplicateRole
```
public Role duplicateRole(java.lang.String sOldName,
                 java.lang.String newName)
                   throws CumulusException
```
    Duplicates the specified role as a new role.
    
    Parameters:
    sOldName - the role being the source for the copy
    newName - the new role name
    
    Returns:
    the new role
    
    Throws:
    
    CumulusException - in case of an error
  - getServer
```
public Server getServer()
```
    Returns the server of this connection.
    
    Returns:
    the underlying server object
    Since:
    
    8.0
  - getHasFeature
```
public boolean getHasFeature(Feature feature)
```
    Check whether a given feature is available.
    
    Parameters:
    feature - the feature to check. Use one of the constants of the Feature enum.
    
    Returns:
    true if the feature is available, false otherwise.
    Since:
    
    8.0
  - setUserSettings
```
public void setUserSettings(java.lang.String sourceUserUID,
                   java.lang.String[] targetUserUIDs)
```
    Copies the Cumulus application user settings from the source user to all provided target users.
    
    Parameters:
    sourceUserUID - user uid of the source user providing the user settings to write to users
    targetUserUIDs - array of user UIDs specifying the users which should get the preferences of the specified source user
    Since:
    
    8.0
  - addAuthenticatorListener
```
public void addAuthenticatorListener(AuthenticatorListener<AuthenticationManager> listener)
```
    Adds a listener for authentication events.
    
    Parameters:
    listener - new listener
  - removeAuthenticatorListener
```
public void removeAuthenticatorListener(AuthenticatorListener<AuthenticationManager> listener)
```
    Removes a previously registered listener.
    
    Parameters:
    listener - registered listener to remove
  - buildTablePermission
```
public static java.lang.String buildTablePermission(java.lang.String tableName,
                                    boolean forSubTables,
                                    java.lang.String permission)
```
    Create a permission string for a specific table.
    
    Parameters:
    tableName - table name for the permission to check
    forSubTables - permission should be applied to all sub-tables as well
    permission - the permission to check on the specified table
    
    Returns:
    generated permission string

www.canto.com
Canto, the Canto logo, the Cumulus logo, and Cumulus are registered trademarks of Canto GmbH, registered in the U.S. and other countries.

Class AuthenticationManager

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TABLE_PERMISSION_SEPARATOR

Method Detail

getAuthenticationManager

getCumulusSession

getFieldDefinitionGUIDsAsArray

getUserNamesAsArray

getRoleNamesAsArray

getUserRoleNamesAsArray

getStrippedUsers

getStrippedUsers

getServerSettings

getFieldDefinitions

getFieldDefinition

clearFieldDefinitionCache

createFieldDefinition

deleteFieldDefinition

getUser

createUser

deleteUser

getRole

createRole

renameRole

deleteRole

isAdmin

isSimpleMode

setAdvancedMode

saveRole

saveUser

saveFieldDefinition

getAvailableProductList

createOpenCatalogClientGroup

duplicate

renameOpenCatalogClientGroup

saveOpenCatalogClientGroup

deleteOpenCatalogClientGroup

getOpenCatalogClientGroupNames

getOpenCatalogClientGroup

supportsDepartments

getDepartments

setDepartments

getDepartmentIDs

findUsers

findUsers

createExternalUser

duplicateUser

duplicateRole

getServer

getHasFeature

setUserSettings

addAuthenticatorListener

removeAuthenticatorListener

buildTablePermission