Package org.keycloak.adapters.tomcat

Class KeycloakAuthenticatorValve

  • All Implemented Interfaces:
    MBeanRegistration, org.apache.catalina.Authenticator, org.apache.catalina.Contained, org.apache.catalina.Lifecycle, org.apache.catalina.LifecycleListener, org.apache.catalina.Valve
    public class KeycloakAuthenticatorValve
extends AbstractKeycloakAuthenticatorValve
    Keycloak authentication valve
    Version:
    $Revision: 1 $
    Author:
    Bill Burke

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface org.apache.catalina.Lifecycle

        org.apache.catalina.Lifecycle.SingleUse

    • Field Summary

      • Fields inherited from class org.apache.catalina.authenticator.FormAuthenticator

        characterEncoding, info, landingPage

      • Fields inherited from class org.apache.catalina.authenticator.AuthenticatorBase

        alwaysUseSession, AUTH_HEADER_NAME, cache, changeSessionIdOnAuthentication, context, disableProxyCaching, REALM_NAME, securePagesWithPragma, secureRandomAlgorithm, secureRandomClass, secureRandomProvider, sessionIdGenerator, sm, sso

      • Fields inherited from class org.apache.catalina.valves.ValveBase

        asyncSupported, container, containerLog, next

      • Fields inherited from class org.apache.catalina.util.LifecycleMBeanBase

        mserver

      • Fields inherited from interface org.apache.catalina.Lifecycle

        AFTER_DESTROY_EVENT, AFTER_INIT_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_DESTROY_EVENT, BEFORE_INIT_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, CONFIGURE_START_EVENT, CONFIGURE_STOP_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean authenticate​(org.apache.catalina.connector.Request request, javax.servlet.http.HttpServletResponse response, org.apache.catalina.deploy.LoginConfig config)  
      protected AbstractAuthenticatedActionsValve createAuthenticatedActionsValve​(AdapterDeploymentContext deploymentContext, org.apache.catalina.Valve next, org.apache.catalina.Container container)  
      protected GenericPrincipalFactory createPrincipalFactory()  
      protected boolean forwardToErrorPageInternal​(org.apache.catalina.connector.Request request, javax.servlet.http.HttpServletResponse response, Object loginConfig)  
      protected void initInternal()  
      void logout​(org.apache.catalina.connector.Request request)  

      • Methods inherited from class org.apache.catalina.authenticator.FormAuthenticator

        forwardToErrorPage, forwardToLoginPage, getAuthMethod, getCharacterEncoding, getInfo, getLandingPage, matchRequest, restoreRequest, savedRequestURL, saveRequest, setCharacterEncoding, setLandingPage

      • Methods inherited from class org.apache.catalina.authenticator.AuthenticatorBase

        associate, authenticate, checkForCachedAuthentication, doLogin, getAlwaysUseSession, getCache, getChangeSessionIdOnAuthentication, getContainer, getDisableProxyCaching, getRequestCertificates, getSecurePagesWithPragma, getSecureRandomAlgorithm, getSecureRandomClass, getSecureRandomProvider, login, reauthenticateFromSSO, register, setAlwaysUseSession, setCache, setChangeSessionIdOnAuthentication, setContainer, setDisableProxyCaching, setSecurePagesWithPragma, setSecureRandomAlgorithm, setSecureRandomClass, setSecureRandomProvider, startInternal, stopInternal

      • Methods inherited from class org.apache.catalina.valves.ValveBase

        backgroundProcess, event, getDomainInternal, getNext, getObjectNameKeyProperties, isAsyncSupported, setAsyncSupported, setNext, toString

      • Methods inherited from class org.apache.catalina.util.LifecycleMBeanBase

        destroyInternal, getDomain, getObjectName, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregister

      • Methods inherited from class org.apache.catalina.util.LifecycleBase

        addLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, init, removeLifecycleListener, setState, setState, start, stop

    • Constructor Detail

      • KeycloakAuthenticatorValve

        public KeycloakAuthenticatorValve()

    • Method Detail

      • authenticate

        public boolean authenticate​(org.apache.catalina.connector.Request request,
                            javax.servlet.http.HttpServletResponse response,
                            org.apache.catalina.deploy.LoginConfig config)
                     throws IOException
        Specified by:
        authenticate in interface org.apache.catalina.Authenticator
        Overrides:
        authenticate in class org.apache.catalina.authenticator.FormAuthenticator
        Throws:
        IOException

      • initInternal

        protected void initInternal()
        Overrides:
        initInternal in class org.apache.catalina.valves.ValveBase

      • logout

        public void logout​(org.apache.catalina.connector.Request request)
            throws javax.servlet.ServletException
        Specified by:
        logout in interface org.apache.catalina.Authenticator
        Overrides:
        logout in class org.apache.catalina.authenticator.AuthenticatorBase
        Throws:
        javax.servlet.ServletException