org.keycloak.authentication.forms.RegistrationProfile クラス

org.keycloak.authentication.forms.RegistrationProfile の継承関係図

org.keycloak.authentication.forms.RegistrationProfile 連携図

公開メンバ関数
String	getHelpText ()
List< ProviderConfigProperty >	getConfigProperties ()
void	validate (ValidationContext context)
void	success (FormContext context)
void	buildPage (FormContext context, LoginFormsProvider form)
boolean	requiresUser ()
boolean	configuredFor (KeycloakSession session, RealmModel realm, UserModel user)
void	setRequiredActions (KeycloakSession session, RealmModel realm, UserModel user)
boolean	isUserSetupAllowed ()
void	close ()
String	getDisplayType ()
String	getReferenceCategory ()
boolean	isConfigurable ()
AuthenticationExecutionModel.Requirement []	getRequirementChoices ()
FormAction	create (KeycloakSession session)
void	init (Config.Scope config)
void	postInit (KeycloakSessionFactory factory)
String	getId ()
default int	order ()

静的公開変数類
static final String	PROVIDER_ID = "registration-profile-action"

静的非公開変数類
static AuthenticationExecutionModel.Requirement []	REQUIREMENT_CHOICES

詳解

著者

Bill Burke

バージョン

Revision

1

関数詳解

buildPage()

void org.keycloak.authentication.forms.RegistrationProfile.buildPage ( FormContext  context, LoginFormsProvider  form  )

inline

org.keycloak.authentication.FormActionを実装しています。

                                                                        {
        // complete
    }

close()

void org.keycloak.authentication.forms.RegistrationProfile.close ( )

inline

org.keycloak.provider.Providerを実装しています。

                        {

    }

configuredFor()

boolean org.keycloak.authentication.forms.RegistrationProfile.configuredFor ( KeycloakSession  session, RealmModel  realm, UserModel  user  )

inline

org.keycloak.authentication.FormActionを実装しています。

                                                                                            {
        return true;
    }

create()

FormAction org.keycloak.authentication.forms.RegistrationProfile.create ( KeycloakSession  session )

inline

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

                                                      {
        return this;
    }

getConfigProperties()

List<ProviderConfigProperty> org.keycloak.authentication.forms.RegistrationProfile.getConfigProperties ( )

inline

org.keycloak.provider.ConfiguredProviderを実装しています。

                                                              {
        return null;
    }

getDisplayType()

String org.keycloak.authentication.forms.RegistrationProfile.getDisplayType ( )

inline

org.keycloak.authentication.ConfigurableAuthenticatorFactoryを実装しています。

                                   {
        return "Profile Validation";
    }

getHelpText()

String org.keycloak.authentication.forms.RegistrationProfile.getHelpText ( )

inline

org.keycloak.provider.ConfiguredProviderを実装しています。

                                {
        return "Validates email, first name, and last name attributes and stores them in user data.";
    }

getId()

String org.keycloak.authentication.forms.RegistrationProfile.getId ( )

inline

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

                          {
        return PROVIDER_ID;
    }

getReferenceCategory()

String org.keycloak.authentication.forms.RegistrationProfile.getReferenceCategory ( )

inline

org.keycloak.authentication.ConfigurableAuthenticatorFactoryを実装しています。

                                         {
        return null;
    }

getRequirementChoices()

AuthenticationExecutionModel.Requirement [] org.keycloak.authentication.forms.RegistrationProfile.getRequirementChoices ( )

inline

org.keycloak.authentication.ConfigurableAuthenticatorFactoryを実装しています。

                                                                              {
        return REQUIREMENT_CHOICES;
    }

init()

void org.keycloak.authentication.forms.RegistrationProfile.init ( Config.Scope  config )

inline

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

                                          {

    }

isConfigurable()

boolean org.keycloak.authentication.forms.RegistrationProfile.isConfigurable ( )

inline

org.keycloak.authentication.ConfigurableAuthenticatorFactoryを実装しています。

                                    {
        return false;
    }

isUserSetupAllowed()

boolean org.keycloak.authentication.forms.RegistrationProfile.isUserSetupAllowed ( )

inline

org.keycloak.authentication.ConfigurableAuthenticatorFactoryを実装しています。

                                        {
        return false;
    }

order()

