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
Nested Classes Modifier and Type Interface Description static interface
UserGroupMembershipFederatedStorage.Streams
TheUserGroupMembershipFederatedStorage.Streams
interface makes all collection-based methods inUserGroupMembershipFederatedStorage
default by providing implementations that delegate to theStream
-based variants instead of the other way around.
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description Set<GroupModel>
getGroups(RealmModel realm, String userId)
Deprecated.UsegetGroupsStream
instead.default Stream<GroupModel>
getGroupsStream(RealmModel realm, String userId)
Obtains the groups associated with the federated user.List<String>
getMembership(RealmModel realm, GroupModel group, int firstResult, int max)
Deprecated.UsegetMembershipStream
instead.default Stream<String>
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 Detail
-
getGroups
@Deprecated Set<GroupModel> getGroups(RealmModel realm, String userId)
Deprecated.UsegetGroupsStream
instead.
-
getGroupsStream
default 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)
-
getMembership
@Deprecated List<String> getMembership(RealmModel realm, GroupModel group, int firstResult, int max)
Deprecated.UsegetMembershipStream
instead.
-
getMembershipStream
default 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.
-
-