org.keycloak.services.validation.Validation クラス

org.keycloak.services.validation.Validation 連携図

静的公開メンバ関数
static List< FormMessage >	validateRegistrationForm (KeycloakSession session, RealmModel realm, MultivaluedMap< String, String > formData, List< String > requiredCredentialTypes, PasswordPolicy policy)
static List< FormMessage >	validateUpdateProfileForm (RealmModel realm, MultivaluedMap< String, String > formData)
static boolean	validateUserMandatoryFields (RealmModel realm, UpdateProfileContext user)
static boolean	isEmpty (String s)
static boolean	isBlank (String s)
static boolean	isEmailValid (String email)

静的公開変数類
static final String	FIELD_PASSWORD_CONFIRM = "password-confirm"
static final String	FIELD_EMAIL = "email"
static final String	FIELD_LAST_NAME = "lastName"
static final String	FIELD_FIRST_NAME = "firstName"
static final String	FIELD_PASSWORD = "password"
static final String	FIELD_USERNAME = "username"

静的非公開メンバ関数
static void	addError (List< FormMessage > errors, String field, String message)

静的非公開変数類
static final Pattern	EMAIL_PATTERN = Pattern.compile("[a-zA-Z0-9!#$%&'*+/=?^_`{|}~.-]+@[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]+)*")

詳解

関数詳解

addError()

static void org.keycloak.services.validation.Validation.addError ( List< FormMessage >  errors, String  field, String  message  )

inlinestaticprivate

                                                                                        {
        errors.add(new FormMessage(field, message));
    }

isBlank()

static boolean org.keycloak.services.validation.Validation.isBlank ( String  s )

inlinestatic

Check if string is blank (null or lenght is 0 or contains only white characters)

引数

s

to check

戻り値

true if string is blank

                                            {
        return s == null || s.trim().length() == 0;
    }

isEmailValid()

static boolean org.keycloak.services.validation.Validation.isEmailValid ( String  email )

inlinestatic

                                                     {
        return EMAIL_PATTERN.matcher(email).matches();
    }

isEmpty()

static boolean org.keycloak.services.validation.Validation.isEmpty ( String  s )

inlinestatic

Check if string is empty (null or lenght is 0)

引数

s

to check

戻り値

true if string is empty

                                            {
        return s == null || s.length() == 0;
    }

validateRegistrationForm()

static List<FormMessage> org.keycloak.services.validation.Validation.validateRegistrationForm ( KeycloakSession  session, RealmModel  realm, MultivaluedMap< String, String >  formData, List< String >  requiredCredentialTypes, PasswordPolicy  policy  )

inlinestatic

                                                                                                                                                                                                              {
        List<FormMessage> errors = new ArrayList<>();

        if (!realm.isRegistrationEmailAsUsername() && isBlank(formData.getFirst(FIELD_USERNAME))) {
            addError(errors, FIELD_USERNAME, Messages.MISSING_USERNAME);
        }

        if (isBlank(formData.getFirst(FIELD_FIRST_NAME))) {
            addError(errors, FIELD_FIRST_NAME, Messages.MISSING_FIRST_NAME);
        }

        if (isBlank(formData.getFirst(FIELD_LAST_NAME))) {
            addError(errors, FIELD_LAST_NAME, Messages.MISSING_LAST_NAME);
        }

        if (isBlank(formData.getFirst(FIELD_EMAIL))) {
            addError(errors, FIELD_EMAIL, Messages.MISSING_EMAIL);
        } else if (!isEmailValid(formData.getFirst(FIELD_EMAIL))) {
            addError(errors, FIELD_EMAIL, Messages.INVALID_EMAIL);
        }

        if (requiredCredentialTypes.contains(CredentialRepresentation.PASSWORD)) {
            if (isBlank(formData.getFirst(FIELD_PASSWORD))) {
                addError(errors, FIELD_PASSWORD, Messages.MISSING_PASSWORD);
            } else if (!formData.getFirst(FIELD_PASSWORD).equals(formData.getFirst(FIELD_PASSWORD_CONFIRM))) {
                addError(errors, FIELD_PASSWORD_CONFIRM, Messages.INVALID_PASSWORD_CONFIRM);
            }
        }

        if (formData.getFirst(FIELD_PASSWORD) != null) {
            PolicyError err = session.getProvider(PasswordPolicyManagerProvider.class).validate(realm.isRegistrationEmailAsUsername() ? formData.getFirst(FIELD_EMAIL) : formData.getFirst(FIELD_USERNAME), formData.getFirst(FIELD_PASSWORD));
            if (err != null)
                errors.add(new FormMessage(FIELD_PASSWORD, err.getMessage(), err.getParameters()));
        }
        
        return errors;
    }

validateUpdateProfileForm()

static List<FormMessage> org.keycloak.services.validation.Validation.validateUpdateProfileForm ( RealmModel  realm, MultivaluedMap< String, String >  formData  )

inlinestatic

                                                                                                                         {
        List<FormMessage> errors = new ArrayList<>();
        
        if (!realm.isRegistrationEmailAsUsername() && realm.isEditUsernameAllowed() && isBlank(formData.getFirst(FIELD_USERNAME))) {
            addError(errors, FIELD_USERNAME, Messages.MISSING_USERNAME);
        }

        if (isBlank(formData.getFirst(FIELD_FIRST_NAME))) {
            addError(errors, FIELD_FIRST_NAME, Messages.MISSING_FIRST_NAME);
        }

        if (isBlank(formData.getFirst(FIELD_LAST_NAME))) {
            addError(errors, FIELD_LAST_NAME, Messages.MISSING_LAST_NAME);
        }

        if (isBlank(formData.getFirst(FIELD_EMAIL))) {
            addError(errors, FIELD_EMAIL, Messages.MISSING_EMAIL);
        } else if (!isEmailValid(formData.getFirst(FIELD_EMAIL))) {
            addError(errors, FIELD_EMAIL, Messages.INVALID_EMAIL);
        }

        return errors;
    }

validateUserMandatoryFields()

static boolean org.keycloak.services.validation.Validation.validateUserMandatoryFields ( RealmModel  realm, UpdateProfileContext  user  )

inlinestatic

Validate if user object contains all mandatory fields.

引数

realm	user is for
user	to validate

戻り値

true if user object contains all mandatory values, false if some mandatory value is missing

                                                                                                  {
        return!(isBlank(user.getFirstName()) || isBlank(user.getLastName()) || isBlank(user.getEmail()));        
    }

メンバ詳解

EMAIL_PATTERN

final Pattern org.keycloak.services.validation.Validation.EMAIL_PATTERN = Pattern.compile("[a-zA-Z0-9!#$%&'*+/=?^_`{|}~.-]+@[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]+)*")

staticprivate

FIELD_EMAIL

final String org.keycloak.services.validation.Validation.FIELD_EMAIL = "email"

static

FIELD_FIRST_NAME

final String org.keycloak.services.validation.Validation.FIELD_FIRST_NAME = "firstName"

static

FIELD_LAST_NAME

final String org.keycloak.services.validation.Validation.FIELD_LAST_NAME = "lastName"

static

FIELD_PASSWORD

final String org.keycloak.services.validation.Validation.FIELD_PASSWORD = "password"

static

FIELD_PASSWORD_CONFIRM

final String org.keycloak.services.validation.Validation.FIELD_PASSWORD_CONFIRM = "password-confirm"

static

FIELD_USERNAME

final String org.keycloak.services.validation.Validation.FIELD_USERNAME = "username"

static

---

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

• D:/AppData/doxygen/keycloak/rest-service/src/services/src/main/java/org/keycloak/services/validation/Validation.java