org.keycloak.authorization.policy.provider.client.ClientPolicyProviderFactory クラス

org.keycloak.authorization.policy.provider.client.ClientPolicyProviderFactory の継承関係図

org.keycloak.authorization.policy.provider.client.ClientPolicyProviderFactory 連携図

公開メンバ関数
String	getName ()
String	getGroup ()
PolicyProvider	create (AuthorizationProvider authorization)
ClientPolicyRepresentation	toRepresentation (Policy policy, AuthorizationProvider authorization)
Class< ClientPolicyRepresentation >	getRepresentationType ()
void	onCreate (Policy policy, ClientPolicyRepresentation representation, AuthorizationProvider authorization)
void	onUpdate (Policy policy, ClientPolicyRepresentation representation, AuthorizationProvider authorization)
void	onImport (Policy policy, PolicyRepresentation representation, AuthorizationProvider authorization)
void	onExport (Policy policy, PolicyRepresentation representation, AuthorizationProvider authorization)
PolicyProvider	create (KeycloakSession session)
void	init (Config.Scope config)
void	postInit (KeycloakSessionFactory factory)
void	close ()
String	getId ()
default boolean	isInternal ()
default void	onCreate (Policy policy, R representation, AuthorizationProvider authorization)
default void	onUpdate (Policy policy, R representation, AuthorizationProvider authorization)
default void	onRemove (Policy policy, AuthorizationProvider authorization)
default PolicyProviderAdminService	getAdminResource (ResourceServer resourceServer, AuthorizationProvider authorization)
void	init (Config.Scope config)
default int	order ()

非公開メンバ関数
void	updateClients (Policy policy, Set< String > clients, AuthorizationProvider authorization)
String []	getClients (Policy policy)

非公開変数類
ClientPolicyProvider	provider = new ClientPolicyProvider(this::toRepresentation)

詳解

関数詳解

close()

void org.keycloak.authorization.policy.provider.client.ClientPolicyProviderFactory.close ( )

inline

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

                        {

    }

create() [1/2]

PolicyProvider org.keycloak.authorization.policy.provider.client.ClientPolicyProviderFactory.create ( AuthorizationProvider  authorization )

inline

org.keycloak.authorization.policy.provider.PolicyProviderFactory< R extends AbstractPolicyRepresentation >を実装しています。

                                                                      {
        return provider;
    }

create() [2/2]

PolicyProvider org.keycloak.authorization.policy.provider.client.ClientPolicyProviderFactory.create ( KeycloakSession  session )

inline

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

                                                          {
        return null;
    }

getAdminResource()

default PolicyProviderAdminService org.keycloak.authorization.policy.provider.PolicyProviderFactory< R extends AbstractPolicyRepresentation >.getAdminResource ( ResourceServer  resourceServer, AuthorizationProvider  authorization  )

inlineinherited

org.keycloak.authorization.policy.provider.drools.DroolsPolicyProviderFactoryで実装されています。

                                                                                                                            {
        return null;
    }

getClients()

String [] org.keycloak.authorization.policy.provider.client.ClientPolicyProviderFactory.getClients ( Policy  policy )

inlineprivate

                                               {
        String clients = policy.getConfig().get("clients");

        if (clients != null) {
            try {
                return JsonSerialization.readValue(clients.getBytes(), String[].class);
            } catch (IOException e) {
                throw new RuntimeException("Could not parse clients [" + clients + "] from policy config [" + policy.getName() + "].", e);
            }
        }

        return new String[]{};
    }

getGroup()

String org.keycloak.authorization.policy.provider.client.ClientPolicyProviderFactory.getGroup ( )

inline

org.keycloak.authorization.policy.provider.PolicyProviderFactory< R extends AbstractPolicyRepresentation >を実装しています。

                             {
        return "Identity Based";
    }

getId()

String org.keycloak.authorization.policy.provider.client.ClientPolicyProviderFactory.getId ( )

