org.keycloak.storage.federated

Interface UserRequiredActionsFederatedStorage.Streams

All Superinterfaces:

UserRequiredActionsFederatedStorage

All Known Subinterfaces:

UserFederatedStorageProvider.Streams

All Known Implementing Classes:

JpaUserFederatedStorageProvider

Enclosing interface:

UserRequiredActionsFederatedStorage

public static interface UserRequiredActionsFederatedStorage.Streams
extends UserRequiredActionsFederatedStorage

The UserRequiredActionsFederatedStorage.Streams interface makes all collection-based methods in UserRequiredActionsFederatedStorage 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.UserRequiredActionsFederatedStorage

UserRequiredActionsFederatedStorage.Streams

Method Summary

Modifier and Type	Method and Description
default Set<String>	getRequiredActions(RealmModel realm, String userId)
Stream<String>	getRequiredActionsStream(RealmModel realm, String userId) Obtains the names of required actions associated with the federated user identified by userId.

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

addRequiredAction, removeRequiredAction

Method Detail

getRequiredActions

default Set<String> getRequiredActions(RealmModel realm,
                                       String userId)

Specified by:

getRequiredActions in interface UserRequiredActionsFederatedStorage

getRequiredActionsStream

Stream<String> getRequiredActionsStream(RealmModel realm,
                                        String userId)

Description copied from interface: UserRequiredActionsFederatedStorage

Obtains the names of required actions associated with the federated user identified by userId.

Specified by:

getRequiredActionsStream in interface UserRequiredActionsFederatedStorage

Parameters:

realm - a reference to the realm.

userId - the user identifier.

Returns:

a non-null Stream of required action names.