org.keycloak.services.DefaultKeycloakSessionFactory クラス

org.keycloak.services.DefaultKeycloakSessionFactory の継承関係図

org.keycloak.services.DefaultKeycloakSessionFactory 連携図

公開メンバ関数
void	register (ProviderEventListener listener)
void	unregister (ProviderEventListener listener)
void	publish (ProviderEvent event)
void	init ()
void	deploy (ProviderManager pm)
void	undeploy (ProviderManager pm)
KeycloakSession	create ()
Set< Spi >	getSpis ()
Spi	getSpi (Class<? extends Provider > providerClass)
List< ProviderFactory >	getProviderFactories (Class<? extends Provider > clazz)
void	close ()
long	getServerStartupTimestamp ()

限定公開メンバ関数
Map< Class<? extends Provider >, Map< String, ProviderFactory > >	getFactoriesCopy ()
void	checkProvider ()
Map< Class<? extends Provider >, Map< String, ProviderFactory > >	loadFactories (ProviderManager pm)
void	loadSPIs (ProviderManager pm, List< Spi > spiList)

限定公開変数類
CopyOnWriteArrayList< ProviderEventListener >	listeners = new CopyOnWriteArrayList<>()
long	serverStartupTimestamp

関数
< T extends Provider > String	getDefaultProvider (Class< T > clazz)
public< T extends Provider > ProviderFactory< T >	getProviderFactory (Class< T > clazz)
public< T extends Provider > ProviderFactory< T >	getProviderFactory (Class< T > clazz, String id)
< T extends Provider > Set< String >	getAllProviderIds (Class< T > clazz)
Class<? extends Provider >	getProviderClass (String providerClassName)

非公開メンバ関数
boolean	isEnabled (ProviderFactory factory, Config.Scope scope)
boolean	isInternal (ProviderFactory<?> factory)

非公開変数類
Set< Spi >	spis = new HashSet<>()
Map< Class<? extends Provider >, String >	provider = new HashMap<>()
volatile Map< Class<? extends Provider >, Map< String, ProviderFactory > >	factoriesMap = new HashMap<>()

静的非公開変数類
static final Logger	logger = Logger.getLogger(DefaultKeycloakSessionFactory.class)

詳解

関数詳解

checkProvider()

void org.keycloak.services.DefaultKeycloakSessionFactory.checkProvider ( )

inlineprotected

                                   {
        for (Spi spi : spis) {
            String provider = Config.getProvider(spi.getName());
            if (provider != null) {
                this.provider.put(spi.getProviderClass(), provider);
                if (getProviderFactory(spi.getProviderClass(), provider) == null) {
                    throw new RuntimeException("Failed to find provider " + provider + " for " + spi.getName());
                }
            } else {
                Map<String, ProviderFactory> factories = factoriesMap.get(spi.getProviderClass());
                if (factories != null && factories.size() == 1) {
                    provider = factories.values().iterator().next().getId();
                    this.provider.put(spi.getProviderClass(), provider);
                }
            }
        }
    }

close()

void org.keycloak.services.DefaultKeycloakSessionFactory.close ( )

inline

                        {
        ProviderManagerRegistry.SINGLETON.setDeployer(null);
        for (Map<String, ProviderFactory> factories : factoriesMap.values()) {
            for (ProviderFactory factory : factories.values()) {
                factory.close();
            }
        }
    }

create()

KeycloakSession org.keycloak.services.DefaultKeycloakSessionFactory.create ( )

inline

                                    {
        KeycloakSession session =  new DefaultKeycloakSession(this);
        return session;
    }

deploy()

void org.keycloak.services.DefaultKeycloakSessionFactory.deploy ( ProviderManager  pm )

inline

org.keycloak.provider.ProviderManagerDeployerを実装しています。

                                           {
        Map<Class<? extends Provider>, Map<String, ProviderFactory>> copy = getFactoriesCopy();
        Map<Class<? extends Provider>, Map<String, ProviderFactory>> newFactories = loadFactories(pm);
        List<ProviderFactory> deployed = new LinkedList<>();
        List<ProviderFactory> undeployed = new LinkedList<>();

        for (Map.Entry<Class<? extends Provider>, Map<String, ProviderFactory>> entry : newFactories.entrySet()) {
            Map<String, ProviderFactory> current = copy.get(entry.getKey());
            if (current == null) {
                copy.put(entry.getKey(), entry.getValue());
            } else {
                for (ProviderFactory f : entry.getValue().values()) {
                    deployed.add(f);
                    ProviderFactory old = current.remove(f.getId());
                    if (old != null) undeployed.add(old);
                }
                current.putAll(entry.getValue());
            }

        }
        factoriesMap = copy;
        for (ProviderFactory factory : undeployed) {
            factory.close();
        }
        for (ProviderFactory factory : deployed) {
            factory.postInit(this);
        }
    }

