Package org.keycloak.storage.federated
Interface UserFederatedStorageProvider.Streams
-
- All Superinterfaces:
Provider
,UserAttributeFederatedStorage
,UserAttributeFederatedStorage.Streams
,UserBrokerLinkFederatedStorage
,UserBrokerLinkFederatedStorage.Streams
,UserConsentFederatedStorage
,UserConsentFederatedStorage.Streams
,UserFederatedStorageProvider
,UserFederatedUserCredentialStore
,UserFederatedUserCredentialStore.Streams
,UserGroupMembershipFederatedStorage
,UserGroupMembershipFederatedStorage.Streams
,UserNotBeforeFederatedStorage
,UserRequiredActionsFederatedStorage
,UserRequiredActionsFederatedStorage.Streams
,UserRoleMappingsFederatedStorage
,UserRoleMappingsFederatedStorage.Streams
- All Known Implementing Classes:
JpaUserFederatedStorageProvider
- Enclosing interface:
- UserFederatedStorageProvider
public static interface UserFederatedStorageProvider.Streams extends UserFederatedStorageProvider, UserAttributeFederatedStorage.Streams, UserBrokerLinkFederatedStorage.Streams, UserConsentFederatedStorage.Streams, UserFederatedUserCredentialStore.Streams, UserGroupMembershipFederatedStorage.Streams, UserRequiredActionsFederatedStorage.Streams, UserRoleMappingsFederatedStorage.Streams
TheUserFederatedStorageProvider.Streams
interface makes all collection-based methods inUserFederatedStorageProvider
default by providing implementations that delegate to theStream
-based variants instead of the other way around. It allows for implementations to focus on theStream
-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
-
Nested classes/interfaces inherited from interface org.keycloak.storage.federated.UserBrokerLinkFederatedStorage
UserBrokerLinkFederatedStorage.Streams
-
Nested classes/interfaces inherited from interface org.keycloak.storage.federated.UserConsentFederatedStorage
UserConsentFederatedStorage.Streams
-
Nested classes/interfaces inherited from interface org.keycloak.storage.federated.UserFederatedStorageProvider
UserFederatedStorageProvider.Streams
-
Nested classes/interfaces inherited from interface org.keycloak.storage.federated.UserFederatedUserCredentialStore
UserFederatedUserCredentialStore.Streams
-
Nested classes/interfaces inherited from interface org.keycloak.storage.federated.UserGroupMembershipFederatedStorage
UserGroupMembershipFederatedStorage.Streams
-
Nested classes/interfaces inherited from interface org.keycloak.storage.federated.UserRequiredActionsFederatedStorage
UserRequiredActionsFederatedStorage.Streams
-
Nested classes/interfaces inherited from interface org.keycloak.storage.federated.UserRoleMappingsFederatedStorage
UserRoleMappingsFederatedStorage.Streams
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default List<String>
getStoredUsers(RealmModel realm, int first, int max)
Stream<String>
getStoredUsersStream(RealmModel realm, Integer first, Integer max)
Obtains the ids of all federated users in the realm.-
Methods inherited from interface org.keycloak.storage.federated.UserAttributeFederatedStorage
getAttributes, removeAttribute, setAttribute, setSingleAttribute
-
Methods inherited from interface org.keycloak.storage.federated.UserAttributeFederatedStorage.Streams
getUsersByUserAttribute, getUsersByUserAttributeStream
-
Methods inherited from interface org.keycloak.storage.federated.UserBrokerLinkFederatedStorage
addFederatedIdentity, getFederatedIdentity, getUserByFederatedIdentity, preRemove, removeFederatedIdentity, updateFederatedIdentity
-
Methods inherited from interface org.keycloak.storage.federated.UserBrokerLinkFederatedStorage.Streams
getFederatedIdentities, getFederatedIdentitiesStream
-
Methods inherited from interface org.keycloak.storage.federated.UserConsentFederatedStorage
addConsent, getConsentByClient, revokeConsentForClient, updateConsent
-
Methods inherited from interface org.keycloak.storage.federated.UserConsentFederatedStorage.Streams
getConsents, getConsentsStream
-
Methods inherited from interface org.keycloak.storage.federated.UserFederatedStorageProvider
getStoredUsersCount, preRemove, preRemove, preRemove, preRemove, preRemove, preRemove, preRemove, preRemove
-
Methods inherited from interface org.keycloak.storage.federated.UserFederatedUserCredentialStore
createCredential, getStoredCredentialById, getStoredCredentialByNameAndType, removeStoredCredential, updateCredential
-
Methods inherited from interface org.keycloak.storage.federated.UserFederatedUserCredentialStore.Streams
getStoredCredentials, getStoredCredentialsByType, getStoredCredentialsByTypeStream, getStoredCredentialsStream
-
Methods inherited from interface org.keycloak.storage.federated.UserGroupMembershipFederatedStorage
joinGroup, leaveGroup
-
Methods inherited from interface org.keycloak.storage.federated.UserGroupMembershipFederatedStorage.Streams
getGroups, getGroupsStream, getMembership, getMembershipStream
-
Methods inherited from interface org.keycloak.storage.federated.UserNotBeforeFederatedStorage
getNotBeforeOfUser, setNotBeforeForUser
-
Methods inherited from interface org.keycloak.storage.federated.UserRequiredActionsFederatedStorage
addRequiredAction, removeRequiredAction
-
Methods inherited from interface org.keycloak.storage.federated.UserRequiredActionsFederatedStorage.Streams
getRequiredActions, getRequiredActionsStream
-
Methods inherited from interface org.keycloak.storage.federated.UserRoleMappingsFederatedStorage
deleteRoleMapping, grantRole
-
Methods inherited from interface org.keycloak.storage.federated.UserRoleMappingsFederatedStorage.Streams
getRoleMappings, getRoleMappingsStream
-
-
-
-
Method Detail
-
getStoredUsers
default List<String> getStoredUsers(RealmModel realm, int first, int max)
- Specified by:
getStoredUsers
in interfaceUserFederatedStorageProvider
-
getStoredUsersStream
Stream<String> getStoredUsersStream(RealmModel realm, Integer first, Integer max)
Description copied from interface:UserFederatedStorageProvider
Obtains the ids of all federated users in the realm.- Specified by:
getStoredUsersStream
in interfaceUserFederatedStorageProvider
- Parameters:
realm
- a reference to the realm.first
- 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.
-
-