Class HttpBasicAuthenticator

  • All Implemented Interfaces:
    org.keycloak.authentication.Authenticator, org.keycloak.provider.Provider
    Direct Known Subclasses:
    DockerAuthenticator

    public class HttpBasicAuthenticator
    extends Object
    implements org.keycloak.authentication.Authenticator
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void action​(org.keycloak.authentication.AuthenticationFlowContext context)  
      void authenticate​(org.keycloak.authentication.AuthenticationFlowContext context)  
      void close()  
      boolean configuredFor​(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user)  
      protected void notValidCredentialsAction​(org.keycloak.authentication.AuthenticationFlowContext context, org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user)  
      protected void nullUserAction​(org.keycloak.authentication.AuthenticationFlowContext context, org.keycloak.models.RealmModel realm, String user)  
      boolean requiresUser()  
      void setRequiredActions​(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user)  
      protected void userDisabledAction​(org.keycloak.authentication.AuthenticationFlowContext context, org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user, String eventError)  
      protected void userSuccessAction​(org.keycloak.authentication.AuthenticationFlowContext context, org.keycloak.models.UserModel user)  
      • Methods inherited from interface org.keycloak.authentication.Authenticator

        areRequiredActionsEnabled, getRequiredActions
    • Constructor Detail

      • HttpBasicAuthenticator

        public HttpBasicAuthenticator()
    • Method Detail

      • authenticate

        public void authenticate​(org.keycloak.authentication.AuthenticationFlowContext context)
        Specified by:
        authenticate in interface org.keycloak.authentication.Authenticator
      • userSuccessAction

        protected void userSuccessAction​(org.keycloak.authentication.AuthenticationFlowContext context,
                                         org.keycloak.models.UserModel user)
      • userDisabledAction

        protected void userDisabledAction​(org.keycloak.authentication.AuthenticationFlowContext context,
                                          org.keycloak.models.RealmModel realm,
                                          org.keycloak.models.UserModel user,
                                          String eventError)
      • nullUserAction

        protected void nullUserAction​(org.keycloak.authentication.AuthenticationFlowContext context,
                                      org.keycloak.models.RealmModel realm,
                                      String user)
      • notValidCredentialsAction

        protected void notValidCredentialsAction​(org.keycloak.authentication.AuthenticationFlowContext context,
                                                 org.keycloak.models.RealmModel realm,
                                                 org.keycloak.models.UserModel user)
      • action

        public void action​(org.keycloak.authentication.AuthenticationFlowContext context)
        Specified by:
        action in interface org.keycloak.authentication.Authenticator
      • requiresUser

        public boolean requiresUser()
        Specified by:
        requiresUser in interface org.keycloak.authentication.Authenticator
      • configuredFor

        public boolean configuredFor​(org.keycloak.models.KeycloakSession session,
                                     org.keycloak.models.RealmModel realm,
                                     org.keycloak.models.UserModel user)
        Specified by:
        configuredFor in interface org.keycloak.authentication.Authenticator
      • setRequiredActions

        public void setRequiredActions​(org.keycloak.models.KeycloakSession session,
                                       org.keycloak.models.RealmModel realm,
                                       org.keycloak.models.UserModel user)
        Specified by:
        setRequiredActions in interface org.keycloak.authentication.Authenticator
      • close

        public void close()
        Specified by:
        close in interface org.keycloak.provider.Provider