org.keycloak.storage.ClientStorageManager クラス

org.keycloak.storage.ClientStorageManager の継承関係図

org.keycloak.storage.ClientStorageManager 連携図

公開メンバ関数
	ClientStorageManager (KeycloakSession session)
ClientModel	getClientById (String id, RealmModel realm)
ClientModel	getClientByClientId (String clientId, RealmModel realm)
ClientModel	addClient (RealmModel realm, String clientId)
ClientModel	addClient (RealmModel realm, String id, String clientId)
List< ClientModel >	getClients (RealmModel realm)
RoleModel	addClientRole (RealmModel realm, ClientModel client, String name)
RoleModel	addClientRole (RealmModel realm, ClientModel client, String id, String name)
RoleModel	getClientRole (RealmModel realm, ClientModel client, String name)
Set< RoleModel >	getClientRoles (RealmModel realm, ClientModel client)
void	close ()
boolean	removeClient (String id, RealmModel realm)

静的公開メンバ関数
static boolean	isStorageProviderEnabled (RealmModel realm, String providerId)
static ClientStorageProviderModel	getStorageProviderModel (RealmModel realm, String componentId)
static ClientStorageProvider	getStorageProvider (KeycloakSession session, RealmModel realm, String componentId)
static List< ClientStorageProviderModel >	getStorageProviders (RealmModel realm)
static ClientStorageProvider	getStorageProviderInstance (KeycloakSession session, ClientStorageProviderModel model, ClientStorageProviderFactory factory)
static< T > List< T >	getStorageProviders (KeycloakSession session, RealmModel realm, Class< T > type)
static< T > List< T >	getEnabledStorageProviders (KeycloakSession session, RealmModel realm, Class< T > type)

限定公開変数類
KeycloakSession	session

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

詳解

著者

Bill Burke

バージョン

Revision

1

構築子と解体子

ClientStorageManager()

org.keycloak.storage.ClientStorageManager.ClientStorageManager ( KeycloakSession  session )

inline

                                                         {
        this.session = session;
    }

関数詳解

addClient() [1/2]

ClientModel org.keycloak.storage.ClientStorageManager.addClient ( RealmModel  realm, String  clientId  )

inline

org.keycloak.models.ClientProviderを実装しています。

                                                                    {
        return session.clientLocalStorage().addClient(realm, clientId);
    }

addClient() [2/2]

ClientModel org.keycloak.storage.ClientStorageManager.addClient ( RealmModel  realm, String  id, String  clientId  )

inline

org.keycloak.models.ClientProviderを実装しています。

                                                                               {
        return session.clientLocalStorage().addClient(realm, id, clientId);
    }

addClientRole() [1/2]

RoleModel org.keycloak.storage.ClientStorageManager.addClientRole ( RealmModel  realm, ClientModel  client, String  name  )

inline

org.keycloak.models.ClientProviderを実装しています。

                                                                                      {
        if (!StorageId.isLocalStorage(client.getId())) {
            throw new RuntimeException("Federated clients do not support this operation");
        }
        return session.clientLocalStorage().addClientRole(realm, client, name);
    }

addClientRole() [2/2]

RoleModel org.keycloak.storage.ClientStorageManager.addClientRole ( RealmModel  realm, ClientModel  client, String  id, String  name  )

inline

org.keycloak.models.ClientProviderを実装しています。

                                                                                                 {
        if (!StorageId.isLocalStorage(client.getId())) {
            throw new RuntimeException("Federated clients do not support this operation");
        }
        return session.clientLocalStorage().addClientRole(realm, client, id, name);
    }

close()

void org.keycloak.storage.ClientStorageManager.close ( )

inline

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

                        {

    }

getClientByClientId()

ClientModel org.keycloak.storage.ClientStorageManager.getClientByClientId ( String  clientId, RealmModel  realm  )

inline

org.keycloak.storage.client.ClientLookupProviderを実装しています。

                                                                              {
        ClientModel client = session.clientLocalStorage().getClientByClientId(clientId, realm);
        if (client != null) {
            return client;
        }
        for (ClientLookupProvider provider : getEnabledStorageProviders(session, realm, ClientLookupProvider.class)) {
            client = provider.getClientByClientId(clientId, realm);
            if (client != null) return client;
        }
        return null;
    }

getClientById()

ClientModel org.keycloak.storage.ClientStorageManager.getClientById ( String  id, RealmModel  realm  )

inline

org.keycloak.storage.client.ClientLookupProviderを実装しています。

                                                                  {
        StorageId storageId = new StorageId(id);
        if (storageId.getProviderId() == null) {
            return session.clientLocalStorage().getClientById(id, realm);
        }
        ClientLookupProvider provider = (ClientLookupProvider)getStorageProvider(session, realm, storageId.getProviderId());
        if (provider == null) return null;
        if (!isStorageProviderEnabled(realm, storageId.getProviderId())) return null;
        return provider.getClientById(id, realm);
    }

getClientRole()

RoleModel org.keycloak.storage.ClientStorageManager.getClientRole ( RealmModel  realm, ClientModel  client, String  name  )

inline

org.keycloak.models.ClientProviderを実装しています。

                                                                                      {
        if (!StorageId.isLocalStorage(client.getId())) {
            //throw new RuntimeException("Federated clients do not support this operation");
            return null;
        }
        return session.clientLocalStorage().getClientRole(realm, client, name);
    }

getClientRoles()

Set<RoleModel> org.keycloak.storage.ClientStorageManager.getClientRoles ( RealmModel  realm, ClientModel  client  )

inline

