Package edu.internet2.middleware.grouper.userData

Class GrouperUserDataApi

java.lang.Object
edu.internet2.middleware.grouper.userData.GrouperUserDataApi
public class GrouperUserDataApi extends Object
api for grouper user data

  • Field Details

    • MAX_USER_DATA_OBJECTS

      public static final int MAX_USER_DATA_OBJECTS
      this is the max user data objects in json to fit in a 4k field
      See Also:

  • Constructor Details

    • GrouperUserDataApi

      public GrouperUserDataApi()

  • Method Details

    • main

      public static void main(String[] args)
      Parameters:
      args -

    • favoriteGroupAdd

      public static void favoriteGroupAdd(String userDataGroupName, Subject subjectToAddTo, Group group)
      Parameters:
      subjectToAddTo -
      userDataGroupName -
      group -

    • favoriteGroupRemove

      public static void favoriteGroupRemove(String userDataGroupName, Subject subjectToAddTo, Group group)
      Parameters:
      subjectToAddTo -
      userDataGroupName -
      group -

    • favoriteGroups

      public static Set<Group> favoriteGroups(String userDataGroupName, Subject subject)
      Parameters:
      subject -
      userDataGroupName -
      Returns:
      the favorite groups for a user

    • recentlyUsedGroupAdd

      public static void recentlyUsedGroupAdd(String userDataGroupName, Subject subjectToAddTo, Group group)
      Parameters:
      subjectToAddTo -
      userDataGroupName -
      group -

    • recentlyUsedGroups

      public static Set<Group> recentlyUsedGroups(String userDataGroupName, Subject subject)
      Parameters:
      subject -
      userDataGroupName -
      Returns:
      the recently used groups for a user

    • recentlyUsedGroupRemove

      public static void recentlyUsedGroupRemove(String userDataGroupName, Subject subjectToAddTo, Group group)
      Parameters:
      subjectToAddTo -
      userDataGroupName -
      group -

    • favoriteAttributeDefAdd

      public static void favoriteAttributeDefAdd(String userDataGroupName, Subject subjectToAddTo, AttributeDef attributeDef)
      Parameters:
      subjectToAddTo -
      userDataGroupName -
      attributeDef -

    • favoriteAttributeDefRemove

      public static void favoriteAttributeDefRemove(String userDataGroupName, Subject subjectToAddTo, AttributeDef attributeDef)
      Parameters:
      subjectToAddTo -
      userDataGroupName -
      attributeDef -

    • favoriteAttributeDefs

      public static Set<AttributeDef> favoriteAttributeDefs(String userDataGroupName, Subject subject)
      Parameters:
      subject -
      userDataGroupName -
      Returns:
      the favorite attributeDefs for a user

    • favoriteAttributeDefNameAdd

      public static void favoriteAttributeDefNameAdd(String userDataGroupName, Subject subjectToAddTo, AttributeDefName attributeDefName)
      Parameters:
      subjectToAddTo -
      userDataGroupName -
      attributeDefName -

    • favoriteAttributeDefNameRemove

      public static void favoriteAttributeDefNameRemove(String userDataGroupName, Subject subjectToAddTo, AttributeDefName attributeDefName)
      Parameters:
      subjectToAddTo -
      userDataGroupName -
      attributeDefName -

    • favoriteAttributeDefNames

      public static Set<AttributeDefName> favoriteAttributeDefNames(String userDataGroupName, Subject subject)
      Parameters:
      subject -
      userDataGroupName -
      Returns:
      the favorite attributeDefNames for a user

    • favoriteStemAdd

      public static void favoriteStemAdd(String userDataGroupName, Subject subjectToAddTo, Stem stem)
      Parameters:
      subjectToAddTo -
      userDataGroupName -
      stem -

    • preferencesAssign

      public static void preferencesAssign(String userDataGroupName, Subject subjectToAddTo, Object preferences)
      Parameters:
      subjectToAddTo -
      userDataGroupName -
      preferences -

    • preferences

      public static <T> T preferences(String userDataGroupName, Subject subjectToAddTo, Class<T> preferencesClass)
      Parameters:
      subjectToAddTo -
      userDataGroupName -
      preferences -

    • favoriteStemRemove

      public static void favoriteStemRemove(String userDataGroupName, Subject subjectToAddTo, Stem stem)
      Parameters:
      subjectToAddTo -
      userDataGroupName -
      stem -

    • favoriteStems

      public static Set<Stem> favoriteStems(String userDataGroupName, Subject subject)
      Parameters:
      subject -
      userDataGroupName -
      Returns:
      the favorite stems for a user

    • favoriteMemberRemove

      public static void favoriteMemberRemove(String userDataGroupName, Subject subjectToRemoveFrom, Subject subjectThatIsFavorite)
      Parameters:
      subjectToRemoveFrom -
      userDataGroupName -
      subjectThatIsFavorite -

    • favoriteMemberAdd

      public static void favoriteMemberAdd(String userDataGroupName, Subject subjectToAddTo, Subject subjectThatIsFavorite)
      Parameters:
      subjectToAddTo -
      userDataGroupName -
      subjectThatIsFavorite -

    • recentlyUsedMemberAdd

      public static void recentlyUsedMemberAdd(String userDataGroupName, Subject subjectToAddTo, Subject subjectThatIsRecentlyUsed)
      Parameters:
      subjectToAddTo -
      userDataGroupName -
      subjectThatIsRecentlyUsed -

    • favoriteMemberAdd

      public static void favoriteMemberAdd(String userDataGroupName, Subject subjectToAddTo, Member member)
      Parameters:
      subjectToAddTo -
      userDataGroupName -
      member -

    • favoriteMemberRemove

      public static void favoriteMemberRemove(String userDataGroupName, Subject subjectToAddTo, Member member)
      Parameters:
      subjectToAddTo -
      userDataGroupName -
      member -

    • favoriteMembers

      public static Set<Member> favoriteMembers(String userDataGroupName, Subject subject)
      Parameters:
      subject -
      userDataGroupName -
      Returns:
      the favorite members for a user

    • recentlyUsedStemAdd

      public static void recentlyUsedStemAdd(String userDataGroupName, Subject subjectToAddTo, Stem stem)
      Parameters:
      subjectToAddTo -
      userDataGroupName -
      stem -

    • recentlyUsedStemRemove

      public static void recentlyUsedStemRemove(String userDataGroupName, Subject subjectToAddTo, Stem stem)
      Parameters:
      subjectToAddTo -
      userDataGroupName -
      stem -

    • recentlyUsedStems

      public static Set<Stem> recentlyUsedStems(String userDataGroupName, Subject subject)
      Parameters:
      subject -
      userDataGroupName -
      Returns:
      the recently used stems for a user

    • recentlyUsedAttributeDefAdd

      public static void recentlyUsedAttributeDefAdd(String userDataGroupName, Subject subjectToAddTo, AttributeDef attributeDef)
      Parameters:
      subjectToAddTo -
      userDataGroupName -
      attributeDef -

    • recentlyUsedAttributeDefRemove

      public static void recentlyUsedAttributeDefRemove(String userDataGroupName, Subject subjectToAddTo, AttributeDef attributeDef)
      Parameters:
      subjectToAddTo -
      userDataGroupName -
      attributeDef -

    • recentlyUsedAttributeDefs

      public static Set<AttributeDef> recentlyUsedAttributeDefs(String userDataGroupName, Subject subject)
      Parameters:
      subject -
      userDataGroupName -
      Returns:
      the favorite attributeDefs for a user

    • recentlyUsedAttributeDefNameAdd

      public static void recentlyUsedAttributeDefNameAdd(String userDataGroupName, Subject subjectToAddTo, AttributeDefName attributeDefName)
      Parameters:
      subjectToAddTo -
      userDataGroupName -
      attributeDefName -

    • recentlyUsedAttributeDefNameRemove

      public static void recentlyUsedAttributeDefNameRemove(String userDataGroupName, Subject subjectToAddTo, AttributeDefName attributeDefName)
      Parameters:
      subjectToAddTo -
      userDataGroupName -
      attributeDefName -

    • recentlyUsedAttributeDefNames

      public static Set<AttributeDefName> recentlyUsedAttributeDefNames(String userDataGroupName, Subject subject)
      Parameters:
      subject -
      userDataGroupName -
      Returns:
      the recent attributeDefNames for a user

    • recentlyUsedMemberAdd

      public static void recentlyUsedMemberAdd(String userDataGroupName, Subject subjectToAddTo, Member member)
      Parameters:
      subjectToAddTo -
      userDataGroupName -
      member -

    • recentlyUsedMemberRemove

      public static void recentlyUsedMemberRemove(String userDataGroupName, Subject subjectToAddTo, Member member)
      Parameters:
      subjectToAddTo -
      userDataGroupName -
      member -

    • recentlyUsedMembers

      public static Set<Member> recentlyUsedMembers(String userDataGroupName, Subject subject)
      Parameters:
      subject -
      userDataGroupName -
      Returns:
      the favorite members for a user

    • recentlyUsedMemberRemove

      public static void recentlyUsedMemberRemove(String userDataGroupName, Subject subjectToRemoveFrom, Subject subjectThatIsRecentlyUsed)
      Parameters:
      subjectToRemoveFrom -
      userDataGroupName -
      subjectThatIsRecentlyUsed -

    • visualizationPrefs

      public static <T> T visualizationPrefs(String userDataGroupName, Subject subjectToAddTo, Class<T> preferencesClass)
      retrieve visualization preferences from attribute assignment on user membership
      Parameters:
      userDataGroupName -
      subjectToAddTo -
      preferencesClass - class to cast to, likely grouper-ui class UiV2VisualizationPreference
      Returns:

    • visualizationPrefsAssign

      public static void visualizationPrefsAssign(String userDataGroupName, Subject subjectToAddTo, Object preferences)
      Parameters:
      subjectToAddTo -
      userDataGroupName -
      preferences -