com.engiweb.profilemanager.common.interfaces

Interface IUser

  • All Superinterfaces:
    com.engiweb.toolkit.interfaces.IEjb


    public interface IUser
    extends com.engiweb.toolkit.interfaces.IEjb
    The IUser interface allows a client to retrieve and manage all information about user objects
    Author:
    CrossIdeas developer group
    • Method Detail

      • insert

        @Deprecated
        UserBean insert(UserBean userBean,
                                    com.engiweb.pm.entity.BeanList<UserExtInfoBean> extInfoBeanList,
                                    OrgUnitBean ouBean,
                                    java.lang.String token,
                                    java.lang.String realmAdm)
                             throws com.engiweb.toolkit.common.BackendException
        Deprecated. replaced by #insertByGroup(UserBean, BeanList, GroupBean, String, String)
        Throws:
        com.engiweb.toolkit.common.BackendException
      • insertInGroup

        UserBean insertInGroup(UserBean userBean,
                               com.engiweb.pm.entity.BeanList<UserExtInfoBean> extInfoBeanList,
                               GroupBean groupBean,
                               java.lang.String token,
                               java.lang.String realmAdm)
                        throws com.engiweb.toolkit.common.BackendException
        Adds a new user, if it not exists yet. Also insert into external repository is possible setting a list of UserExtInfoBean
        Parameters:
        userBean - UserBean to add (mandatory)
        extInfoBeanList - BeanList of UserExtInfoBean if null or empty no insertion on ext DB is performed
        groupBean - GroupBean to add. It must be present and uniquely defined.
        token - String Authorization string
        realmAdm - String Realm name
        Returns:
        UserBean added
        Throws:
        com.engiweb.toolkit.common.BackendException
      • update

        UserBean update(UserBean userBean,
                        com.engiweb.pm.entity.BeanList<UserExtInfoBean> extInfoBeanList,
                        java.lang.String token,
                        java.lang.String realm)
                 throws com.engiweb.toolkit.common.BackendException
        Updates an existing user.Also updates of external properies is possible setting a list of user external info
        Parameters:
        userBean - UserBean to update. It must be present and uniquely defined
        extInfoBeanList - BeanList of UserExtInfoBean. If null or empty no updates on ext DB is performed
        String - String Code operation. If null PM generates it automatically
        token - String Authorization string
        realm - String Realm name
        Returns:
        Throws:
        com.engiweb.toolkit.common.BackendException
      • delete

        void delete(UserBean userBean,
                    java.lang.String token,
                    java.lang.String realm)
             throws com.engiweb.toolkit.common.BackendException
        Deletes an existing user.
        Parameters:
        userBean - UserBean to update. It must be present and uniquely defined
        token - String Authorization string
        realm - String Realm name
        Throws:
        com.engiweb.toolkit.common.BackendException
      • find

        com.engiweb.pm.entity.BeanList<UserBean> find(UserBean userBean,
                                                      com.engiweb.pm.entity.Paging paging,
                                                      java.lang.String token,
                                                      java.lang.String realmAdm)
                                               throws com.engiweb.toolkit.common.BackendException
        Returns the users filtered by a specified user
        Parameters:
        userBean - UserBean if null no filter is applied, otherwise the passed object is used as filter
        paging - Paging
        token - String Authorization string
        realmAdm - String Realm name
        Returns:
        BeanList of UserBean
        Throws:
        com.engiweb.toolkit.common.BackendException
      • findUserExtInfo

        com.engiweb.pm.entity.BeanList<UserExtInfoBean> findUserExtInfo(UserBean userBean,
                                                                        boolean onlyVisible,
                                                                        java.lang.String token,
                                                                        java.lang.String realm)
                                                                 throws com.engiweb.toolkit.common.BackendException
        Returns the user external info associated to the user and properly valued
        Parameters:
        userBean - UserBean It must be present and uniquely defined
        onlyVisible - boolean type. if true returns only the extInfo mapped as visible
        token - String Authorization string
        realm - String Realm name
        Returns:
        BeanList of UserExtInfoBean
        Throws:
        com.engiweb.toolkit.common.BackendException
      • getSelectedExtInfo

        com.engiweb.pm.entity.BeanList<UserExtInfoBean> getSelectedExtInfo(java.lang.String token,
                                                                           java.lang.String realm)
                                                                    throws com.engiweb.toolkit.common.BackendException
        Returns the user external info
        Parameters:
        token - String Authorization string
        realm - String Realm name
        Returns:
        BeanList of UserExtInfoBean
        Throws:
        com.engiweb.toolkit.common.BackendException
      • addEntitlementByGroup

        void addEntitlementByGroup(com.engiweb.pm.entity.BeanList<EntitlementBean> entBeanList,
                                   com.engiweb.pm.entity.BeanList<UserRightsBean> rightsList,
                                   com.engiweb.pm.entity.BeanList<RemediationBean> blRemBean,
                                   UserBean userBean,
                                   GroupBean groupBean,
                                   boolean checkIncompatibility,
                                   java.lang.String cod_operation,
                                   java.lang.String token,
                                   java.lang.String realm)
                            throws com.engiweb.toolkit.common.BackendException
        Insert a list of entitlements
        Parameters:
        entBeanList - Beanlist of EntitlementBean to add
        rightsList - BeanList of UserRightsBean to assign to the user. If null no right is assigned
        blRemBean - BeanList of RemediationBean to assign to the user. If null no remediation is assigned
        userBean - UserBean It must be present and uniquely defined
        groupBean - GroupBean It must be present and uniquely defined
        checkIncompatibility - boolean type. Check the conflicts and, if it's true and new entitlements create conflicts on user, an exception is returned.
        cod_operation - String Code operation. If null PM generates it automatically
        token - String Authorization string
        realm - String Realm name
        Throws:
        com.engiweb.toolkit.common.BackendException
      • removeEntitlement

        @Deprecated
        void removeEntitlement(com.engiweb.pm.entity.BeanList<EntitlementBean> blEntitlementBean,
                                           UserBean userBean,
                                           java.lang.String cod_oper,
                                           java.lang.String token,
                                           java.lang.String realm)
                                    throws com.engiweb.toolkit.common.BackendException
        Removes a list of entitlements from an user from the default hierarchy
        Throws:
        com.engiweb.toolkit.common.BackendException
      • removeEntitlement

        void removeEntitlement(com.engiweb.pm.entity.BeanList<EntitlementBean> blEntitlementBean,
                               java.lang.Integer directlyAssigned,
                               UserBean userBean,
                               java.lang.String cod_oper,
                               java.lang.String token,
                               java.lang.String realm)
                        throws com.engiweb.toolkit.common.BackendException
        Removes a list of roles from an user. The directlyAssigned (value 1) specifies if the role to remove must be assigned direclty to the user or in delegation mode (value 0) or both (value null)
        Parameters:
        blEntitlementBean - List of EntitlementBean to remove
        directlyAssigned - if 1 only direct assignment will be removed, if 0 only delegated, if null both
        userBean - The user to which remove the roles
        cod_operation - String Code operation. If null PM generates it automatically
        token - String Authorization string
        realm - String Realm name
        Throws:
        com.engiweb.toolkit.common.BackendException
      • removeEntitlement

        void removeEntitlement(com.engiweb.pm.entity.BeanList<EntitlementBean> entBeanList,
                               UserBean userBean,
                               HierarchyBean hierarchyBean,
                               java.lang.String cod_operation,
                               java.lang.String token,
                               java.lang.String realm)
                        throws com.engiweb.toolkit.common.BackendException
        Removes a list of entitlements from an user in all the groups belonging to the hierarchy.
        Parameters:
        BeanList - BeanList of EntitlementBean to remove. They must be present and uniquely defined
        userBean - UserBean It must be present and uniquely defined
        hierarchyBean - HierarchyBean It must be present and uniquely defined
        cod_oper - String Code operation. If null PM generates it automatically
        token - String Authorization string
        realm - String Realm name
        Throws:
        com.engiweb.toolkit.common.BackendException
      • removeEntitlement

        void removeEntitlement(com.engiweb.pm.entity.BeanList<EntitlementBean> entBeanList,
                               UserBean userBean,
                               GroupBean groupBean,
                               java.lang.String cod_operation,
                               java.lang.String token,
                               java.lang.String realm)
                        throws com.engiweb.toolkit.common.BackendException
        Removes a list of entitlements from an user.
        Parameters:
        BeanList - BeanList of EntitlementBean to remove. They must be present and uniquely defined
        userBean - UserBean It must be present and uniquely defined
        groupBean - GroupBean It must be present and uniquely defined
        cod_oper - String Code operation. If null PM generates it automatically
        token - String Authorization string
        realm - String Realm name
        Throws:
        com.engiweb.toolkit.common.BackendException
      • moveUser

        @Deprecated
        void moveUser(com.engiweb.pm.entity.BeanList<UserBean> userBeanList,
                                  OrgUnitBean ouStartBean,
                                  OrgUnitBean ouEndBean,
                                  int type,
                                  java.lang.String token,
                                  java.lang.String realm)
                           throws com.engiweb.toolkit.common.BackendException
        Deprecated. replaced by #moveUserByGroup(BeanList, GroupBean, HierarchyBean, GroupBean, int, String, String)
        Throws:
        com.engiweb.toolkit.common.BackendException
      • moveUserInGroup

        void moveUserInGroup(com.engiweb.pm.entity.BeanList<UserBean> userBeanList,
                             GroupBean groupStartBean,
                             GroupBean groupEndBean,
                             int type,
                             java.lang.String token,
                             java.lang.String realm)
                      throws com.engiweb.toolkit.common.BackendException
        Move a list of users from a group hierarchy to another one. If userBeanList is empty and groupStartBean is uniquely defined all user belonging to groupStartBean will be moved. If userBeanList is correctly defined all users contained into the list are moved into groupEnd.
        Parameters:
        userBeanList - of UserBean to move. If not null or not empty they must be uniquely defined
        groupStartBean - GroupBean Starting Group hierarchy. If userBeanList is null or empty groupStartBean must be not null otherwise no movement is performed
        groupEndBean - GroupBean Final group hierarchy. It must be present and uniquely defined
        type -
          1 - Entitlements present in both ouStart and ouEnd will be retained 2 - Only ouEnd default entitlements is assigned to users
        token - String Authorization string
        realm - String Realm name
        Throws:
        com.engiweb.toolkit.common.BackendException
      • findEntitlement

        com.engiweb.pm.entity.BeanList<EntitlementBean> findEntitlement(EntitlementBean entitlementBean,
                                                                        ApplicationBean appBean,
                                                                        UserBean userBean,
                                                                        com.engiweb.pm.entity.Paging paging,
                                                                        java.lang.String token,
                                                                        java.lang.String realmAdm)
                                                                 throws com.engiweb.toolkit.common.BackendException
        Returns entitlements assigned to an user on the default hierarchy filtered by an application
        Parameters:
        entitlementBean - EntitlementBean if null no filter is applied, otherwise the passed object is used as filter
        appBean - ApplicationBean Null or it must be present and uniquely defined
        userBean - UserBean It must be present and uniquely defined
        paging - Paging
        token - String Authorization string
        realm - String Realm name
        Returns:
        BeanList of EntitlementBean
        Throws:
        com.engiweb.toolkit.common.BackendException
      • findEntitlement

        com.engiweb.pm.entity.BeanList<EntitlementBean> findEntitlement(EntitlementBean entitlementBean,
                                                                        ApplicationBean appBean,
                                                                        GroupBean groupBean,
                                                                        UserBean userBean,
                                                                        com.engiweb.pm.entity.Paging paging,
                                                                        java.lang.String token,
                                                                        java.lang.String realmAdm)
                                                                 throws com.engiweb.toolkit.common.BackendException
        Returns entitlements assigned to an user filtered by an application.
        Parameters:
        entitlementBean - EntitlementBean if null no filter is applied, otherwise the passed object is used as filter
        appBean - ApplicationBean Null or it must be present and uniquely defined
        groupBean - GroupBean Null or it must be present and uniquely defined
        userBean - UserBean It must be present and uniquely defined
        paging - Paging
        token - String Authorization string
        realm - String Realm name
        Returns:
        BeanList of EntitlementBean
        Throws:
        com.engiweb.toolkit.common.BackendException
      • findDelegated

        com.engiweb.pm.entity.BeanList<UserBean> findDelegated(UserBean delegatedUser,
                                                               EntitlementBean entitlementBean,
                                                               UserBean representedUser,
                                                               com.engiweb.pm.entity.Paging paging,
                                                               java.lang.String token,
                                                               java.lang.String realm)
                                                        throws com.engiweb.toolkit.common.BackendException
        Returns a list of users delegated by a represented user filtered by entitlement
        Parameters:
        delegatedUser - UserBean if null no filter is applied, otherwise the passed object is used as filter
        entitlementBean - EntitlementBean if null no filter is applied, otherwise the passed object is used as filter
        representedUser - UserBean It must be present and uniquely defined
        paging - Paging
        token - String Authorization string
        realm - String Realm name
        Returns:
        BeanList of UserBean
        Throws:
        com.engiweb.toolkit.common.BackendException
      • findDelegatedByProfile

        com.engiweb.pm.entity.BeanList<UserBean> findDelegatedByProfile(UserBean delegatedUser,
                                                                        EntitlementBean entitlementBean,
                                                                        UserBean representedUser,
                                                                        com.engiweb.pm.entity.Paging paging,
                                                                        java.lang.String token,
                                                                        java.lang.String realm)
                                                                 throws com.engiweb.toolkit.common.BackendException
        Returns a list of users delegated by a represented user filtered by profile type entitlement
        Parameters:
        delegatedUser - UserBean if null no filter is applied, otherwise the passed object is used as filter
        entitlementBean - EntitlementBean if null no filter is applied, otherwise the passed object is used as filter and entitlement type is forced to PROFILE
        representedUser - UserBean It must be present and uniquely defined
        paging - Paging
        token - String Authorization string
        realm - String Realm name
        Returns:
        BeanList of UserBean
        Throws:
        com.engiweb.toolkit.common.BackendException
      • findDelegatedEntitlement

        com.engiweb.pm.entity.BeanList<EntitlementBean> findDelegatedEntitlement(EntitlementBean entitlementBean,
                                                                                 UserBean representedUser,
                                                                                 UserBean delegatedUser,
                                                                                 com.engiweb.pm.entity.Paging paging,
                                                                                 java.lang.String token,
                                                                                 java.lang.String realm)
                                                                          throws com.engiweb.toolkit.common.BackendException
        Returns a list of entitlements a represended user gave delegated
        Parameters:
        entitlementBean - EntitlementBean if null no filter is applied, otherwise the passed object is used as filter
        representedUser - UserBean It must be present and uniquely defined
        delegatedUser - UserBean if null no filter is applied, otherwise the passed object is used as filter
        paging - Paging
        token - String Authorization string
        realm - String Realm name
        Returns:
        BeanList of EntitlementBean
        Throws:
        com.engiweb.toolkit.common.BackendException
      • findEntitlementDelegation

        com.engiweb.pm.entity.BeanList<EntitlementBean> findEntitlementDelegation(EntitlementBean entitlementBean,
                                                                                  UserBean delegatedUser,
                                                                                  UserBean representedUser,
                                                                                  com.engiweb.pm.entity.Paging paging,
                                                                                  java.lang.String token,
                                                                                  java.lang.String realm)
                                                                           throws com.engiweb.toolkit.common.BackendException
        Returns a list of entitlements a delegated user has been delegated from a represented
        Parameters:
        entitlementBean - EntitlementBean if null no filter is applied, otherwise the passed object is used as filter
        delegatedUser - UserBean It must be present and uniquely defined
        representedUser - UserBean if null no filter is applied, otherwise the passed object is used as filter
        paging - Paging
        token - String Authorization string
        realm - String Realm name
        Returns:
        BeanList of EntitlementBean
        Throws:
        com.engiweb.toolkit.common.BackendException
      • findRepresented

        com.engiweb.pm.entity.BeanList<UserBean> findRepresented(UserBean representedUser,
                                                                 EntitlementBean entitlementBean,
                                                                 UserBean delegatedUser,
                                                                 com.engiweb.pm.entity.Paging paging,
                                                                 java.lang.String token,
                                                                 java.lang.String realm)
                                                          throws com.engiweb.toolkit.common.BackendException
        Returns a list of entitlements a delegated user has been delegated from a represented
        Parameters:
        representedUser - UserBean if null no filter is applied, otherwise the passed object is used as filter
        entitlementBean - EntitlementBean if null no filter is applied, otherwise the passed object is used as filter
        delegatedUser - UserBean It must be present and uniquely defined
        paging - Paging
        token - String Authorization string
        realm - String Realm name
        Returns:
        BeanList of UserBean
        Throws:
        com.engiweb.toolkit.common.BackendException
      • findDelegantByProfile

        com.engiweb.pm.entity.BeanList<UserBean> findDelegantByProfile(UserBean represented,
                                                                       EntitlementBean entitlementBean,
                                                                       UserBean delegated,
                                                                       com.engiweb.pm.entity.Paging paging,
                                                                       java.lang.String token,
                                                                       java.lang.String realm)
                                                                throws com.engiweb.toolkit.common.BackendException
        Returns a list of entitlements a delegated user has been delegated from a represented
        Parameters:
        representedUser - UserBean if null no filter is applied, otherwise the passed object is used as filter
        entitlementBean - EntitlementBean if null no filter is applied, otherwise the passed object is used as filter and entitlement type is forced to PROFILE
        delegatedUser - UserBean It must be present and uniquely defined
        paging - Paging
        token - String Authorization string
        realm - String Realm name
        Returns:
        BeanList of UserBean
        Throws:
        com.engiweb.toolkit.common.BackendException
      • addDelegatedEnt

        void addDelegatedEnt(UserBean delegatedUser,
                             UserBean representedUser,
                             com.engiweb.pm.entity.BeanList<EntitlementBean> blEntitlementBean,
                             com.engiweb.pm.entity.BeanList<RemediationBean> blRemBean,
                             boolean checkIncompatibility,
                             java.lang.String cod_operation,
                             java.lang.String token,
                             java.lang.String realm)
                      throws com.engiweb.toolkit.common.BackendException
        Adds a list of entitlements delegated to a user
        Parameters:
        delegatedUser - UserBean It must be present and uniquely defined
        representedUser - UserBean It must be present and uniquely defined
        blEntitlementBean - BeanList of EntitlementBean with delegation start date and end date valued
        blRemBean - BeanList of RemediationBean to assign to the user
        checkIncompatibility - boolean type provides the level of incompatibility
        cod_oper - String Code operation. If null PM generates it automatically
        token - String Authorization string
        realm - String Realm name
        Throws:
        com.engiweb.toolkit.common.BackendException
      • removeDelegatedEnt

        void removeDelegatedEnt(UserBean delegatedUser,
                                UserBean representedUser,
                                com.engiweb.pm.entity.BeanList<EntitlementBean> blEntitlementBean,
                                java.lang.String cod_oper,
                                java.lang.String token,
                                java.lang.String realm)
                         throws com.engiweb.toolkit.common.BackendException
        Removes a list of entitlements delegated to a user
        Parameters:
        delegatedUser - UserBean It must be present and uniquely defined
        representedUser - UserBean It must be present and uniquely defined
        blEntitlementBean - BeanList of EntitlementBean to remove
        cod_oper - String Code operation. If null PM generates it automatically
        token - String Authorization string
        realm - String Realm name
        Throws:
        com.engiweb.toolkit.common.BackendException
      • addResource

        void addResource(UserBean userBean,
                         EntitlementBean entitlementBean,
                         com.engiweb.pm.entity.BeanList<com.engiweb.pm.web.bean.AbstractBean> blResources,
                         java.lang.String cod_oper,
                         java.lang.String token,
                         java.lang.String realm)
                  throws com.engiweb.toolkit.common.BackendException
        Add a list of resources to an user
        Parameters:
        userBean - UserBean It must be present and uniquely defined
        entitlementBean - EntitlementBean It must be present and uniquely defined
        blResources - BeanList of ResourceBean to add
        cod_oper - String Code operation. If null PM generates it automatically
        token - String Authorization string
        realm - String Realm name
        Throws:
        com.engiweb.toolkit.common.BackendException
      • addResource

        void addResource(UserBean userBean,
                         EntitlementBean entitlementBean,
                         GroupBean groupBean,
                         com.engiweb.pm.entity.BeanList<com.engiweb.pm.web.bean.AbstractBean> blResources,
                         java.lang.String cod_oper,
                         java.lang.String token,
                         java.lang.String realm)
                  throws com.engiweb.toolkit.common.BackendException
        Add a list of resources to an user
        Parameters:
        userBean - UserBean It must be present and uniquely defined
        entitlementBean - EntitlementBean It must be present and uniquely defined
        groupBean - GroupBean It must be present and uniquely defined
        blResources - BeanList of ResourceBean to add
        cod_oper - String Code operation. If null PM generates it automatically
        token - String Authorization string
        realm - String Realm name
        Throws:
        com.engiweb.toolkit.common.BackendException
      • removeResource

        void removeResource(UserBean userBean,
                            EntitlementBean entitlementBean,
                            com.engiweb.pm.entity.BeanList blResources,
                            java.lang.String cod_oper,
                            java.lang.String token,
                            java.lang.String realm)
                     throws com.engiweb.toolkit.common.BackendException
        Add a list of resources from an user
        Parameters:
        userBean - UserBean It must be present and uniquely defined
        entitlementBean - EntitlementBean It must be present and uniquely defined
        blResources - BeanList of ResourceBean to remove
        cod_oper - String Code operation. If null PM generates it automatically
        token - String Authorization string
        realm - String Realm name
        Throws:
        com.engiweb.toolkit.common.BackendException
      • findResources

        com.engiweb.pm.entity.BeanList<? extends com.engiweb.pm.web.bean.AbstractBean> findResources(com.engiweb.pm.web.bean.AbstractBean resBean,
                                                                                                     UserBean userBean,
                                                                                                     EntitlementBean bean,
                                                                                                     int type,
                                                                                                     boolean grouped,
                                                                                                     com.engiweb.pm.entity.Paging paging,
                                                                                                     java.lang.String token,
                                                                                                     java.lang.String realm)
                                                                                              throws com.engiweb.toolkit.common.BackendException
        Returns resources assigned to an user
        Parameters:
        resBean - AbstractBean if null no filter is applied, otherwise the passed object is used as filter
        userBean - UserBean It must be present and uniquely defined
        bean - EntitlementBean It must be present and uniquely defined
        int - type: type of resources to research
        • 1=inheritable resources of user's ou
        • 2=resources assigned punctually to an user
        • 3=internal resources of OU type
        • 4=internal resources of ENTITLEMENT type
        • 5=internal resources of APPLICATION type
        • 6=internal resources of RESOURCE TYPE type
        • 7=internal resources of RESOURCE FAMILY type
        • 8=internal resources of TASK type
        grouped - : boolean type. If type is 3 returns internal resources of ou type hierarchically higher (if true), all resources otherwise
        paging - Paging
        token - String Authorization string
        realm - String Realm name
        Returns:
        BeanList of AbstractBean
        Throws:
        com.engiweb.toolkit.common.BackendException
      • findOU

        @Deprecated
        com.engiweb.pm.entity.BeanList<OrgUnitBean> findOU(UserBean userBean,
                                                                       java.lang.String token,
                                                                       java.lang.String realm)
                                                                throws com.engiweb.toolkit.common.BackendException
        Deprecated. replaced by #findGroup(UserBean, String, String)
        Throws:
        com.engiweb.toolkit.common.BackendException
      • findGroup

        com.engiweb.pm.entity.BeanList<GroupBean> findGroup(GroupBean groupBean,
                                                            HierarchyBean hierarchyBean,
                                                            UserBean userBean,
                                                            java.lang.String token,
                                                            java.lang.String realm)
                                                     throws com.engiweb.toolkit.common.BackendException
        Returns a BeanList of GroupBean an user belong
        Parameters:
        groupBean - GroupBean if null no filter is applied, otherwise the passed object is used as filter
        hierarchyBean - HierarchyBean if null no filter is applied, otherwise the passed object is used as filter
        userBean - String It must be present and uniquely defined
        token - String Authorization string
        realm - String Realm name
        Returns:
        BeanList of GroupBean
        Throws:
        com.engiweb.toolkit.common.BackendException
      • findAccount

        com.engiweb.pm.entity.BeanList<AccountBean> findAccount(AccountBean accountBean,
                                                                UserBean userBean,
                                                                com.engiweb.pm.entity.Paging paging,
                                                                java.lang.String token,
                                                                java.lang.String realm)
                                                         throws com.engiweb.toolkit.common.BackendException
        Returns BeanList of AccountBean of an user
        Parameters:
        accountBean - AccountBean if null no filter is applied, otherwise the passed object is used as filter
        userBean - UserBean It must be present and uniquely defined
        paging - Paging
        token - String Authorization string
        realm - String Realm name
        Returns:
        BeanList of AccountBean
        Throws:
        com.engiweb.toolkit.common.BackendException
      • addServicePending

        void addServicePending(java.util.HashMap<EntitlementBean,com.engiweb.pm.entity.BeanList<ServiceAttributeBean>> blServiceBean,
                               java.lang.String request,
                               UserBean userBean,
                               java.lang.String token,
                               java.lang.String realm)
                        throws com.engiweb.toolkit.common.BackendException
        Add a list of services to an user
        Parameters:
        blServiceBean - BeanList of ServiceBean to assign to an user
        request - String it's mandatory
        userBean - UserBean It must be present and uniquely defined
        token - String Authorization string
        realm - String Realm name
        Throws:
        com.engiweb.toolkit.common.BackendException
      • removeServicePending

        void removeServicePending(java.lang.String request,
                                  UserBean userBean,
                                  java.lang.String token,
                                  java.lang.String realm)
                           throws com.engiweb.toolkit.common.BackendException
        Removes services related to a request to an user
        Parameters:
        request - String it's mandatory
        userBean - UserBean It must be present and uniquely defined
        token - String Authorization string
        realm - String Realm name
        Throws:
        com.engiweb.toolkit.common.BackendException
      • findServicePending

        java.util.HashMap<EntitlementBean,com.engiweb.pm.entity.BeanList<ServiceAttributeBean>> findServicePending(ServiceAttributeBean serviceAttributeBean,
                                                                                                                   java.lang.String request,
                                                                                                                   UserBean userBean,
                                                                                                                   java.lang.String token,
                                                                                                                   java.lang.String realm)
                                                                                                            throws com.engiweb.toolkit.common.BackendException
        Parameters:
        serviceAttributeBean - UserBean It must be present and uniquely defined
        request - String it's mandatory
        userBean - UserBean It must be present and uniquely defined
        token - String Authorization string
        realm - String Realm name
        Returns:
        HashMap of EntitlementBean and BeanList of AccountBean
        Throws:
        com.engiweb.toolkit.common.BackendException
      • findResourcesByProfile

        com.engiweb.pm.entity.BeanList findResourcesByProfile(com.engiweb.pm.web.bean.AbstractBean resBean,
                                                              UserBean userBean,
                                                              EntitlementBean entProfileBean,
                                                              IntResource type,
                                                              boolean grouped,
                                                              com.engiweb.pm.entity.Paging pNew,
                                                              java.lang.String token,
                                                              java.lang.String realm)
                                                       throws com.engiweb.toolkit.common.BackendException
        Returns user resources assigned to an entitlement having a given entitlement of profile type
        Parameters:
        resBean - AbstractBean if null no filter is applied, otherwise the passed object is used as filter
        userBean - UserBean It must be present and uniquely defined
        entProfileBean - EntitlementBean It must be present and uniquely defined and entitlements must be profile type
        int - type:
        • 1=inheritable resources of user's ou
        • 2=resources assigned punctually to an user
        • 3=internal resources of OU type
        • 4=internal resources of ENTITLEMENT type
        • 5=internal resources of APPLICATION type
        • 6=internal resources of RESOURCE TYPE type
        • 7=internal resources of RESOURCE FAMILY type
        • 8=internal resources of TASK type
        grouped - boolean type. associated to type=3 allws to search for OU type resources hierarchically higher (true) or all (false)
        paging - Paging
        String - String Authorization string
        realm - String Realm name
        Returns:
        BeanList of AbstractBean according with resource type searched
        Throws:
        com.engiweb.toolkit.common.BackendException
      • findRemediation

        com.engiweb.pm.entity.BeanList<RemediationBean> findRemediation(RemediationBean remBean,
                                                                        UserBean userBean,
                                                                        com.engiweb.pm.entity.Paging paging,
                                                                        java.lang.String token,
                                                                        java.lang.String realmAdm)
                                                                 throws com.engiweb.toolkit.common.BackendException
        Adds remediations to a user
        Parameters:
        remBean - RemediationBean if null no filter is applied, otherwise the passed object is used as filter
        userBean - UserBean It must be present and uniquely defined
        paging - Paging
        token - String Authorization string
        realm - String Realm name
        Returns:
        BeanList of RemediationBean
        Throws:
        com.engiweb.toolkit.common.BackendException
      • addRemediation

        void addRemediation(com.engiweb.pm.entity.BeanList<RemediationBean> blRemBean,
                            UserBean userBean,
                            java.lang.String token,
                            java.lang.String realmAdm)
                     throws com.engiweb.toolkit.common.BackendException
        Adds remediations to a user
        Parameters:
        blRemBean - BeanList of RemediationBean. They must be present and uniquely defined
        userBean - UserBean It must be present and uniquely defined
        token - String Authorization string
        realmAdm - String Realm name
        Throws:
        com.engiweb.toolkit.common.BackendException
      • removeRemediation

        void removeRemediation(com.engiweb.pm.entity.BeanList<RemediationBean> blRemBean,
                               UserBean userBean,
                               java.lang.String token,
                               java.lang.String realmAdm)
                        throws com.engiweb.toolkit.common.BackendException
        Removes remediation from a user
        Parameters:
        blRemBean - BeanList of RemediationBean. They must be present and uniquely defined
        userBean - UserBean It must be present and uniquely defined
        envBean - EnvironmentBean
        token - String Authorization string
        realmAdm - String Realm name
        Throws:
        com.engiweb.toolkit.common.BackendException
      • findRiskRemediation

        java.util.HashMap<RiskBean,com.engiweb.pm.entity.BeanList<RemediationBean>> findRiskRemediation(com.engiweb.pm.entity.BeanList<RiskBean> riskList,
                                                                                                        UserBean userBean,
                                                                                                        EnvironmentBean envBean,
                                                                                                        com.engiweb.pm.entity.Paging paging,
                                                                                                        java.lang.String token,
                                                                                                        java.lang.String realmAdm)
                                                                                                 throws com.engiweb.toolkit.common.BackendException
        Return the remediations associated to a specific risk of an user
        Parameters:
        riskList - BeanList of RiskBean. They must be present and uniquely defined
        userBean - UserBean It must be present and uniquely defined
        envBean - EnvironmentBean. If null, the working environment is selected automatically
        paging - Paging
        token - String Authorization string
        realmAdm - String Realm name
        Returns:
        HashMap of RiskBean and BeanList of RemediationBean
        Throws:
        com.engiweb.toolkit.common.BackendException
      • findApplication

        com.engiweb.pm.entity.BeanList<ApplicationBean> findApplication(ApplicationBean appBean,
                                                                        UserBean userBean,
                                                                        com.engiweb.pm.entity.Paging paging,
                                                                        java.lang.String token,
                                                                        java.lang.String realmAdm)
                                                                 throws com.engiweb.toolkit.common.BackendException
        Returns the application associated to user
        Parameters:
        appBean - ApplicationBean used as filer (optional)
        userBean - UserBean It must be present and uniquely defined
        paging - Paging
        token - String Authorization string
        realmAdm - String Realm name
        Returns:
        BeanList of ApplicationBean
        Throws:
        com.engiweb.toolkit.common.BackendException
      • findResource

        com.engiweb.pm.entity.BeanList<? extends com.engiweb.pm.web.bean.AbstractBean> findResource(com.engiweb.pm.web.bean.AbstractBean resBean,
                                                                                                    UserBean userBean,
                                                                                                    com.engiweb.pm.entity.BeanList<EntitlementBean> blEntitlementBean,
                                                                                                    int type,
                                                                                                    boolean grouped,
                                                                                                    com.engiweb.pm.entity.Paging paging,
                                                                                                    java.lang.String token,
                                                                                                    java.lang.String realm)
                                                                                             throws com.engiweb.toolkit.common.BackendException
        Return the resources of a specific type given an user
        Parameters:
        resBean - AbstractBean used as filer (optional)
        userBean - UserBean It must be present and uniquely defined
        blEntitlementBean - BeanList of EntitlementBean
        type - int type.
        • 1=inheritable resources of user's ou
        • 2=resources assigned punctually to an user
        • 3=internal resources of OU type
        • 4=internal resources of ENTITLEMENT type
        • 5=internal resources of APPLICATION type
        • 6=internal resources of RESOURCE TYPE type
        • 7=internal resources of RESOURCE FAMILY type
        • 8=internal resources of TASK type
        grouped - boolean type. associated to type=3 allws to search for OU type resources hierarchically higher (true) or all (false)
        paging - Paging
        token - String Authorization string
        realm - String Realm name
        Returns:
        BeanList of AbstractBean according with resource type searched
        Throws:
        com.engiweb.toolkit.common.BackendException
      • findOwnership

        com.engiweb.pm.entity.BeanList<com.engiweb.pm.web.bean.AbstractBean> findOwnership(com.engiweb.pm.web.bean.AbstractBean filter,
                                                                                           UserBean userBean,
                                                                                           com.engiweb.pm.entity.Paging paging,
                                                                                           java.lang.String token,
                                                                                           java.lang.String realm)
                                                                                    throws com.engiweb.toolkit.common.BackendException
        Throws:
        com.engiweb.toolkit.common.BackendException
      • checkPermission

        com.engiweb.pm.entity.BeanList<EntitlementBean> checkPermission(UserBean userBean,
                                                                        EntitlementBean entBean,
                                                                        java.lang.String token,
                                                                        java.lang.String realm)
                                                                 throws com.engiweb.toolkit.common.BackendException
        Given an user check whether, permission inside the role, is verified or not from target
        Parameters:
        userBean - UserBean It must be present and uniquely defined
        entBean - EntitlementBean It must be present and uniquely defined
        token - String Authorization string
        realm - String Realm name
        Returns:
        BeanList of EntitlementBean
        Throws:
        com.engiweb.toolkit.common.BackendException
      • checkPersonProfileByRole

        com.engiweb.pm.entity.BeanList<PersonProfileBean> checkPersonProfileByRole(UserBean userBean,
                                                                                   EntitlementBean entBean,
                                                                                   EntitlementBean filterEntitlementChild,
                                                                                   java.lang.Long status,
                                                                                   java.lang.String token,
                                                                                   java.lang.String realm)
                                                                            throws com.engiweb.toolkit.common.BackendException
        Given an user check whether, permission inside the role, is verified or not from target
        Parameters:
        userBean - UserBean It must be present and uniquely defined
        entBean - EntitlementBean It must be present and uniquely defined
        filterEntitlementChild - EntitlementBean if null no filter is applied, otherwise the passed object is used as filter
        token - String Authorization string
        realm - String Realm name
        Returns:
        BeanList of PersonProfileBean
        Throws:
        com.engiweb.toolkit.common.BackendException
      • findOwnerResources

        com.engiweb.pm.entity.BeanList<?> findOwnerResources(com.engiweb.pm.web.bean.AbstractBean resBean,
                                                             UserBean userBean,
                                                             IntResource type,
                                                             com.engiweb.pm.entity.Paging paging,
                                                             java.lang.String token,
                                                             java.lang.String realm)
                                                      throws com.engiweb.toolkit.common.BackendException
        Return the resources of a certain type owned by the specified user
        Parameters:
        resBean - AbstractBean used as filer (optional)
        userBean - UserBean It must be present and uniquely defined
        type - IntResource it's mandatory
        paging - Paging
        token - String Authorization string
        realm - String Realm name
        Returns:
        BeanList of AbstractBean according with resource type searched
        Throws:
        com.engiweb.toolkit.common.BackendException
      • findEntitlementDelegationInGroup

        com.engiweb.pm.entity.BeanList<EntitlementBean> findEntitlementDelegationInGroup(EntitlementBean entBean,
                                                                                         UserBean delegated,
                                                                                         UserBean represented,
                                                                                         GroupBean groupBean,
                                                                                         HierarchyBean hierarchyBean,
                                                                                         com.engiweb.pm.entity.Paging paging,
                                                                                         java.lang.String token,
                                                                                         java.lang.String realm)
                                                                                  throws com.engiweb.toolkit.common.BackendException
        Throws:
        com.engiweb.toolkit.common.BackendException
      • checkPersonProfileServiceByRole

        com.engiweb.pm.entity.BeanList<PersonProfileServiceBean> checkPersonProfileServiceByRole(UserBean userBean,
                                                                                                 EntitlementBean entBean,
                                                                                                 EntitlementBean filterEntitlementChild,
                                                                                                 java.lang.Long status,
                                                                                                 java.lang.String token,
                                                                                                 java.lang.String realm)
                                                                                          throws com.engiweb.toolkit.common.BackendException
        Given an user check whether,right of permission inside the role, is verified or not from target
        Parameters:
        userBean - UserBean It must be present and uniquely defined
        entBean - EntitlementBean It must be present and uniquely defined
        token - String Authorization string
        realm - String Realm name
        Returns:
        BeanList of PersonProfileServiceBean
        Throws:
        com.engiweb.toolkit.common.BackendException
      • addEntitlementNoDefHierGroup

        void addEntitlementNoDefHierGroup(com.engiweb.pm.entity.BeanList<EntitlementBean> entBeanList,
                                          com.engiweb.pm.entity.BeanList<UserRightsBean> rightsList,
                                          com.engiweb.pm.entity.BeanList<RemediationBean> blRemBean,
                                          UserBean userBean,
                                          GroupBean groupBean,
                                          boolean checkIncompatibility,
                                          java.lang.String cod_operation,
                                          java.lang.String token,
                                          java.lang.String realm)
                                   throws com.engiweb.toolkit.common.BackendException
        Add entitlements to an user in a group belonging to a non default hierarchy
        Parameters:
        entBeanList - BeanList of EntitlementBean to add. If null only the default entitlements are assigned to the user. If the user in not still in the group he is added
        rightsList - BeanList of UserRightsBean to assign to the user. If null no right is assigned
        blRemBean - BeanList of RemediationBean to assign to the user. If null no remediation is assigned
        userBean - UserBean It must be present and uniquely defined
        groupBean - GroupBean It must be present and uniquely defined
        checkIncompatibility - boolean type. Check the conflicts and, if it's true and new entitlements create conflicts on user, an exception is returned.
        token - String Authorization string
        realm - String Realm name
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception
      • removeEntitlementNotDefHier

        void removeEntitlementNotDefHier(UserBean user,
                                         GroupBean groupBean,
                                         com.engiweb.pm.entity.BeanList<EntitlementBean> entBL,
                                         java.lang.String token,
                                         java.lang.String realm)
                                  throws com.engiweb.toolkit.common.BackendException
        Parameters:
        userBean - UserBean It must be present and uniquely defined
        groupBean - GroupBeanIt must be present and uniquely defined.
        entBL - BeanList of EntitlementBean to remove.
        checkIncompatibility - boolean type. Check the conflicts and, if it's true and new entitlements create conflicts on user, an exception is returned.
        token - String Authorization string
        realm - String Realm name
        Throws:
        com.engiweb.toolkit.common.BackendException - the backend exception