Package org.kuali.rice.kim.api.services

Interface IdentityManagementService

  • All Known Implementing Classes:
    IdentityManagementServiceImpl
    public interface IdentityManagementService
    This is the front end for the KIM module. Clients of KIM should access this service from their applications. If KIM is not running on the same machine (VM) as the application (as would be the case with a standalone Rice server), then this service should be implemented locally within the application and access the core KIM services (Authentication/Authorization/Identity/Group) via the service bus. For efficiency, implementations of this interface should add appropriate caching of the information retrieved from the core services for load and performance reasons. Most of the methods on this interface are straight pass-thrus to methods on the four core services.
    Author:
    Kuali Rice Team (rice.collab@kuali.org)

    • Method Detail

      • getPrincipal

        org.kuali.rice.kim.api.identity.principal.Principal getPrincipal​(String principalId)

      • getPrincipalByPrincipalName

        org.kuali.rice.kim.api.identity.principal.Principal getPrincipalByPrincipalName​(String principalName)

      • getPrincipalByPrincipalNameAndPassword

        org.kuali.rice.kim.api.identity.principal.Principal getPrincipalByPrincipalNameAndPassword​(String principalName,
                                                                                           String password)

      • getEntityDefaultInfo

        org.kuali.rice.kim.api.identity.entity.EntityDefault getEntityDefaultInfo​(String entityId)

      • getEntityDefaultInfoByPrincipalId

        org.kuali.rice.kim.api.identity.entity.EntityDefault getEntityDefaultInfoByPrincipalId​(String principalId)

      • getEntityDefaultInfoByPrincipalName

        org.kuali.rice.kim.api.identity.entity.EntityDefault getEntityDefaultInfoByPrincipalName​(String principalName)

      • findEntityDefaults

        org.kuali.rice.kim.api.identity.entity.EntityDefaultQueryResults findEntityDefaults​(QueryByCriteria queryByCriteria)

      • getEntity

        org.kuali.rice.kim.api.identity.entity.Entity getEntity​(String entityId)

      • getEntityByPrincipalId

        org.kuali.rice.kim.api.identity.entity.Entity getEntityByPrincipalId​(String principalId)

      • getEntityByPrincipalName

        org.kuali.rice.kim.api.identity.entity.Entity getEntityByPrincipalName​(String principalName)

      • findEntities

        org.kuali.rice.kim.api.identity.entity.EntityQueryResults findEntities​(QueryByCriteria queryByCriteria)

      • getAddressType

        org.kuali.rice.kim.api.identity.CodedAttribute getAddressType​(String code)

      • getAffiliationType

        org.kuali.rice.kim.api.identity.affiliation.EntityAffiliationType getAffiliationType​(String code)

      • getCitizenshipStatus

        org.kuali.rice.kim.api.identity.CodedAttribute getCitizenshipStatus​(String code)

      • getEmailType

        org.kuali.rice.kim.api.identity.CodedAttribute getEmailType​(String code)

      • getEmploymentStatus

        org.kuali.rice.kim.api.identity.CodedAttribute getEmploymentStatus​(String code)

      • getEmploymentType

        org.kuali.rice.kim.api.identity.CodedAttribute getEmploymentType​(String code)

      • getEntityNameType

        org.kuali.rice.kim.api.identity.CodedAttribute getEntityNameType​(String code)

      • getEntityType

        org.kuali.rice.kim.api.identity.CodedAttribute getEntityType​(String code)

      • getExternalIdentifierType

        org.kuali.rice.kim.api.identity.external.EntityExternalIdentifierType getExternalIdentifierType​(String code)

      • getPhoneType

        org.kuali.rice.kim.api.identity.CodedAttribute getPhoneType​(String code)

      • getGroup

        org.kuali.rice.kim.api.group.Group getGroup​(String groupId)

      • getGroupByName

        org.kuali.rice.kim.api.group.Group getGroupByName​(String namespaceCode,
                                                  String groupName)

      • getDirectParentGroupIds

        List<String> getDirectParentGroupIds​(String groupId)

      • getGroupIdsForPrincipal

        List<String> getGroupIdsForPrincipal​(String principalId)

      • getGroupIdsForPrincipal

        List<String> getGroupIdsForPrincipal​(String principalId,
                                     String namespaceCode)

      • getGroupsForPrincipal

        List<? extends org.kuali.rice.kim.api.group.Group> getGroupsForPrincipal​(String principalId)

      • getGroupsForPrincipal

        List<? extends org.kuali.rice.kim.api.group.Group> getGroupsForPrincipal​(String principalId,
                                                                         String namespaceCode)

      • getDirectMemberGroupIds

        List<String> getDirectMemberGroupIds​(String groupId)

      • isMemberOfGroup

        boolean isMemberOfGroup​(String principalId,
                        String groupId)

      • isMemberOfGroup

        boolean isMemberOfGroup​(String principalId,
                        String namespaceCode,
                        String groupName)

      • isGroupMemberOfGroup

        boolean isGroupMemberOfGroup​(String potentialMemberGroupId,
                             String potentialParentId)

      • getGroupMemberPrincipalIds

        List<String> getGroupMemberPrincipalIds​(String groupId)

      • getDirectGroupMemberPrincipalIds

        List<String> getDirectGroupMemberPrincipalIds​(String groupId)

      • addGroupToGroup

        boolean addGroupToGroup​(String childId,
                        String parentId)

      • removeGroupFromGroup

        boolean removeGroupFromGroup​(String childId,
                             String parentId)

      • addPrincipalToGroup

        boolean addPrincipalToGroup​(String principalId,
                            String groupId)

      • removePrincipalFromGroup

        boolean removePrincipalFromGroup​(String principalId,
                                 String groupId)

      • createGroup

        org.kuali.rice.kim.api.group.Group createGroup​(org.kuali.rice.kim.api.group.Group group)

      • removeAllMembers

        void removeAllMembers​(String groupId)

      • updateGroup

        org.kuali.rice.kim.api.group.Group updateGroup​(String groupId,
                                               org.kuali.rice.kim.api.group.Group group)

      • hasPermissionByTemplate

        boolean hasPermissionByTemplate​(String principalId,
                                String namespaceCode,
                                String permissionTemplateName,
                                Map<String,​String> permissionDetails)

      • getAuthorizedPermissions

        List<org.kuali.rice.kim.api.permission.Permission> getAuthorizedPermissions​(String principalId,
                                                                            String namespaceCode,
                                                                            String permissionName,
                                                                            Map<String,​String> permissionDetails,
                                                                            Map<String,​String> qualification)
        Returns the matching permission objects for a principal.

      • getAuthorizedPermissionsByTemplate

        List<org.kuali.rice.kim.api.permission.Permission> getAuthorizedPermissionsByTemplate​(String principalId,
                                                                                      String namespaceCode,
                                                                                      String permissionTemplateName,
                                                                                      Map<String,​String> permissionDetails,
                                                                                      Map<String,​String> qualification)

      • getPermissionAssignees

        List<org.kuali.rice.kim.api.common.assignee.Assignee> getPermissionAssignees​(String namespaceCode,
                                                                             String permissionName,
                                                                             Map<String,​String> permissionDetails,
                                                                             Map<String,​String> qualification)

      • getPermissionAssigneesForTemplate

        List<org.kuali.rice.kim.api.common.assignee.Assignee> getPermissionAssigneesForTemplate​(String namespaceCode,
                                                                                        String permissionTemplateName,
                                                                                        Map<String,​String> permissionDetails,
                                                                                        Map<String,​String> qualification)

      • getResponsibility

        org.kuali.rice.kim.api.responsibility.Responsibility getResponsibility​(String responsibilityId)
        Get the responsibility object with the given ID.

      • getResponsibilityByName

        org.kuali.rice.kim.api.responsibility.Responsibility getResponsibilityByName​(String namespaceCode,
                                                                             String responsibilityName)
        Return the responsibility object for the given unique combination of namespace, component and responsibility name.

      • hasResponsibility

        boolean hasResponsibility​(String principalId,
                          String namespaceCode,
                          String responsibilityName,
                          Map<String,​String> qualification)
        Check whether the principal has the given responsibility within the passed qualifier.

      • hasResponsibilityByTemplate

        boolean hasResponsibilityByTemplate​(String principalId,
                                    String namespaceCode,
                                    String responsibilityTemplateName,
                                    Map<String,​String> qualification,
                                    Map<String,​String> responsibilityDetails)
        Check whether the principal has the given responsibility within the passed qualifier.

      • getResponsibilityActions

        List<org.kuali.rice.kim.api.responsibility.ResponsibilityAction> getResponsibilityActions​(String namespaceCode,
                                                                                          String responsibilityName,
                                                                                          Map<String,​String> qualification,
                                                                                          Map<String,​String> responsibilityDetails)

      • getResponsibilityActionsByTemplate

        List<org.kuali.rice.kim.api.responsibility.ResponsibilityAction> getResponsibilityActionsByTemplate​(String namespaceCode,
                                                                                                    String responsibilityTemplateName,
                                                                                                    Map<String,​String> qualification,
                                                                                                    Map<String,​String> responsibilityDetails)

      • isPermissionDefinedForTemplate

        boolean isPermissionDefinedForTemplate​(String namespaceCode,
                                       String permissionTemplateName,
                                       Map<String,​String> permissionDetails)
        Returns true if there are any assigned permissions with the given template.

      • flushAllCaches

        void flushAllCaches()

      • flushEntityPrincipalCaches

        void flushEntityPrincipalCaches()

      • flushGroupCaches

        void flushGroupCaches()

      • flushPermissionCaches

        void flushPermissionCaches()

      • flushResponsibilityCaches

        void flushResponsibilityCaches()