org.keycloak.storage.federated

Interface UserAttributeFederatedStorage.Streams

All Superinterfaces:

UserAttributeFederatedStorage

All Known Subinterfaces:

UserFederatedStorageProvider.Streams

All Known Implementing Classes:

JpaUserFederatedStorageProvider

Enclosing interface:

UserAttributeFederatedStorage

public static interface UserAttributeFederatedStorage.Streams
extends UserAttributeFederatedStorage

The UserAttributeFederatedStorage.Streams interface makes all collection-based methods in UserAttributeFederatedStorage default by providing implementations that delegate to the Stream-based variants instead of the other way around.

It allows for implementations to focus on the Stream-based approach for processing sets of data and benefit from the potential memory and performance optimizations of that approach.

Nested Class Summary

Nested classes/interfaces inherited from interface org.keycloak.storage.federated.UserAttributeFederatedStorage

UserAttributeFederatedStorage.Streams

Method Summary

Modifier and Type	Method and Description
default List<String>	getUsersByUserAttribute(RealmModel realm, String name, String value)
Stream<String>	getUsersByUserAttributeStream(RealmModel realm, String name, String value) Searches for federated users that have an attribute with the specified name and value.

Methods inherited from interface org.keycloak.storage.federated.UserAttributeFederatedStorage

getAttributes, removeAttribute, setAttribute, setSingleAttribute

Method Detail

getUsersByUserAttribute

default List<String> getUsersByUserAttribute(RealmModel realm,
                                             String name,
                                             String value)

Specified by:

getUsersByUserAttribute in interface UserAttributeFederatedStorage

getUsersByUserAttributeStream

Stream<String> getUsersByUserAttributeStream(RealmModel realm,
                                             String name,
                                             String value)

Description copied from interface: UserAttributeFederatedStorage

Searches for federated users that have an attribute with the specified name and value.

Specified by:

getUsersByUserAttributeStream in interface UserAttributeFederatedStorage

Parameters:

realm - a reference to the realm.

name - the attribute name.

value - the attribute value.

Returns:

a non-null Stream of users that match the search criteria.