inline

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

                          {
        return "client";
    }

getName()

String org.keycloak.authorization.policy.provider.client.ClientPolicyProviderFactory.getName ( )

inline

org.keycloak.authorization.policy.provider.PolicyProviderFactory< R extends AbstractPolicyRepresentation >を実装しています。

                            {
        return "Client";
    }

getRepresentationType()

Class<ClientPolicyRepresentation> org.keycloak.authorization.policy.provider.client.ClientPolicyProviderFactory.getRepresentationType ( )

inline

org.keycloak.authorization.policy.provider.PolicyProviderFactory< R extends AbstractPolicyRepresentation >を実装しています。

                                                                     {
        return ClientPolicyRepresentation.class;
    }

init() [1/2]

void org.keycloak.provider.ProviderFactory< T extends Provider >.init ( Config.Scope  config )

inherited

Only called once when the factory is first created. This config is pulled from keycloak_server.json

引数

config

org.keycloak.cluster.infinispan.InfinispanClusterProviderFactory, org.keycloak.connections.jpa.updater.liquibase.conn.DefaultLiquibaseConnectionProvider, org.keycloak.connections.jpa.DefaultJpaConnectionProviderFactory, org.keycloak.policy.BlacklistPasswordPolicyProviderFactory, org.keycloak.connections.infinispan.DefaultInfinispanConnectionProviderFactory, org.keycloak.keys.infinispan.InfinispanPublicKeyStorageProviderFactory, org.keycloak.models.cache.infinispan.InfinispanUserCacheProviderFactory, org.keycloak.models.cache.infinispan.InfinispanCacheRealmProviderFactory, org.keycloak.storage.UserStorageProviderFactory< T extends UserStorageProvider >, org.keycloak.storage.client.ClientStorageProviderFactory< T extends ClientStorageProvider >, org.keycloak.models.session.DisabledUserSessionPersisterProvider, org.keycloak.models.sessions.infinispan.InfinispanActionTokenStoreProviderFactory, org.keycloak.connections.jpa.updater.liquibase.lock.LiquibaseDBLockProviderFactory, org.keycloak.policy.HashAlgorithmPasswordPolicyProviderFactory, org.keycloak.policy.HistoryPasswordPolicyProviderFactory, org.keycloak.models.jpa.session.JpaUserSessionPersisterProviderFactory, org.keycloak.policy.DigitsPasswordPolicyProviderFactory, org.keycloak.policy.LengthPasswordPolicyProviderFactory, org.keycloak.policy.NotUsernamePasswordPolicyProviderFactory, org.keycloak.policy.RegexPatternsPasswordPolicyProviderFactory, org.keycloak.events.jpa.JpaEventStoreProviderFactory, org.keycloak.credential.hash.Pbkdf2PasswordHashProviderFactory, org.keycloak.storage.jpa.JpaUserFederatedStorageProviderFactory, org.keycloak.policy.ForceExpiredPasswordPolicyProviderFactory, org.keycloak.policy.HashIterationsPasswordPolicyProviderFactory, org.keycloak.credential.CredentialProviderFactory< T extends CredentialProvider >, org.keycloak.connections.jpa.updater.liquibase.LiquibaseJpaUpdaterProviderFactory, org.keycloak.policy.LowerCasePasswordPolicyProviderFactory, org.keycloak.policy.SpecialCharsPasswordPolicyProviderFactory, org.keycloak.policy.UpperCasePasswordPolicyProviderFactory, org.keycloak.models.jpa.JpaRealmProviderFactory, org.keycloak.models.jpa.JpaUserCredentialStoreFactory, org.keycloak.models.jpa.JpaUserProviderFactory, org.keycloak.policy.DefaultPasswordPolicyManagerProviderFactory, org.keycloak.protocol.AbstractLoginProtocolFactory, org.keycloak.keys.KeyProviderFactory< T extends KeyProvider >, org.keycloak.urls.HostnameProviderFactory, org.keycloak.credential.hash.Pbkdf2Sha256PasswordHashProviderFactory, org.keycloak.credential.hash.Pbkdf2Sha512PasswordHashProviderFactory (計39項目)で実装されています。

