Package org.keycloak.storage.federated
Interface UserGroupMembershipFederatedStorage
- All Known Subinterfaces:
UserFederatedStorageProvider
,UserFederatedStorageProvider.Streams
,UserGroupMembershipFederatedStorage.Streams
- All Known Implementing Classes:
JpaUserFederatedStorageProvider
public interface UserGroupMembershipFederatedStorage
- Version:
- $Revision: 1 $
- Author:
- Bill Burke
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
Deprecated.This interface is no longer necessary; collection-based methods were removed from the parent interface and therefore the parent interface can be used directly -
Method Summary
Modifier and TypeMethodDescriptiongetGroupsStream
(RealmModel realm, String userId) Obtains the groups associated with the federated user.getMembershipStream
(RealmModel realm, GroupModel group, Integer firstResult, Integer max) Obtains the federated users that are members of the givengroup
in the specifiedrealm
.void
joinGroup
(RealmModel realm, String userId, GroupModel group) void
leaveGroup
(RealmModel realm, String userId, GroupModel group)
-
Method Details
-
getGroupsStream
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
-
leaveGroup
-
getMembershipStream
Stream<String> getMembershipStream(RealmModel realm, GroupModel group, Integer firstResult, Integer max) Obtains the federated users that are members of the givengroup
in the specifiedrealm
.- 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 ornull
.max
- maximum number of results to return. Ignored if negative ornull
.- Returns:
- a non-null
Stream
of federated user ids that are members of the group in the realm.
-