Package cz.metacentrum.perun.core.bl

Interface SearcherBl

All Known Implementing Classes:
SearcherBlImpl
public interface SearcherBl
Searcher Class for searching objects by Map of Attributes
Author:
Michal Stava <stavamichal@gmail.com>

  • Method Details

    • getFacilities

      List<Facility> getFacilities(PerunSession sess, Map<String,String> attributesWithSearchingValues) throws AttributeNotExistsException, WrongAttributeAssignmentException
      This method get Map of Attributes with searching values and try to find all facilities, which have specific attributes in format. Better information about format below. When there are more than 1 attribute in Map, it means all must be true "looking for all of them" (AND)
      Parameters:
      sess - perun session
      attributesWithSearchingValues - map of attributes names when attribute is type String, so value is string and we are looking for total match (Partial is not supported now, will be supported later by symbol *) when attribute is type Integer, so value is integer in String and we are looking for total match when attribute is type List, so value is String and we are looking for at least one total or partial matching element when attribute is type Map so value is String in format "key=value" and we are looking total match of both or if is it "key" so we are looking for total match of key IMPORTANT: In map there is not allowed char '=' in key. First char '=' is delimiter in MAP item key=value!!!
      Returns:
      list of facilities that have attributes with specific values (behaviour above) if no such facility exists, returns empty list
      Throws:
      InternalErrorException - internal error
      AttributeNotExistsException - when specified attribute does not exist
      WrongAttributeAssignmentException - wrong attribute assignment

    • getGroups

      List<Group> getGroups(PerunSession sess, Vo vo, Map<String,String> attributesWithSearchingValues) throws AttributeNotExistsException
      Filter output from getGroups by vo_id.
      Throws:
      AttributeNotExistsException
      See Also:

    • getGroups

      List<Group> getGroups(PerunSession sess, Map<String,String> attributesWithSearchingValues) throws AttributeNotExistsException
      This method get Map of Attributes with searching values and try to find all groups, which have specific attributes in format. Better information about format below. When there are more than 1 attribute in Map, it means all must be true "looking for all of them" (AND)

      IMPORTANT: can't get CORE ATTRIBUTES, it will skip any core attribute in map without information about it

      Parameters:
      sess - perun session
      attributesWithSearchingValues - map of attributes names when attribute is type String, so value is string and we are looking for total match (Partial is not supported now, will be supported later by symbol *) when attribute is type Integer, so value is integer in String and we are looking for total match when attribute is type List, so value is String and we are looking for at least one total or partial matching element when attribute is type Map so value is String in format "key=value" and we are looking total match of both or if is it "key" so we are looking for total match of key IMPORTANT: In map there is not allowed char '=' in key. First char '=' is delimiter in MAP item key=value!!!
      Returns:
      list of groups who have attributes with specific values (behavior above) if no group exist, return empty list of groups if empty map, return all groups
      Throws:
      AttributeNotExistsException

    • getGroupsByGroupResourceSetting

      List<Group> getGroupsByGroupResourceSetting(PerunSession sess, Attribute groupResourceAttribute, Attribute resourceAttribute)
      Return all groups assigned to any resource with following conditions: 1] resource has set "resourceAttribute" attribute with same value 2] group and resource has set "groupResourceAttribute" attribute with same value Attribute values can't be empty. If there is no such group, return empty array.
      Parameters:
      sess -
      groupResourceAttribute - expected attribute set between a group and a resource (group need to be assigned to the resource)
      resourceAttribute - expected attribute set for assigned resource
      Returns:
      list of groups with following conditions
      Throws:
      InternalErrorException - if any of attributes is null or has empty value, if any of attributes is not in expected namespace

    • getGroupsIdsForAppAutoRejection

      List<Integer> getGroupsIdsForAppAutoRejection()
      Gets groups ids for potential application auto rejection.
      Returns:
      groups ids

    • getMembersByExpiration

      List<Member> getMembersByExpiration(PerunSession sess, String operator, int days)
      Return members with expiration date set, which will expire on today +/- X days. You can specify operator for comparison (by default "=") returning exact match. So you can get all expired members (including today) using "<=" and zero days shift. or using "<" and +1 day shift.

      Method ignores current member state, just compares expiration date !

      Parameters:
      sess - PerunSession
      operator - One of "=", "<", ">", "<=", ">=". If null, "=" is anticipated.
      days - X days before/after today
      Returns:
      Members with expiration relative to method params.
      Throws:
      InternalErrorException

    • getMembersByExpiration

      List<Member> getMembersByExpiration(PerunSession sess, String operator, LocalDate date)
      Return members with expiration date set, which will expire on specified date. You can specify operator for comparison (by default "=") returning exact match. So you can get all expired members (including today) using "<=" and today date. or using "<" and tomorrow date.

      Method ignores current member state, just compares expiration date !

      Parameters:
      sess - PerunSession
      operator - One of "=", "<", ">", "<=", ">=". If null, "=" is anticipated.
      date - Date to compare expiration with (if null, current date is used).
      Returns:
      Members with expiration relative to method params.
      Throws:
      InternalErrorException

    • getMembersByGroupExpiration

      List<Member> getMembersByGroupExpiration(PerunSession sess, Group group, String operator, LocalDate date)
      Return members with group expiration date set, which will expire on specified date in given group. You can specify operator for comparison (by default "=") returning exact match. So you can get all expired members (including today) using "<=" and today date. or using "<" and tomorrow date.

      Method returns members with its expiration status for given group. Method ignores current member state, just compares expiration date!

      Method returns also indirect members of group with expiration set (by accident probably), but we manage status only for direct members !!

      Parameters:
      sess - Perun session
      operator - One of "=", "<", ">", "<=", ">=". If null, "=" is anticipated.
      date - Date to compare expiration with (if null, current date is used).
      Returns:
      Members with expiration relative to method params.
      Throws:
      InternalErrorException - internal error

    • getResources

      List<Resource> getResources(PerunSession sess, Map<String,String> attributesWithSearchingValues, boolean allowPartialMatchForString) throws AttributeNotExistsException, WrongAttributeAssignmentException
      This method get Map of Attributes with searching values and try to find all resources, which have specific attributes in format. Better information about format below. When there are more than 1 attribute in Map, it means all must be true "looking for all of them" (AND)
      Parameters:
      sess - perun session
      attributesWithSearchingValues - map of attributes names when attribute is type String, so value is string and we are looking for exact or partial match based by parameter 'allowPartialMatchForString' when attribute is type Integer, so value is integer in String and we are looking for total match when attribute is type List, so value is String and we are looking for at least one total or partial matching element when attribute is type Map so value is String in format "key=value" and we are looking total match of both or if is it "key" so we are looking for total match of key IMPORTANT: In map there is not allowed char '=' in key. First char '=' is delimiter in MAP item key=value!!!
      allowPartialMatchForString - if true, we are looking for partial match, if false, we are looking only for exact match (only for STRING type attributes)
      Returns:
      list of resources that have attributes with specific values (behaviour above) if no such resource exists, returns empty list
      Throws:
      InternalErrorException - internal error
      AttributeNotExistsException - when specified attribute does not exist
      WrongAttributeAssignmentException - wrong attribute assignment

    • getUsers

      List<User> getUsers(PerunSession sess, Map<String,String> attributesWithSearchingValues) throws AttributeNotExistsException, WrongAttributeAssignmentException
      This method get Map of Attributes with searching values and try to find all users, which have specific attributes in format. Better information about format below. When there are more than 1 attribute in Map, it means all must be true "looking for all of them" (AND)
      Parameters:
      sess - perun session
      attributesWithSearchingValues - map of attributes names when attribute is type String, so value is string and we are looking for total match (Partial is not supported now, will be supported later by symbol *) when attribute is type Integer, so value is integer in String and we are looking for total match when attribute is type List, so value is String and we are looking for at least one total or partial matching element when attribute is type Map so value is String in format "key=value" and we are looking total match of both or if is it "key" so we are looking for total match of key IMPORTANT: In map there is not allowed char '=' in key. First char '=' is delimiter in MAP item key=value!!!
      Returns:
      list of users who have attributes with specific values (behavior above) if no user exist, return empty list of users
      Throws:
      AttributeNotExistsException
      InternalErrorException
      WrongAttributeAssignmentException

    • getUsersForCoreAttributes

      List<User> getUsersForCoreAttributes(PerunSession sess, Map<String,String> coreAttributesWithSearchingValues) throws AttributeNotExistsException, WrongAttributeAssignmentException
      This method take map of coreAttributes with search values and return all users who have the specific match for all of these core attributes.
      Parameters:
      sess -
      coreAttributesWithSearchingValues -
      Returns:
      Throws:
      InternalErrorException
      AttributeNotExistsException
      WrongAttributeAssignmentException

    • getVosIdsForAppAutoRejection

      List<Integer> getVosIdsForAppAutoRejection()
      Gets VOs ids for potential application auto rejection.
      Returns:
      VOs ids