getAllProviderIds()

<T extends Provider> Set<String> org.keycloak.services.DefaultKeycloakSessionFactory.getAllProviderIds ( Class< T >  clazz )

inlinepackage

                                                                       {
        Set<String> ids = new HashSet<String>();
        for (ProviderFactory f : factoriesMap.get(clazz).values()) {
            ids.add(f.getId());
        }
        return ids;
    }

getDefaultProvider()

<T extends Provider> String org.keycloak.services.DefaultKeycloakSessionFactory.getDefaultProvider ( Class< T >  clazz )

inlinepackage

                                                                   {
        return provider.get(clazz);
    }

getFactoriesCopy()

Map<Class<? extends Provider>, Map<String, ProviderFactory> > org.keycloak.services.DefaultKeycloakSessionFactory.getFactoriesCopy ( )

inlineprotected

                                                                                              {
        Map<Class<? extends Provider>, Map<String, ProviderFactory>> copy = new HashMap<>();
        for (Map.Entry<Class<? extends Provider>, Map<String, ProviderFactory>> entry : factoriesMap.entrySet()) {
            Map<String, ProviderFactory> valCopy = new HashMap<>();
            valCopy.putAll(entry.getValue());
            copy.put(entry.getKey(), valCopy);
        }
        return copy;

    }

getProviderClass()

Class<? extends Provider> org.keycloak.services.DefaultKeycloakSessionFactory.getProviderClass ( String  providerClassName )

inlinepackage

                                                                         {
        for (Class<? extends Provider> clazz : factoriesMap.keySet()) {
            if (clazz.getName().equals(providerClassName)) {
                return clazz;
            }
        }
        return null;
    }

getProviderFactories()

List<ProviderFactory> org.keycloak.services.DefaultKeycloakSessionFactory.getProviderFactories ( Class<? extends Provider >  clazz )

inline

                                                                                       {
        List<ProviderFactory> list = new LinkedList<ProviderFactory>();
        if (factoriesMap == null) return list;
        Map<String, ProviderFactory> providerFactoryMap = factoriesMap.get(clazz);
        if (providerFactoryMap == null) return list;
        list.addAll(providerFactoryMap.values());
        return list;
    }

getProviderFactory() [1/2]

public<T extends Provider> ProviderFactory<T> org.keycloak.services.DefaultKeycloakSessionFactory.getProviderFactory ( Class< T >  clazz )

inlinepackage

                                                                                      {
         return getProviderFactory(clazz, provider.get(clazz));
    }

getProviderFactory() [2/2]

public<T extends Provider> ProviderFactory<T> org.keycloak.services.DefaultKeycloakSessionFactory.getProviderFactory ( Class< T >  clazz, String  id  )

inlinepackage

                                                                                                 {
        Map<String, ProviderFactory> map = factoriesMap.get(clazz);
        if (map == null) {
            return null;
        }
        return map.get(id);
    }

getServerStartupTimestamp()

long org.keycloak.services.DefaultKeycloakSessionFactory.getServerStartupTimestamp ( )

inline

戻り値

timestamp of Keycloak server startup

                                            {
        return serverStartupTimestamp;
    }

getSpi()

Spi org.keycloak.services.DefaultKeycloakSessionFactory.getSpi ( Class<? extends Provider >  providerClass )

inline

                                                               {
        for (Spi spi : spis) {
            if (spi.getProviderClass().equals(providerClass)) return spi;
        }
        return null;
    }

getSpis()

Set<Spi> org.keycloak.services.DefaultKeycloakSessionFactory.getSpis ( )

inline

                              {
        return spis;
    }

init()

void org.keycloak.services.DefaultKeycloakSessionFactory.init ( )

