org.keycloak.storage.federated

Interface UserBrokerLinkFederatedStorage

All Known Subinterfaces:

UserBrokerLinkFederatedStorage.Streams, UserFederatedStorageProvider, UserFederatedStorageProvider.Streams

All Known Implementing Classes:

JpaUserFederatedStorageProvider

public interface UserBrokerLinkFederatedStorage

Version:

$Revision: 1 $

Author:

Bill Burke

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	UserBrokerLinkFederatedStorage.Streams The UserBrokerLinkFederatedStorage.Streams interface makes all collection-based methods in UserBrokerLinkFederatedStorage 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
void	addFederatedIdentity(RealmModel realm, String userId, FederatedIdentityModel socialLink)
Set<FederatedIdentityModel>	getFederatedIdentities(String userId, RealmModel realm) Deprecated. Use getFederatedIdentitiesStream instead.
default Stream<FederatedIdentityModel>	getFederatedIdentitiesStream(String userId, RealmModel realm) Obtains the identities of the federated user identified by userId.
FederatedIdentityModel	getFederatedIdentity(String userId, String socialProvider, RealmModel realm)
String	getUserByFederatedIdentity(FederatedIdentityModel socialLink, RealmModel realm)
void	preRemove(RealmModel realm, IdentityProviderModel provider)
boolean	removeFederatedIdentity(RealmModel realm, String userId, String socialProvider)
void	updateFederatedIdentity(RealmModel realm, String userId, FederatedIdentityModel federatedIdentityModel)

Method Detail

getUserByFederatedIdentity

String getUserByFederatedIdentity(FederatedIdentityModel socialLink,
                                  RealmModel realm)

addFederatedIdentity

void addFederatedIdentity(RealmModel realm,
                          String userId,
                          FederatedIdentityModel socialLink)

removeFederatedIdentity

boolean removeFederatedIdentity(RealmModel realm,
                                String userId,
                                String socialProvider)

preRemove

void preRemove(RealmModel realm,
               IdentityProviderModel provider)

updateFederatedIdentity

void updateFederatedIdentity(RealmModel realm,
                             String userId,
                             FederatedIdentityModel federatedIdentityModel)

getFederatedIdentities

@Deprecated
Set<FederatedIdentityModel> getFederatedIdentities(String userId,
                                                               RealmModel realm)

Deprecated. Use getFederatedIdentitiesStream instead.

getFederatedIdentitiesStream

default Stream<FederatedIdentityModel> getFederatedIdentitiesStream(String userId,
                                                                    RealmModel realm)

Obtains the identities of the federated user identified by userId.

Parameters:

userId - the user identifier.

realm - a reference to the realm.

Returns:

a non-null Stream of federated identities associated with the user.

getFederatedIdentity

FederatedIdentityModel getFederatedIdentity(String userId,
                                            String socialProvider,
                                            RealmModel realm)