Package org.keycloak.storage.federated

Interface UserAttributeFederatedStorage

All Known Subinterfaces:

UserAttributeFederatedStorage.Streams, UserFederatedStorageProvider, UserFederatedStorageProvider.Streams

public interface UserAttributeFederatedStorage

Version:

$Revision: 1 $

Author:

Bill Burke

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	UserAttributeFederatedStorage.Streams	Deprecated. This interface is no longer necessary; collection-based methods were removed from the parent interface and therefore the parent interface can be used directly

Method Summary

Modifier and Type	Method	Description
org.keycloak.common.util.MultivaluedHashMap<String,String>	getAttributes(RealmModel realm, String userId)
Stream<String>	getUsersByUserAttributeStream(RealmModel realm, String name, String value)	Searches for federated users that have an attribute with the specified name and value.
void	removeAttribute(RealmModel realm, String userId, String name)
void	setAttribute(RealmModel realm, String userId, String name, List<String> values)
void	setSingleAttribute(RealmModel realm, String userId, String name, String value)

Method Details

setSingleAttribute

void setSingleAttribute(RealmModel realm,
 String userId,
 String name,
 String value)

setAttribute

void setAttribute(RealmModel realm,
 String userId,
 String name,
 List<String> values)

removeAttribute

void removeAttribute(RealmModel realm,
 String userId,
 String name)

getAttributes

org.keycloak.common.util.MultivaluedHashMap<String,String> getAttributes(RealmModel realm,
 String userId)

getUsersByUserAttributeStream

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

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

Parameters:

realm - a reference to the realm.

name - the attribute name.

value - the attribute value.

Returns:

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