org.keycloak.models.ClientProviderを実装しています。

                                                                               {
        if (!StorageId.isLocalStorage(client.getId())) {
            //throw new RuntimeException("Federated clients do not support this operation");
            return Collections.EMPTY_SET;
        }
        return session.clientLocalStorage().getClientRoles(realm, client);
    }

getClients()

List<ClientModel> org.keycloak.storage.ClientStorageManager.getClients ( RealmModel  realm )

inline

org.keycloak.models.ClientProviderを実装しています。

                                                          {
       return session.clientLocalStorage().getClients(realm);
    }

getEnabledStorageProviders()

static <T> List<T> org.keycloak.storage.ClientStorageManager.getEnabledStorageProviders ( KeycloakSession  session, RealmModel  realm, Class< T >  type  )

inlinestatic

                                                                                                                   {
        List<T> list = new LinkedList<>();
        for (ClientStorageProviderModel model : getStorageProviders(realm)) {
            if (!model.isEnabled()) continue;
            ClientStorageProviderFactory factory = (ClientStorageProviderFactory) session.getKeycloakSessionFactory().getProviderFactory(ClientStorageProvider.class, model.getProviderId());
            if (factory == null) {
                logger.warnv("Configured ClientStorageProvider {0} of provider id {1} does not exist in realm {2}", model.getName(), model.getProviderId(), realm.getName());
                continue;
            }
            if (Types.supports(type, factory, ClientStorageProviderFactory.class)) {
                list.add(type.cast(getStorageProviderInstance(session, model, factory)));
            }


        }
        return list;
    }

getStorageProvider()

static ClientStorageProvider org.keycloak.storage.ClientStorageManager.getStorageProvider ( KeycloakSession  session, RealmModel  realm, String  componentId  )

inlinestatic

                                                                                                                          {
        ComponentModel model = realm.getComponent(componentId);
        if (model == null) return null;
        ClientStorageProviderModel storageModel = new ClientStorageProviderModel(model);
        ClientStorageProviderFactory factory = (ClientStorageProviderFactory)session.getKeycloakSessionFactory().getProviderFactory(ClientStorageProvider.class, model.getProviderId());
        if (factory == null) {
            throw new ModelException("Could not find ClientStorageProviderFactory for: " + model.getProviderId());
        }
        return getStorageProviderInstance(session, storageModel, factory);
    }

getStorageProviderInstance()

static ClientStorageProvider org.keycloak.storage.ClientStorageManager.getStorageProviderInstance ( KeycloakSession  session, ClientStorageProviderModel  model, ClientStorageProviderFactory  factory  )

inlinestatic

                                                                                                                                                                    {
        ClientStorageProvider instance = (ClientStorageProvider)session.getAttribute(model.getId());
        if (instance != null) return instance;
        instance = factory.create(session, model);
        if (instance == null) {
            throw new IllegalStateException("ClientStorageProvideFactory (of type " + factory.getClass().getName() + ") produced a null instance");
        }
        session.enlistForClose(instance);
        session.setAttribute(model.getId(), instance);
        return instance;
    }

getStorageProviderModel()

static ClientStorageProviderModel org.keycloak.storage.ClientStorageManager.getStorageProviderModel ( RealmModel  realm, String  componentId  )

inlinestatic

                                                                                                           {
        ComponentModel model = realm.getComponent(componentId);
        if (model == null) return null;
        return new ClientStorageProviderModel(model);
    }

getStorageProviders() [1/2]

static List<ClientStorageProviderModel> org.keycloak.storage.ClientStorageManager.getStorageProviders ( RealmModel  realm )

inlinestatic

                                                                                         {
        return realm.getClientStorageProviders();
    }

getStorageProviders() [2/2]

static <T> List<T> org.keycloak.storage.ClientStorageManager.getStorageProviders ( KeycloakSession  session, RealmModel  realm, Class< T >  type  )

inlinestatic

                                                                                                            {
        List<T> list = new LinkedList<>();
        for (ClientStorageProviderModel model : getStorageProviders(realm)) {
            ClientStorageProviderFactory factory = (ClientStorageProviderFactory) session.getKeycloakSessionFactory().getProviderFactory(ClientStorageProvider.class, model.getProviderId());
            if (factory == null) {
                logger.warnv("Configured ClientStorageProvider {0} of provider id {1} does not exist in realm {2}", model.getName(), model.getProviderId(), realm.getName());
                continue;
            }
            if (Types.supports(type, factory, ClientStorageProviderFactory.class)) {
                list.add(type.cast(getStorageProviderInstance(session, model, factory)));
            }


        }
        return list;
    }

isStorageProviderEnabled()

static boolean org.keycloak.storage.ClientStorageManager.isStorageProviderEnabled ( RealmModel  realm, String  providerId  )

inlinestatic

                                                                                        {
        ClientStorageProviderModel model = getStorageProviderModel(realm, providerId);
        return model.isEnabled();
    }

removeClient()

boolean org.keycloak.storage.ClientStorageManager.removeClient ( String  id, RealmModel  realm  )

inline

org.keycloak.models.ClientProviderを実装しています。

                                                             {
        if (!StorageId.isLocalStorage(id)) {
            throw new RuntimeException("Federated clients do not support this operation");
        }
        return session.clientLocalStorage().removeClient(id, realm);
    }

メンバ詳解

logger

final Logger org.keycloak.storage.ClientStorageManager.logger = Logger.getLogger(ClientStorageManager.class)

staticprivate

session

KeycloakSession org.keycloak.storage.ClientStorageManager.session

protected

---

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

• D:/AppData/doxygen/keycloak/oidc-service/src/main/java/org/keycloak/storage/ClientStorageManager.java