org.keycloak.storage.federated

Interface UserGroupMembershipFederatedStorage

All Known Subinterfaces:

UserFederatedStorageProvider, UserFederatedStorageProvider.Streams, UserGroupMembershipFederatedStorage.Streams

public interface UserGroupMembershipFederatedStorage

Version:

$Revision: 1 $

Author:

Bill Burke

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	UserGroupMembershipFederatedStorage.Streams The UserGroupMembershipFederatedStorage.Streams interface makes all collection-based methods in UserGroupMembershipFederatedStorage default by providing implementations that delegate to the Stream-based variants instead of the other way around.

Method Summary

Modifier and Type	Method and Description
Set<GroupModel>	getGroups(RealmModel realm, String userId) Deprecated. Use getGroupsStream 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. Use getMembershipStream instead.
default 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.
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. Use getGroupsStream 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. Use getMembershipStream instead.

getMembershipStream

default 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.