inline

                       {
        serverStartupTimestamp = System.currentTimeMillis();

        ProviderManager pm = new ProviderManager(KeycloakDeploymentInfo.create().services(), getClass().getClassLoader(), Config.scope().getArray("providers"));
        spis.addAll(pm.loadSpis());
        factoriesMap = loadFactories(pm);
        for (ProviderManager manager : ProviderManagerRegistry.SINGLETON.getPreBoot()) {
            Map<Class<? extends Provider>, Map<String, ProviderFactory>> factoryMap = loadFactories(manager);
            for (Map.Entry<Class<? extends Provider>,  Map<String, ProviderFactory>> entry : factoryMap.entrySet()) {
                Map<String, ProviderFactory> factories = factoriesMap.get(entry.getKey());
                if (factories == null) {
                    factoriesMap.put(entry.getKey(), entry.getValue());
                } else {
                    factories.putAll(entry.getValue());
                }
            }
        }
        checkProvider();
        for ( Map<String, ProviderFactory> factories : factoriesMap.values()) {
            for (ProviderFactory factory : factories.values()) {
                factory.postInit(this);
            }
        }
        // make the session factory ready for hot deployment
        ProviderManagerRegistry.SINGLETON.setDeployer(this);
        AdminPermissions.registerListener(this);

    }

isEnabled()

boolean org.keycloak.services.DefaultKeycloakSessionFactory.isEnabled ( ProviderFactory  factory, Config.Scope  scope  )

inlineprivate

                                                                           {
        if (!scope.getBoolean("enabled", true)) {
            return false;
        }
        if (factory instanceof EnvironmentDependentProviderFactory) {
            return ((EnvironmentDependentProviderFactory) factory).isSupported();
        }
        return true;
    }

isInternal()

boolean org.keycloak.services.DefaultKeycloakSessionFactory.isInternal ( ProviderFactory<?>  factory )

inlineprivate

                                                           {
        String packageName = factory.getClass().getPackage().getName();
        return packageName.startsWith("org.keycloak") && !packageName.startsWith("org.keycloak.examples");
    }

loadFactories()

Map<Class<? extends Provider>, Map<String, ProviderFactory> > org.keycloak.services.DefaultKeycloakSessionFactory.loadFactories ( ProviderManager  pm )

inlineprotected

                                                                                                             {
        Map<Class<? extends Provider>, Map<String, ProviderFactory>> factoryMap = new HashMap<>();
        Set<Spi> spiList = spis;

        for (Spi spi : spiList) {

            Map<String, ProviderFactory> factories = new HashMap<String, ProviderFactory>();
            factoryMap.put(spi.getProviderClass(), factories);

            String provider = Config.getProvider(spi.getName());
            if (provider != null) {

                ProviderFactory factory = pm.load(spi, provider);
                if (factory == null) {
                    continue;
                }

                Config.Scope scope = Config.scope(spi.getName(), provider);
                if (isEnabled(factory, scope)) {
                    factory.init(scope);

                    if (spi.isInternal() && !isInternal(factory)) {
                        ServicesLogger.LOGGER.spiMayChange(factory.getId(), factory.getClass().getName(), spi.getName());
                    }

                    factories.put(factory.getId(), factory);

                    logger.debugv("Loaded SPI {0} (provider = {1})", spi.getName(), provider);
                }

            } else {
                for (ProviderFactory factory : pm.load(spi)) {
                    Config.Scope scope = Config.scope(spi.getName(), factory.getId());
                    if (isEnabled(factory, scope)) {
                        factory.init(scope);

                        if (spi.isInternal() && !isInternal(factory)) {
                            ServicesLogger.LOGGER.spiMayChange(factory.getId(), factory.getClass().getName(), spi.getName());
                        }

                        factories.put(factory.getId(), factory);
                    } else {
                        logger.debugv("SPI {0} provider {1} disabled", spi.getName(), factory.getId());
                    }
                }
            }
        }
        return factoryMap;
    }

loadSPIs()

void org.keycloak.services.DefaultKeycloakSessionFactory.loadSPIs ( ProviderManager  pm, List< Spi >  spiList  )

