Interface UserGroupMembershipFederatedStorage

All Known Subinterfaces:
UserFederatedStorageProvider, UserFederatedStorageProvider.Streams, UserGroupMembershipFederatedStorage.Streams
All Known Implementing Classes:
JpaUserFederatedStorageProvider

public interface UserGroupMembershipFederatedStorage
Version:
$Revision: 1 $
Author:
Bill Burke
  • Method Details

    • getGroupsStream

      Stream<GroupModel> getGroupsStream(RealmModel realm, String userId)
      Obtains the groups associated with the federated user.
      Parameters:
      realm - a reference to the realm.
      userId - the user identifier.
      Returns:
      a non-null Stream of groups.
    • joinGroup

      void joinGroup(RealmModel realm, String userId, GroupModel group)
    • leaveGroup

      void leaveGroup(RealmModel realm, String userId, GroupModel group)
    • getMembershipStream

      Stream<String> getMembershipStream(RealmModel realm, GroupModel group, Integer firstResult, Integer max)
      Obtains the federated users that are members of the given group in the specified realm.
      Parameters:
      realm - a reference to the realm.
      group - a reference to the group whose federated members are being searched.
      firstResult - first result to return. Ignored if negative or null.
      max - maximum number of results to return. Ignored if negative or null.
      Returns:
      a non-null Stream of federated user ids that are members of the group in the realm.