default int org.keycloak.provider.ProviderFactory< T extends Provider >.order ( )

inlineinherited

org.keycloak.protocol.docker.DockerAuthV2ProtocolFactory, org.keycloak.urls.HostnameProviderFactory, org.keycloak.protocol.oidc.ext.OIDCExtProviderFactoryで実装されています。

                        {
        return 0;
    }

postInit()

void org.keycloak.authentication.forms.RegistrationProfile.postInit ( KeycloakSessionFactory  factory )

inline

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

                                                         {

    }

requiresUser()

boolean org.keycloak.authentication.forms.RegistrationProfile.requiresUser ( )

inline

org.keycloak.authentication.FormActionを実装しています。

                                  {
        return false;
    }

setRequiredActions()

void org.keycloak.authentication.forms.RegistrationProfile.setRequiredActions ( KeycloakSession  session, RealmModel  realm, UserModel  user  )

inline

org.keycloak.authentication.FormActionを実装しています。

                                                                                              {

    }

success()

void org.keycloak.authentication.forms.RegistrationProfile.success ( FormContext  context )

inline

org.keycloak.authentication.FormActionを実装しています。

                                             {
        UserModel user = context.getUser();
        MultivaluedMap<String, String> formData = context.getHttpRequest().getDecodedFormParameters();
        user.setFirstName(formData.getFirst(RegistrationPage.FIELD_FIRST_NAME));
        user.setLastName(formData.getFirst(RegistrationPage.FIELD_LAST_NAME));
        user.setEmail(formData.getFirst(RegistrationPage.FIELD_EMAIL));
    }

validate()

void org.keycloak.authentication.forms.RegistrationProfile.validate ( ValidationContext  context )

inline

org.keycloak.authentication.FormActionを実装しています。

                                                    {
        MultivaluedMap<String, String> formData = context.getHttpRequest().getDecodedFormParameters();
        List<FormMessage> errors = new ArrayList<>();

        context.getEvent().detail(Details.REGISTER_METHOD, "form");
        String eventError = Errors.INVALID_REGISTRATION;

        if (Validation.isBlank(formData.getFirst((RegistrationPage.FIELD_FIRST_NAME)))) {
            errors.add(new FormMessage(RegistrationPage.FIELD_FIRST_NAME, Messages.MISSING_FIRST_NAME));
        }

        if (Validation.isBlank(formData.getFirst((RegistrationPage.FIELD_LAST_NAME)))) {
            errors.add(new FormMessage(RegistrationPage.FIELD_LAST_NAME, Messages.MISSING_LAST_NAME));
        }

        String email = formData.getFirst(Validation.FIELD_EMAIL);
        boolean emailValid = true;
        if (Validation.isBlank(email)) {
            errors.add(new FormMessage(RegistrationPage.FIELD_EMAIL, Messages.MISSING_EMAIL));
            emailValid = false;
        } else if (!Validation.isEmailValid(email)) {
            context.getEvent().detail(Details.EMAIL, email);
            errors.add(new FormMessage(RegistrationPage.FIELD_EMAIL, Messages.INVALID_EMAIL));
            emailValid = false;
        }

        if (emailValid && !context.getRealm().isDuplicateEmailsAllowed() && context.getSession().users().getUserByEmail(email, context.getRealm()) != null) {
            eventError = Errors.EMAIL_IN_USE;
            formData.remove(Validation.FIELD_EMAIL);
            context.getEvent().detail(Details.EMAIL, email);
            errors.add(new FormMessage(RegistrationPage.FIELD_EMAIL, Messages.EMAIL_EXISTS));
        }

        if (errors.size() > 0) {
            context.error(eventError);
            context.validationError(formData, errors);
            return;

        } else {
            context.success();
        }
    }

メンバ詳解

PROVIDER_ID

final String org.keycloak.authentication.forms.RegistrationProfile.PROVIDER_ID = "registration-profile-action"

static

REQUIREMENT_CHOICES

AuthenticationExecutionModel.Requirement [] org.keycloak.authentication.forms.RegistrationProfile.REQUIREMENT_CHOICES

staticprivate

初期値:

= {
            AuthenticationExecutionModel.Requirement.REQUIRED,
            AuthenticationExecutionModel.Requirement.DISABLED
    }

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/authentication/forms/RegistrationProfile.java