Class UsernameForm
- java.lang.Object
-
- org.keycloak.authentication.AbstractFormAuthenticator
-
- org.keycloak.authentication.authenticators.browser.AbstractUsernameFormAuthenticator
-
- org.keycloak.authentication.authenticators.browser.UsernamePasswordForm
-
- org.keycloak.authentication.authenticators.browser.UsernameForm
-
- All Implemented Interfaces:
Authenticator
,Provider
public final class UsernameForm extends UsernamePasswordForm
-
-
Field Summary
-
Fields inherited from class org.keycloak.authentication.authenticators.browser.UsernamePasswordForm
log
-
Fields inherited from class org.keycloak.authentication.authenticators.browser.AbstractUsernameFormAuthenticator
ATTEMPTED_USERNAME, REGISTRATION_FORM_ACTION, USER_SET_BEFORE_USERNAME_PASSWORD_AUTH
-
-
Constructor Summary
Constructors Constructor Description UsernameForm()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
authenticate(AuthenticationFlowContext context)
Initial call for the authenticator.protected javax.ws.rs.core.Response
challenge(AuthenticationFlowContext context, javax.ws.rs.core.MultivaluedMap<String,String> formData)
protected javax.ws.rs.core.Response
createLoginForm(LoginFormsProvider form)
protected String
getDefaultChallengeMessage(AuthenticationFlowContext context)
protected boolean
validateForm(AuthenticationFlowContext context, javax.ws.rs.core.MultivaluedMap<String,String> formData)
-
Methods inherited from class org.keycloak.authentication.authenticators.browser.UsernamePasswordForm
action, close, configuredFor, requiresUser, setRequiredActions
-
Methods inherited from class org.keycloak.authentication.authenticators.browser.AbstractUsernameFormAuthenticator
challenge, challenge, disabledByBruteForceError, disabledByBruteForceFieldError, dummyHash, enabledUser, isDisabledByBruteForce, isUserAlreadySetBeforeUsernamePasswordAuth, runDefaultDummyHash, setDuplicateUserChallenge, testInvalidUser, validatePassword, validateUser, validateUserAndPassword
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.keycloak.authentication.Authenticator
areRequiredActionsEnabled, getRequiredActions
-
-
-
-
Method Detail
-
authenticate
public void authenticate(AuthenticationFlowContext context)
Description copied from interface:Authenticator
Initial call for the authenticator. This method should check the current HTTP request to determine if the request satifies the Authenticator's requirements. If it doesn't, it should send back a challenge response by calling the AuthenticationFlowContext.challenge(Response). If this challenge is a authentication, the action URL of the form must point to /realms/{realm}/login-actions/authenticate?code={session-code}&execution={executionId} or /realms/{realm}/login-actions/registration?code={session-code}&execution={executionId} {session-code} pertains to the code generated from AuthenticationFlowContext.generateAccessCode(). The {executionId} pertains to the AuthenticationExecutionModel.getId() value obtained from AuthenticationFlowContext.getExecution(). The action URL will invoke the action() method described below.- Specified by:
authenticate
in interfaceAuthenticator
- Overrides:
authenticate
in classUsernamePasswordForm
-
validateForm
protected boolean validateForm(AuthenticationFlowContext context, javax.ws.rs.core.MultivaluedMap<String,String> formData)
- Overrides:
validateForm
in classUsernamePasswordForm
-
challenge
protected javax.ws.rs.core.Response challenge(AuthenticationFlowContext context, javax.ws.rs.core.MultivaluedMap<String,String> formData)
- Overrides:
challenge
in classUsernamePasswordForm
-
createLoginForm
protected javax.ws.rs.core.Response createLoginForm(LoginFormsProvider form)
- Overrides:
createLoginForm
in classAbstractUsernameFormAuthenticator
-
getDefaultChallengeMessage
protected String getDefaultChallengeMessage(AuthenticationFlowContext context)
- Overrides:
getDefaultChallengeMessage
in classAbstractUsernameFormAuthenticator
-
-