init() [2/2]

void org.keycloak.authorization.policy.provider.client.ClientPolicyProviderFactory.init ( Config.Scope  config )

inline

                                          {

    }

isInternal()

default boolean org.keycloak.authorization.policy.provider.PolicyProviderFactory< R extends AbstractPolicyRepresentation >.isInternal ( )

inlineinherited

org.keycloak.authorization.policy.provider.permission.UMAPolicyProviderFactoryで実装されています。

                                 {
        return false;
    }

onCreate() [1/2]

default void org.keycloak.authorization.policy.provider.PolicyProviderFactory< R extends AbstractPolicyRepresentation >.onCreate ( Policy  policy, R  representation, AuthorizationProvider  authorization  )

inlineinherited

                                                                                                {

    }

onCreate() [2/2]

void org.keycloak.authorization.policy.provider.client.ClientPolicyProviderFactory.onCreate ( Policy  policy, ClientPolicyRepresentation  representation, AuthorizationProvider  authorization  )

inline

                                                                                                                        {
        updateClients(policy, representation.getClients(), authorization);
    }

onExport()

void org.keycloak.authorization.policy.provider.client.ClientPolicyProviderFactory.onExport ( Policy  policy, PolicyRepresentation  representation, AuthorizationProvider  authorization  )

inline

org.keycloak.authorization.policy.provider.PolicyProviderFactory< R extends AbstractPolicyRepresentation >を実装しています。

                                                                                                                  {
        ClientPolicyRepresentation userRep = toRepresentation(policy, authorization);
        Map<String, String> config = new HashMap<>();

        try {
            RealmModel realm = authorization.getRealm();
            config.put("clients", JsonSerialization.writeValueAsString(userRep.getClients().stream().map(id -> realm.getClientById(id).getClientId()).collect(Collectors.toList())));
        } catch (IOException cause) {
            throw new RuntimeException("Failed to export user policy [" + policy.getName() + "]", cause);
        }

        representation.setConfig(config);
    }

onImport()

void org.keycloak.authorization.policy.provider.client.ClientPolicyProviderFactory.onImport ( Policy  policy, PolicyRepresentation  representation, AuthorizationProvider  authorization  )

inline

org.keycloak.authorization.policy.provider.PolicyProviderFactory< R extends AbstractPolicyRepresentation >を実装しています。

                                                                                                                  {
        updateClients(policy, new HashSet<>(Arrays.asList(getClients(policy))), authorization);
    }

onRemove()

default void org.keycloak.authorization.policy.provider.PolicyProviderFactory< R extends AbstractPolicyRepresentation >.onRemove ( Policy  policy, AuthorizationProvider  authorization  )

inlineinherited

org.keycloak.authorization.policy.provider.permission.UMAPolicyProviderFactory, org.keycloak.authorization.policy.provider.aggregated.AggregatePolicyProviderFactory, org.keycloak.authorization.policy.provider.permission.ResourcePolicyProviderFactory, org.keycloak.authorization.policy.provider.drools.DroolsPolicyProviderFactory, org.keycloak.authorization.policy.provider.js.JSPolicyProviderFactory, org.keycloak.authorization.policy.provider.time.TimePolicyProviderFactoryで実装されています。

                                                                              {

    }

onUpdate() [1/2]

default void org.keycloak.authorization.policy.provider.PolicyProviderFactory< R extends AbstractPolicyRepresentation >.onUpdate ( Policy  policy, R  representation, AuthorizationProvider  authorization  )

inlineinherited

                                                                                                {

    }

onUpdate() [2/2]

void org.keycloak.authorization.policy.provider.client.ClientPolicyProviderFactory.onUpdate ( Policy  policy, ClientPolicyRepresentation  representation, AuthorizationProvider  authorization  )

