## Uses of Class
org.keycloak.models.utils.FormMessage

- Packages that use FormMessage
  Package | Description
  --- | ---
  org.keycloak.authentication |
  org.keycloak.forms.account |
  org.keycloak.forms.account.freemarker |
  org.keycloak.forms.login |
  org.keycloak.forms.login.freemarker |
  org.keycloak.services.validation |

- - ### Uses of FormMessage in org.keycloak.authentication

    Fields in org.keycloak.authentication declared as FormMessage
    Modifier and Type | Field and Description
    --- | ---
    `protected FormMessage` | ForkFlowException.`errorMessage`
    `protected FormMessage` | AuthenticationProcessor.`forwardedErrorMessage` This could be an error message forwarded from another authenticator
    `protected FormMessage` | AuthenticationProcessor.`forwardedSuccessMessage` This could be an success message forwarded from another authenticator
    `protected FormMessage` | ForkFlowException.`successMessage`

    Methods in org.keycloak.authentication that return FormMessage
    Modifier and Type | Method and Description
    --- | ---
    `FormMessage` | ForkFlowException.`getErrorMessage()`
    `FormMessage` | AuthenticationProcessor.Result.`getErrorMessage()`
    `FormMessage` | AbstractAuthenticationFlowContext.`getForwardedErrorMessage()` This could be an error message forwarded from another authenticator that is restarting or continuing the flo.
    `FormMessage` | AuthenticationProcessor.Result.`getForwardedErrorMessage()`
    `FormMessage` | AbstractAuthenticationFlowContext.`getForwardedSuccessMessage()` This could be an success message forwarded from another authenticator that is restarting or continuing the flow.
    `FormMessage` | AuthenticationProcessor.Result.`getForwardedSuccessMessage()`
    `FormMessage` | ForkFlowException.`getSuccessMessage()`
    `FormMessage` | AuthenticationProcessor.Result.`getSuccessMessage()`

    Methods in org.keycloak.authentication with parameters of type FormMessage
    Modifier and Type | Method and Description
    --- | ---
    `void` | AuthenticationFlowContext.`forkWithErrorMessage(FormMessage message)` Fork the current flow.
    `void` | AuthenticationProcessor.Result.`forkWithErrorMessage(FormMessage message)`
    `void` | AuthenticationFlowContext.`forkWithSuccessMessage(FormMessage message)` Fork the current flow.
    `void` | AuthenticationProcessor.Result.`forkWithSuccessMessage(FormMessage message)`
    `AuthenticationProcessor` | AuthenticationProcessor.`setForwardedErrorMessage(FormMessage forwardedErrorMessage)`
    `AuthenticationProcessor` | AuthenticationProcessor.`setForwardedSuccessMessage(FormMessage forwardedSuccessMessage)`

    Method parameters in org.keycloak.authentication with type arguments of type FormMessage
    Modifier and Type | Method and Description
    --- | ---
    `javax.ws.rs.core.Response` | FormAuthenticationFlow.`renderForm(javax.ws.rs.core.MultivaluedMap<String,String> formData, List<FormMessage> errors)`
    `void` | ValidationContext.`validationError(javax.ws.rs.core.MultivaluedMap<String,String> formData, List<FormMessage> errors)` Mark this validation as having a validation error

    Constructors in org.keycloak.authentication with parameters of type FormMessage
    Constructor and Description
    `ForkFlowException(FormMessage successMessage, FormMessage errorMessage)`

  - ### Uses of FormMessage in org.keycloak.forms.account

    Method parameters in org.keycloak.forms.account with type arguments of type FormMessage
    Modifier and Type | Method and Description
    --- | ---
    `AccountProvider` | AccountProvider.`setErrors(javax.ws.rs.core.Response.Status status, List<FormMessage> messages)`

  - ### Uses of FormMessage in org.keycloak.forms.account.freemarker

    Fields in org.keycloak.forms.account.freemarker with type parameters of type FormMessage
    Modifier and Type | Field and Description
    --- | ---
    `protected List<FormMessage>` | FreeMarkerAccountProvider.`messages`

    Methods in org.keycloak.forms.account.freemarker with parameters of type FormMessage
    Modifier and Type | Method and Description
    --- | ---
    `protected String` | FreeMarkerAccountProvider.`formatMessage(FormMessage message, Properties messagesBundle, Locale locale)`

    Method parameters in org.keycloak.forms.account.freemarker with type arguments of type FormMessage
    Modifier and Type | Method and Description
    --- | ---
    `AccountProvider` | FreeMarkerAccountProvider.`setErrors(javax.ws.rs.core.Response.Status status, List<FormMessage> messages)`

  - ### Uses of FormMessage in org.keycloak.forms.login

    Methods in org.keycloak.forms.login with parameters of type FormMessage
    Modifier and Type | Method and Description
    --- | ---
    `LoginFormsProvider` | LoginFormsProvider.`addError(FormMessage errorMessage)`
    `LoginFormsProvider` | LoginFormsProvider.`addSuccess(FormMessage errorMessage)` Add a success message to the form

    Method parameters in org.keycloak.forms.login with type arguments of type FormMessage
    Modifier and Type | Method and Description
    --- | ---
    `LoginFormsProvider` | LoginFormsProvider.`setErrors(List<FormMessage> messages)` Set multiple error messages.

  - ### Uses of FormMessage in org.keycloak.forms.login.freemarker

    Fields in org.keycloak.forms.login.freemarker with type parameters of type FormMessage
    Modifier and Type | Field and Description
    --- | ---
    `protected List<FormMessage>` | FreeMarkerLoginFormsProvider.`messages`

    Methods in org.keycloak.forms.login.freemarker with parameters of type FormMessage
    Modifier and Type | Method and Description
    --- | ---
    `LoginFormsProvider` | FreeMarkerLoginFormsProvider.`addError(FormMessage errorMessage)`
    `LoginFormsProvider` | FreeMarkerLoginFormsProvider.`addSuccess(FormMessage errorMessage)`
    `protected String` | FreeMarkerLoginFormsProvider.`formatMessage(FormMessage message, Properties messagesBundle, Locale locale)`

    Method parameters in org.keycloak.forms.login.freemarker with type arguments of type FormMessage
    Modifier and Type | Method and Description
    --- | ---
    `LoginFormsProvider` | FreeMarkerLoginFormsProvider.`setErrors(List<FormMessage> messages)`

  - ### Uses of FormMessage in org.keycloak.services.validation

    Methods in org.keycloak.services.validation that return types with arguments of type FormMessage
    Modifier and Type | Method and Description
    --- | ---
    `static List<FormMessage>` | Validation.`getFormErrorsFromValidation(UserProfileValidationResult results)`
    `static List<FormMessage>` | Validation.`validateRegistrationForm(KeycloakSession session, RealmModel realm, javax.ws.rs.core.MultivaluedMap<String,String> formData, List<String> requiredCredentialTypes, PasswordPolicy policy)`
    `static List<FormMessage>` | Validation.`validateUpdateProfileForm(RealmModel realm, javax.ws.rs.core.MultivaluedMap<String,String> formData)`
    `static List<FormMessage>` | Validation.`validateUpdateProfileForm(RealmModel realm, javax.ws.rs.core.MultivaluedMap<String,String> formData, boolean userNameRequired)`

Copyright © 2021 JBoss by Red Hat. All rights reserved.