inlineprotected

                                                                   {
        for (Spi spi : spiList) {
            spis.add(spi);

            Map<String, ProviderFactory> factories = new HashMap<String, ProviderFactory>();
            factoriesMap.put(spi.getProviderClass(), factories);

            String provider = Config.getProvider(spi.getName());
            if (provider != null) {
                this.provider.put(spi.getProviderClass(), provider);

                ProviderFactory factory = pm.load(spi, provider);
                if (factory == null) {
                    throw new RuntimeException("Failed to find provider " + provider + " for " + spi.getName());
                }

                Config.Scope scope = Config.scope(spi.getName(), provider);
                factory.init(scope);

                if (spi.isInternal() && !isInternal(factory)) {
                    ServicesLogger.LOGGER.spiMayChange(factory.getId(), factory.getClass().getName(), spi.getName());
                }

                factories.put(factory.getId(), factory);

                logger.debugv("Loaded SPI {0} (provider = {1})", spi.getName(), provider);
            } else {
                for (ProviderFactory factory : pm.load(spi)) {
                    Config.Scope scope = Config.scope(spi.getName(), factory.getId());
                    if (scope.getBoolean("enabled", true)) {
                        factory.init(scope);

                        if (spi.isInternal() && !isInternal(factory)) {
                            ServicesLogger.LOGGER.spiMayChange(factory.getId(), factory.getClass().getName(), spi.getName());
                        }

                        factories.put(factory.getId(), factory);
                    } else {
                        logger.debugv("SPI {0} provider {1} disabled", spi.getName(), factory.getId());
                    }
                }

                if (factories.size() == 1) {
                    provider = factories.values().iterator().next().getId();
                    this.provider.put(spi.getProviderClass(), provider);

                    logger.debugv("Loaded SPI {0} (provider = {1})", spi.getName(), provider);
                } else {
                    logger.debugv("Loaded SPI {0} (providers = {1})", spi.getName(), factories.keySet());
                }
            }
        }
    }

publish()

void org.keycloak.services.DefaultKeycloakSessionFactory.publish ( ProviderEvent  event )

inline

                                             {
        for (ProviderEventListener listener : listeners) {
            listener.onEvent(event);
        }
    }

register()

void org.keycloak.services.DefaultKeycloakSessionFactory.register ( ProviderEventListener  listener )

inline

                                                         {
        listeners.add(listener);
    }

undeploy()

void org.keycloak.services.DefaultKeycloakSessionFactory.undeploy ( ProviderManager  pm )

inline

org.keycloak.provider.ProviderManagerDeployerを実装しています。

                                             {
        logger.debug("undeploy");
        // we make a copy to avoid concurrent access exceptions
        Map<Class<? extends Provider>, Map<String, ProviderFactory>> copy = getFactoriesCopy();
        MultivaluedHashMap<Class<? extends Provider>, ProviderFactory> factories = pm.getLoadedFactories();
        List<ProviderFactory> undeployed = new LinkedList<>();
        for (Map.Entry<Class<? extends Provider>, List<ProviderFactory>> entry : factories.entrySet()) {
            Map<String, ProviderFactory> registered = copy.get(entry.getKey());
            for (ProviderFactory factory : entry.getValue()) {
                undeployed.add(factory);
                logger.debugv("undeploying {0} of id {1}", factory.getClass().getName(), factory.getId());
                if (registered != null) {
                    registered.remove(factory.getId());
                }
            }
        }
        factoriesMap = copy;
        for (ProviderFactory factory : undeployed) {
            factory.close();
        }
    }

unregister()

void org.keycloak.services.DefaultKeycloakSessionFactory.unregister ( ProviderEventListener  listener )

inline

                                                           {
        listeners.remove(listener);
    }

メンバ詳解

factoriesMap

volatile Map<Class<? extends Provider>, Map<String, ProviderFactory> > org.keycloak.services.DefaultKeycloakSessionFactory.factoriesMap = new HashMap<>()

private

listeners

CopyOnWriteArrayList<ProviderEventListener> org.keycloak.services.DefaultKeycloakSessionFactory.listeners = new CopyOnWriteArrayList<>()

protected

logger

final Logger org.keycloak.services.DefaultKeycloakSessionFactory.logger = Logger.getLogger(DefaultKeycloakSessionFactory.class)

staticprivate

provider

Map<Class<? extends Provider>, String> org.keycloak.services.DefaultKeycloakSessionFactory.provider = new HashMap<>()

private

serverStartupTimestamp

long org.keycloak.services.DefaultKeycloakSessionFactory.serverStartupTimestamp

protected

spis

Set<Spi> org.keycloak.services.DefaultKeycloakSessionFactory.spis = new HashSet<>()

private

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/rest-service/src/services/src/main/java/org/keycloak/services/DefaultKeycloakSessionFactory.java