inline

                                                                                                                        {
        updateClients(policy, representation.getClients(), authorization);
    }

order()

default int org.keycloak.provider.ProviderFactory< T extends Provider >.order ( )

inlineinherited

org.keycloak.urls.HostnameProviderFactoryで実装されています。

                        {
        return 0;
    }

postInit()

void org.keycloak.authorization.policy.provider.client.ClientPolicyProviderFactory.postInit ( KeycloakSessionFactory  factory )

inline

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

                                                         {
        factory.register(event -> {
            if (event instanceof ClientRemovedEvent) {
                KeycloakSession keycloakSession = ((ClientRemovedEvent) event).getKeycloakSession();
                AuthorizationProvider provider = keycloakSession.getProvider(AuthorizationProvider.class);
                StoreFactory storeFactory = provider.getStoreFactory();
                PolicyStore policyStore = storeFactory.getPolicyStore();
                ClientModel removedClient = ((ClientRemovedEvent) event).getClient();
                ResourceServerStore resourceServerStore = storeFactory.getResourceServerStore();
                ResourceServer resourceServer = resourceServerStore.findById(removedClient.getId());

                if (resourceServer != null) {
                    policyStore.findByType(getId(), resourceServer.getId()).forEach(policy -> {
                        List<String> clients = new ArrayList<>();

                        for (String clientId : getClients(policy)) {
                            if (!clientId.equals(removedClient.getId())) {
                                clients.add(clientId);
                            }
                        }

                        try {
                            if (clients.isEmpty()) {
                                policyStore.delete(policy.getId());
                            } else {
                                policy.putConfig("clients", JsonSerialization.writeValueAsString(clients));
                            }
                        } catch (IOException e) {
                            throw new RuntimeException("Error while synchronizing clients with policy [" + policy.getName() + "].", e);
                        }
                    });
                }
            }
        });
    }

toRepresentation()

ClientPolicyRepresentation org.keycloak.authorization.policy.provider.client.ClientPolicyProviderFactory.toRepresentation ( Policy  policy, AuthorizationProvider  authorization  )

inline

org.keycloak.authorization.policy.provider.PolicyProviderFactory< R extends AbstractPolicyRepresentation >を実装しています。

                                                                                                           {
        ClientPolicyRepresentation representation = new ClientPolicyRepresentation();
        representation.setClients(new HashSet<>(Arrays.asList(getClients(policy))));
        return representation;
    }

updateClients()

void org.keycloak.authorization.policy.provider.client.ClientPolicyProviderFactory.updateClients ( Policy  policy, Set< String >  clients, AuthorizationProvider  authorization  )

inlineprivate

                                                                                                        {
        RealmModel realm = authorization.getRealm();

        if (clients == null || clients.isEmpty()) {
            throw new RuntimeException("No client provided.");
        }

        Set<String> updatedClients = new HashSet<>();

        for (String id : clients) {
            ClientModel client = realm.getClientByClientId(id);

            if (client == null) {
                client = realm.getClientById(id);
            }

            if (client == null) {
                throw new RuntimeException("Error while updating policy [" + policy.getName()  + "]. Client [" + id + "] could not be found.");
            }

            updatedClients.add(client.getId());
        }

        try {
            policy.putConfig("clients", JsonSerialization.writeValueAsString(updatedClients));
        } catch (IOException cause) {
            throw new RuntimeException("Failed to serialize clients", cause);
        }
    }

メンバ詳解

provider

ClientPolicyProvider org.keycloak.authorization.policy.provider.client.ClientPolicyProviderFactory.provider = new ClientPolicyProvider(this::toRepresentation)

private

---

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

• D:/AppData/OpenId/keycloak/doxygen/src/authz/policy/common/src/main/java/org/keycloak/authorization/policy/provider/client/ClientPolicyProviderFactory.java