## Uses of Interface
org.keycloak.forms.login.LoginFormsProvider

- Packages that use LoginFormsProvider
  Package | Description
  --- | ---
  org.keycloak.authentication |
  org.keycloak.authentication.authenticators.broker |
  org.keycloak.authentication.forms |
  org.keycloak.forms.login |
  org.keycloak.forms.login.freemarker |

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

    Methods in org.keycloak.authentication that return LoginFormsProvider
    Modifier and Type | Method and Description
    --- | ---
    `LoginFormsProvider` | RequiredActionContextResult.`form()`
    `LoginFormsProvider` | AuthenticationProcessor.Result.`form()`
    `LoginFormsProvider` | RequiredActionContext.`form()` Create a Freemarker form builder that presets the user, action URI, and a generated access code
    `LoginFormsProvider` | AuthenticationFlowContext.`form()` Create a Freemarker form builder that presets the user, action URI, and a generated access code

    Methods in org.keycloak.authentication with parameters of type LoginFormsProvider
    Modifier and Type | Method and Description
    --- | ---
    `void` | FormAction.`buildPage(FormContext context, LoginFormsProvider form)` When a FormAuthenticator is rendering the challenge page, even FormAction.buildPage() method will be called This gives the FormAction the opportunity to add additional attributes to the form to be displayed.
    `javax.ws.rs.core.Response` | FormAuthenticator.`render(FormContext context, LoginFormsProvider form)` Called to render the FormAuthenticator's challenge page.

  - ### Uses of LoginFormsProvider in org.keycloak.authentication.authenticators.broker

    Methods in org.keycloak.authentication.authenticators.broker that return LoginFormsProvider
    Modifier and Type | Method and Description
    --- | ---
    `protected LoginFormsProvider` | IdpUsernamePasswordForm.`setupForm(AuthenticationFlowContext context, javax.ws.rs.core.MultivaluedMap<String,String> formData, UserModel existingUser)`

  - ### Uses of LoginFormsProvider in org.keycloak.authentication.forms

    Methods in org.keycloak.authentication.forms with parameters of type LoginFormsProvider
    Modifier and Type | Method and Description
    --- | ---
    `void` | RegistrationUserCreation.`buildPage(FormContext context, LoginFormsProvider form)`
    `void` | RegistrationRecaptcha.`buildPage(FormContext context, LoginFormsProvider form)`
    `void` | RegistrationProfile.`buildPage(FormContext context, LoginFormsProvider form)`
    `void` | RegistrationPassword.`buildPage(FormContext context, LoginFormsProvider form)`
    `javax.ws.rs.core.Response` | RegistrationPage.`render(FormContext context, LoginFormsProvider form)`

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

    Methods in org.keycloak.forms.login that return LoginFormsProvider
    Modifier and Type | Method and Description
    --- | ---
    `LoginFormsProvider` | LoginFormsProvider.`addError(FormMessage errorMessage)`
    `LoginFormsProvider` | LoginFormsProvider.`addSuccess(FormMessage errorMessage)` Add a success message to the form
    `LoginFormsProvider` | LoginFormsProvider.`setAccessRequest(List<RoleModel> realmRolesRequested, javax.ws.rs.core.MultivaluedMap<String,RoleModel> resourceRolesRequested, List<ProtocolMapperModel> protocolMappers)`
    `LoginFormsProvider` | LoginFormsProvider.`setAccessRequest(String message)`
    `LoginFormsProvider` | LoginFormsProvider.`setActionUri(URI requestUri)`
    `LoginFormsProvider` | LoginFormsProvider.`setAttribute(String name, Object value)`
    `LoginFormsProvider` | LoginFormsProvider.`setClientSession(ClientSessionModel clientSession)`
    `LoginFormsProvider` | LoginFormsProvider.`setClientSessionCode(String accessCode)`
    `LoginFormsProvider` | LoginFormsProvider.`setError(String message, Object... parameters)` Set one global error message.
    `LoginFormsProvider` | LoginFormsProvider.`setErrors(List<FormMessage> messages)` Set multiple error messages.
    `LoginFormsProvider` | LoginFormsProvider.`setFormData(javax.ws.rs.core.MultivaluedMap<String,String> formData)`
    `LoginFormsProvider` | LoginFormsProvider.`setInfo(String message, Object... parameters)`
    `LoginFormsProvider` | LoginFormsProvider.`setResponseHeader(String headerName, String headerValue)`
    `LoginFormsProvider` | LoginFormsProvider.`setStatus(javax.ws.rs.core.Response.Status status)`
    `LoginFormsProvider` | LoginFormsProvider.`setSuccess(String message, Object... parameters)`
    `LoginFormsProvider` | LoginFormsProvider.`setUser(UserModel user)`

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

    Classes in org.keycloak.forms.login.freemarker that implement LoginFormsProvider
    Modifier and Type | Class and Description
    --- | ---
    `class` | `FreeMarkerLoginFormsProvider`

    Methods in org.keycloak.forms.login.freemarker that return LoginFormsProvider
    Modifier and Type | Method and Description
    --- | ---
    `LoginFormsProvider` | FreeMarkerLoginFormsProvider.`addError(FormMessage errorMessage)`
    `LoginFormsProvider` | FreeMarkerLoginFormsProvider.`addSuccess(FormMessage errorMessage)`
    `LoginFormsProvider` | FreeMarkerLoginFormsProviderFactory.`create(KeycloakSession session)`
    `LoginFormsProvider` | FreeMarkerLoginFormsProvider.`setAccessRequest(List<RoleModel> realmRolesRequested, javax.ws.rs.core.MultivaluedMap<String,RoleModel> resourceRolesRequested, List<ProtocolMapperModel> protocolMappersRequested)`
    `LoginFormsProvider` | FreeMarkerLoginFormsProvider.`setAccessRequest(String accessRequestMessage)`
    `LoginFormsProvider` | FreeMarkerLoginFormsProvider.`setActionUri(URI actionUri)`
    `LoginFormsProvider` | FreeMarkerLoginFormsProvider.`setAttribute(String name, Object value)`
    `LoginFormsProvider` | FreeMarkerLoginFormsProvider.`setClientSession(ClientSessionModel clientSession)`
    `LoginFormsProvider` | FreeMarkerLoginFormsProvider.`setClientSessionCode(String accessCode)`
    `LoginFormsProvider` | FreeMarkerLoginFormsProvider.`setErrors(List<FormMessage> messages)`
    `LoginFormsProvider` | FreeMarkerLoginFormsProvider.`setResponseHeader(String headerName, String headerValue)`
    `LoginFormsProvider` | FreeMarkerLoginFormsProvider.`setStatus(javax.ws.rs.core.Response.Status status)`

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