com.supermap.services.security.storages

Interface Storage

  • All Known Subinterfaces:
    AdvancedStorage


    public interface Storage
    

    Security information (user information, user group information, role information, rights information) access interface

    Since:
    8.0.2
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void addRole(Role toAdd)
      Adds roles
      void addUser(User toAdd)
      adds user
      void addUserGroup(UserGroup toAdd)
      adds user array
      void alterRole(java.lang.String name, Role role)
      Update roles
      void alterUser(java.lang.String name, User user)
      Update users
      void alterUserGroup(java.lang.String name, UserGroup userGroup)
      Update user array
      void dispose()
      Disconnects the security information memory, when disconnecting internal resources, such as database connections, file handles, and file locks, are disconnected
      boolean existSystemUser(java.lang.String[] userNames)
      Check if there is a system (SYSTEM role) user in incoming users.
      int getAllUsersCount()
      Get the total number of users.
      getGroups(int startIndex, int expectCount)
      Batch return to user group
      java.util.Map<java.lang.String,AuthorizeSetting> getInstanceAuthorisations()
      Deprecated. 
      int getIportalUserCount()
      Query the total number of iportal users.
      java.util.Set<java.lang.String> getPermission(java.lang.String user, java.util.Collection<? extends java.lang.String> groups, java.util.Collection<? extends java.lang.String> roles, java.util.Set<java.lang.String> resourceIds)
      Accesses authority information according to the user, user group, role.
      java.util.List<java.lang.String> getPortalUserNames()
      Query the names of all iportal users.
      java.util.Set<java.lang.String> getPublicServiceNames()
      Queries all roles, and batch returns.
      Role getRole(java.lang.String name)
      Gets roles
      java.util.Map<java.lang.String,RolePermissions> getRolePermissions(java.lang.String[] names)
      Gets permission information based on role name
      getRoles(int startIndex, int expectCount)
      Queries all roles, and batch returns.
      User getSystemUser()
      Query the system administrator.
      User getUser(java.lang.String name)
      Gets the user
      java.util.List<java.lang.String> getUserNames()
      Query the names of all users.
      getUsers(int startIndex, int expectCount)
      Finds all users and return them in bulk
      Page<User> getUsers(UserSearchParameter param)
      Query the user according to the parameter paging.
      void grantUser(java.lang.String username, RolePermissions permission)
      Defines role permissions to users based on user name
      void insert(ServiceBeanPermission[] permissions)
      Adds service authority
      java.util.List<java.lang.String> listUsers(java.lang.String includedRole, java.util.List<java.lang.String> anyIncludedRoles, java.util.List<java.lang.String> excludedRoles)
      Query the user who satisfies the role filter.
      void removeInstances(java.lang.String[] names)
      Deletes the authorization instance by name
      void removeRoles(java.lang.String[] names)
      Removes the role
      void removeUserGroups(java.lang.String[] names)
      Removes the user array
      void removeUsers(java.lang.String[] names)
      Removes the user
      void renameInstance(java.lang.String oldName, java.lang.String newName)
      Modifies the instance name
      void resetStorageSetting(SecurityInfoStorageSetting setting)
      Reset the storage settings, and re-initialize according to the reset settings
      void setFormPasswordSavedCount(int passwordDiffCount)
      Sets the number of password saved
      void setPasswordService(PasswordService value) 
      void setRolePermissions(java.lang.String roleName, RolePermissions permission, ServiceBeanPermission[] permissions)
      Sets the role permissions and service permissions based on the role name
      void updateInstanceAuthorisation(java.lang.String name, AuthorizeSetting authorizeSetting)
      Updates the authorization instance settings based on the authorization instance name
    • Method Detail

      • resetStorageSetting

        void resetStorageSetting(SecurityInfoStorageSetting setting)
                                 throws ConnectionException
        

        Reset the storage settings, and re-initialize according to the reset settings

        Parameters:
        setting -
        Throws:
        ConnectionException
        Since:
        8.0.2
      • getUser

        User getUser(java.lang.String name)
        

        Gets the user

        Parameters:
        name - user name.
        Returns:
        User object
      • addUser

        void addUser(User toAdd)
        

        adds user

        Parameters:
        toAdd - users to add
      • removeUsers

        void removeUsers(java.lang.String[] names)
        

        Removes the user

        Parameters:
        names - An array of user names to remove
      • alterUser

        void alterUser(java.lang.String name,
                     User user)
        

        Update users

        Parameters:
        name - user name.
        user - new user object
      • addUserGroup

        void addUserGroup(UserGroup toAdd)
        

        adds user array

        Parameters:
        toAdd - user array to add
      • alterUserGroup

        void alterUserGroup(java.lang.String name,
                          UserGroup userGroup)
        

        Update user array

        Parameters:
        name - The name of the user group
        userGroup - new user object
      • removeUserGroups

        void removeUserGroups(java.lang.String[] names)
        

        Removes the user array

        Parameters:
        names - user name group array
      • getUsers

         getUsers(int startIndex,
                     int expectCount)
        

        Finds all users and return them in bulk

        Parameters:
        startIndex -
        expectCount -
        Returns:
        Since:
        8.0.2
      • getUserNames

        java.util.List<java.lang.String> getUserNames()
        

        Query the names of all users.

        Returns:
        Since:
        8.1.1
      • getPortalUserNames

        java.util.List<java.lang.String> getPortalUserNames()
        

        Query the names of all iportal users.

        Returns:
        Since:
        8.1.1
      • getUsers

        Page<User> getUsers(UserSearchParameter param)
        

        Query the user according to the parameter paging.

        Parameters:
        param -
        Returns:
        Since:
        8.1.1
      • getAllUsersCount

        int getAllUsersCount()
        

        Get the total number of users.

        Returns:
        Since:
        8.1.1
      • getSystemUser

        User getSystemUser()
        

        Query the system administrator.

        Returns:
        Since:
        8.1.1
      • getIportalUserCount

        int getIportalUserCount()
        

        Query the total number of iportal users.

        Returns:
        Since:
        8.1.1
      • existSystemUser

        boolean existSystemUser(java.lang.String[] userNames)
        

        Check if there is a system (SYSTEM role) user in incoming users.

        Returns:
        Since:
        8.1.1
      • listUsers

        java.util.List<java.lang.String> listUsers(java.lang.String includedRole,
                                                 java.util.List<java.lang.String> anyIncludedRoles,
                                                 java.util.List<java.lang.String> excludedRoles)
        

        Query the user who satisfies the role filter.

        Parameters:
        includedRole -
        anyIncludedRoles -
        excludedRoles -
        Returns:
        Since:
        8.1.1
      • getGroups

         getGroups(int startIndex,
                      int expectCount)
        

        Batch return to user group

        Parameters:
        startIndex -
        expectCount -
        Returns:
        Since:
        8.0.2
      • addRole

        void addRole(Role toAdd)
        

        Adds roles

        Parameters:
        toAdd - roles to add
      • alterRole

        void alterRole(java.lang.String name,
                     Role role)
        

        Update roles

        Parameters:
        name - roles' name.
        role - new role object
      • removeRoles

        void removeRoles(java.lang.String[] names)
        

        Removes the role

        Parameters:
        names - An array of role names to remove
      • getRole

        Role getRole(java.lang.String name)
        

        Gets roles

        Parameters:
        name - roles' name.
        Returns:
        role object
      • getRoles

         getRoles(int startIndex,
                     int expectCount)
        

        Queries all roles, and batch returns.

        Parameters:
        startIndex -
        expectCount -
        Returns:
        Since:
        8.0.2
      • getPublicServiceNames

        java.util.Set<java.lang.String> getPublicServiceNames()
        

        Queries all roles, and batch returns.

        Returns:
        Since:
        8.0.2
      • getPermission

        java.util.Set<java.lang.String> getPermission(java.lang.String user,
                                                    java.util.Collection<? extends java.lang.String> groups,
                                                    java.util.Collection<? extends java.lang.String> roles,
                                                    java.util.Set<java.lang.String> resourceIds)
        

        Accesses authority information according to the user, user group, role.

        Parameters:
        user - user.
        groups - user groups
        roles - roles
        Returns:
        represents the set of permissions
      • getRolePermissions

        java.util.Map<java.lang.String,RolePermissions> getRolePermissions(java.lang.String[] names)
        

        Gets permission information based on role name

        Parameters:
        names -
        Returns:
        Since:
        8.0.2
      • updateInstanceAuthorisation

        void updateInstanceAuthorisation(java.lang.String name,
                                       AuthorizeSetting authorizeSetting)
        

        Updates the authorization instance settings based on the authorization instance name

        Parameters:
        name -
        authorizeSetting -
        Since:
        8.0.2
      • getInstanceAuthorisations

        @Deprecated
        java.util.Map<java.lang.String,AuthorizeSetting> getInstanceAuthorisations()
        
        Deprecated. 

        Obtains authorization information for all service instances

        Returns:
        Since:
        8.0.2
      • removeInstances

        void removeInstances(java.lang.String[] names)
        

        Deletes the authorization instance by name

        Parameters:
        names -
        Since:
        8.0.2
      • renameInstance

        void renameInstance(java.lang.String oldName,
                          java.lang.String newName)
        

        Modifies the instance name

        Parameters:
        oldName -
        newName -
        Since:
        8.0.2
      • setRolePermissions

        void setRolePermissions(java.lang.String roleName,
                              RolePermissions permission,
                              ServiceBeanPermission[] permissions)
        

        Sets the role permissions and service permissions based on the role name

        Parameters:
        roleName -
        permission -
        permissions -
        Since:
        8.0.2
      • grantUser

        void grantUser(java.lang.String username,
                     RolePermissions permission)
        

        Defines role permissions to users based on user name

        Parameters:
        username -
        permission -
        Since:
        8.0.2
      • insert

        void insert(ServiceBeanPermission[] permissions)
        

        Adds service authority

        Parameters:
        permissions -
        Since:
        8.0.2
      • setFormPasswordSavedCount

        void setFormPasswordSavedCount(int passwordDiffCount)
        

        Sets the number of password saved

        Parameters:
        passwordDiffCount -
        Since:
        8.0.2
      • dispose

        void dispose()
        

        Disconnects the security information memory, when disconnecting internal resources, such as database connections, file handles, and file locks, are disconnected

        Since:
        8.0.2
      • setPasswordService

        void setPasswordService(PasswordService value)