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

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

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

公開メンバ関数
String	getHelpText ()
List< ProviderConfigProperty >	getConfigProperties ()
void	validate (ValidationContext context)
void	buildPage (FormContext context, LoginFormsProvider form)
void	success (FormContext context)
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 ()

静的公開変数類
static final String	PROVIDER_ID = "registration-user-creation"

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

詳解

著者

Bill Burke

バージョン

Revision

1

関数詳解

buildPage()

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

inline

                                                                        {

    }

close()

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

inline

                        {

    }

configuredFor()

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

inline

                                                                                            {
        return true;
    }

create()

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

inline

                                                      {
        return this;
    }

getConfigProperties()

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

inline

                                                              {
        return null;
    }

getDisplayType()

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

inline

                                   {
        return "Registration User Creation";
    }

getHelpText()

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

inline

                                {
        return "This action must always be first! Validates the username of the user in validation phase.  In success phase, this will create the user in the database.";
    }

getId()

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

inline

                          {
        return PROVIDER_ID;
    }

getReferenceCategory()

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

inline

                                         {
        return null;
    }

getRequirementChoices()

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

inline

                                                                              {
        return REQUIREMENT_CHOICES;
    }

init()

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

inline

                                          {

    }

isConfigurable()

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

inline

                                    {
        return false;
    }

isUserSetupAllowed()

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

inline

                                        {
        return false;
    }

postInit()

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

inline

                                                         {

    }

requiresUser()

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

inline

                                  {
        return false;
    }

setRequiredActions()

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

inline

                                                                                              {

    }

success()

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

inline

                                             {
        MultivaluedMap<String, String> formData = context.getHttpRequest().getDecodedFormParameters();
        String email = formData.getFirst(Validation.FIELD_EMAIL);
        String username = formData.getFirst(RegistrationPage.FIELD_USERNAME);
        if (context.getRealm().isRegistrationEmailAsUsername()) {
            username = formData.getFirst(RegistrationPage.FIELD_EMAIL);
        }
        context.getEvent().detail(Details.USERNAME, username)
                .detail(Details.REGISTER_METHOD, "form")
                .detail(Details.EMAIL, email)
        ;
        UserModel user = context.getSession().users().addUser(context.getRealm(), username);
        user.setEnabled(true);

        user.setEmail(email);
        context.getAuthenticationSession().setClientNote(OIDCLoginProtocol.LOGIN_HINT_PARAM, username);
        AttributeFormDataProcessor.process(formData, context.getRealm(), user);
        context.setUser(user);
        context.getEvent().user(user);
        context.getEvent().success();
        context.newEvent().event(EventType.LOGIN);
        context.getEvent().client(context.getAuthenticationSession().getClient().getClientId())
                .detail(Details.REDIRECT_URI, context.getAuthenticationSession().getRedirectUri())
                .detail(Details.AUTH_METHOD, context.getAuthenticationSession().getProtocol());
        String authType = context.getAuthenticationSession().getAuthNote(Details.AUTH_TYPE);
        if (authType != null) {
            context.getEvent().detail(Details.AUTH_TYPE, authType);
        }
    }

validate()

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

inline

                                                    {
        MultivaluedMap<String, String> formData = context.getHttpRequest().getDecodedFormParameters();
        List<FormMessage> errors = new ArrayList<>();
        context.getEvent().detail(Details.REGISTER_METHOD, "form");

        String email = formData.getFirst(Validation.FIELD_EMAIL);
        String username = formData.getFirst(RegistrationPage.FIELD_USERNAME);
        context.getEvent().detail(Details.USERNAME, username);
        context.getEvent().detail(Details.EMAIL, email);

        String usernameField = RegistrationPage.FIELD_USERNAME;
        if (context.getRealm().isRegistrationEmailAsUsername()) {
            context.getEvent().detail(Details.USERNAME, email);

            if (Validation.isBlank(email)) {
                errors.add(new FormMessage(RegistrationPage.FIELD_EMAIL, Messages.MISSING_EMAIL));
            } else if (!Validation.isEmailValid(email)) {
                errors.add(new FormMessage(RegistrationPage.FIELD_EMAIL, Messages.INVALID_EMAIL));
                formData.remove(Validation.FIELD_EMAIL);
            }
            if (errors.size() > 0) {
                context.error(Errors.INVALID_REGISTRATION);
                context.validationError(formData, errors);
                return;
            }
            if (email != null && !context.getRealm().isDuplicateEmailsAllowed() && context.getSession().users().getUserByEmail(email, context.getRealm()) != null) {
                context.error(Errors.EMAIL_IN_USE);
                formData.remove(Validation.FIELD_EMAIL);
                errors.add(new FormMessage(RegistrationPage.FIELD_EMAIL, Messages.EMAIL_EXISTS));
                context.validationError(formData, errors);
                return;
            }
        } else {
            if (Validation.isBlank(username)) {
                context.error(Errors.INVALID_REGISTRATION);
                errors.add(new FormMessage(RegistrationPage.FIELD_USERNAME, Messages.MISSING_USERNAME));
                context.validationError(formData, errors);
                return;
            }

            if (context.getSession().users().getUserByUsername(username, context.getRealm()) != null) {
                context.error(Errors.USERNAME_IN_USE);
                errors.add(new FormMessage(usernameField, Messages.USERNAME_EXISTS));
                formData.remove(Validation.FIELD_USERNAME);
                context.validationError(formData, errors);
                return;
            }

        }
        context.success();
    }

メンバ詳解

PROVIDER_ID

final String org.keycloak.authentication.forms.RegistrationUserCreation.PROVIDER_ID = "registration-user-creation"

static

REQUIREMENT_CHOICES

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

staticprivate

初期値:

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

---

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

• D:/AppData/doxygen/keycloak/rest-service/src/services/src/main/java/org/keycloak/authentication/forms/RegistrationUserCreation.java