Package de.dlr.proseo.usermgr.rest

Class GroupManager

java.lang.Object
de.dlr.proseo.usermgr.rest.GroupManager
@Component @Transactional(isolation=REPEATABLE_READ) public class GroupManager extends Object
Service methods required to manage user group groups.
Author:
Dr. Thomas Bassler

  • Field Details

    • groupRepository

      @Autowired GroupRepository groupRepository
      Repository for User group objects

    • userRepository

      @Autowired UserRepository userRepository
      Repository for User objects

    • groupMemberRepository

      @Autowired GroupMemberRepository groupMemberRepository
      Repository for group members

  • Constructor Details

    • GroupManager

      public GroupManager()

  • Method Details

    • toModelGroup

      static Group toModelGroup(RestGroup restGroup) throws IllegalArgumentException
      Convert a user group from REST format to the prosEO data model format (including authorities)
      Parameters:
      restGroup - the REST user group to convert
      Returns:
      the converted model user group
      Throws:
      IllegalArgumentException - if an invalid authority value was given

    • toRestGroup

      static RestGroup toRestGroup(Group modelGroup)
      Convert a user group from prosEO data model format to REST format (including authorities)
      Parameters:
      modelGroup - the model user group to convert
      Returns:
      the converted REST user

    • createGroup

      public RestGroup createGroup(RestGroup restGroup) throws IllegalArgumentException
      Create a user group (optionally with direct authorities)
      Parameters:
      restGroup - a Json representation of the new user group
      Returns:
      a Json representation of the user group after creation
      Throws:
      IllegalArgumentException - if any of the input data was invalid

    • getGroups

      public List<RestGroup> getGroups(String mission, String groupName, Integer recordFrom, Integer recordTo) throws jakarta.persistence.NoResultException, org.springframework.web.client.HttpClientErrorException
      Get user groups by mission and optionally by group name
      Parameters:
      mission - the mission code
      groupName - the group name (optional)
      recordFrom - first record of filtered and ordered result to return
      recordTo - last record of filtered and ordered result to return
      Returns:
      a list of Json objects representing the user groups authorized for the given mission
      Throws:
      org.springframework.web.client.HttpClientErrorException - if the result list exceeds a configured maximum
      jakarta.persistence.NoResultException - if no groups matching the search criteria can be found

    • getGroupById

      public RestGroup getGroupById(Long id) throws IllegalArgumentException, jakarta.persistence.NoResultException
      Get a user group by ID
      Parameters:
      id - the user group ID
      Returns:
      a Json object corresponding to the user group found
      Throws:
      IllegalArgumentException - if no user group ID was given
      jakarta.persistence.NoResultException - if no user group with the given ID exists

    • deleteGroupById

      public void deleteGroupById(Long id) throws jakarta.persistence.EntityNotFoundException, RuntimeException
      Delete a user group by ID
      Parameters:
      id - the ID of the user group to delete
      Throws:
      jakarta.persistence.EntityNotFoundException - if the user group to delete does not exist in the database
      RuntimeException - if the deletion was not performed as expected

    • modifyGroup

      public RestGroup modifyGroup(Long id, RestGroup restGroup) throws jakarta.persistence.EntityNotFoundException, IllegalArgumentException, GroupManager.NotModifiedException
      Update a user group by user group ID
      Parameters:
      id - the ID of the user group to update
      restGroup - a Json object containing the modified (and unmodified) attributes
      Returns:
      a response containing a Json object corresponding to the user group after modification
      Throws:
      jakarta.persistence.EntityNotFoundException - if no user group with the given user group ID exists
      IllegalArgumentException - if any of the input data was invalid
      GroupManager.NotModifiedException - if the group data was not modified (input data same as database data)

    • getGroupMembers

      public List<RestUser> getGroupMembers(Long id)
      Get all members of the given user group
      Parameters:
      id - the ID of the user group
      Returns:
      a list of Json objects representing the users, which are members of the given group
      Throws:
      jakarta.persistence.NoResultException - if the group has no members

    • addGroupMember

      public List<RestUser> addGroupMember(Long id, String username) throws jakarta.persistence.EntityNotFoundException, IllegalArgumentException, GroupManager.NotModifiedException
      Add a member to the given user group
      Parameters:
      id - the ID of the group to update
      username - the name of the user to add
      Returns:
      a Json object corresponding to the list of users after addition
      Throws:
      jakarta.persistence.EntityNotFoundException - if no user group with the given ID or no user with the given name exists
      IllegalArgumentException - if any of the input data was invalid
      GroupManager.NotModifiedException - if the user is already a member of the group

    • removeGroupMember

      public void removeGroupMember(Long id, String username) throws jakarta.persistence.EntityNotFoundException, RuntimeException, GroupManager.NotModifiedException
      Delete a member from the given user group
      Parameters:
      id - the group ID
      username - the name of the user to remove
      Throws:
      jakarta.persistence.EntityNotFoundException - if the group did not exist
      RuntimeException - if the deletion was unsuccessful
      GroupManager.NotModifiedException - if the user is not a member of the group

    • countGroups

      public String countGroups(String mission)
      Count the groups matching the specified mission
      Parameters:
      mission - the mission code
      Returns:
      the number of groups found as string