Package org.keycloak.authentication.requiredactions.util

Interface UpdateProfileContext

All Known Implementing Classes:

SerializedBrokeredIdentityContext, UserUpdateProfileContext

public interface UpdateProfileContext

Abstraction, which allows to display updateProfile page in various contexts (Required action of already existing user, or first identity provider login when user doesn't yet exists in Keycloak DB)

Author:

Marek Posolda

Method Summary

Modifier and Type	Method	Description
default List<String>	getAttribute(String key)	Deprecated. Use getAttributeStream instead.
Map<String,List<String>>	getAttributes()
Stream<String>	getAttributeStream(String name)	Obtains all values associated with the specified attribute name.
String	getEmail()
String	getFirstAttribute(String name)
String	getFirstName()
String	getLastName()
String	getUsername()
UserProfileContext	getUserProfileContext()
boolean	isEditEmailAllowed()
boolean	isEditUsernameAllowed()
void	setAttribute(String key, List<String> value)
void	setEmail(String email)
void	setFirstName(String firstName)
void	setLastName(String lastName)
void	setSingleAttribute(String name, String value)
void	setUsername(String username)

Method Detail

getUserProfileContext

UserProfileContext getUserProfileContext()

isEditUsernameAllowed

boolean isEditUsernameAllowed()

getUsername

String getUsername()

setUsername

void setUsername(String username)

isEditEmailAllowed

boolean isEditEmailAllowed()

getEmail

String getEmail()

setEmail

void setEmail(String email)

getFirstName

String getFirstName()

setFirstName

void setFirstName(String firstName)

getLastName

String getLastName()

setLastName

void setLastName(String lastName)

getAttributes

Map<String,List<String>> getAttributes()

setSingleAttribute

void setSingleAttribute(String name,
                        String value)

setAttribute

void setAttribute(String key,
                  List<String> value)

getFirstAttribute

String getFirstAttribute(String name)

getAttribute

@Deprecated
default List<String> getAttribute(String key)

Deprecated.

Use getAttributeStream instead.

getAttributeStream

Stream<String> getAttributeStream(String name)

Obtains all values associated with the specified attribute name.

Parameters:

name - the name of the attribute.

Returns:

a non-null Stream of attribute values.