org.keycloak.protocol.AbstractLoginProtocolFactory クラス

org.keycloak.protocol.AbstractLoginProtocolFactory の継承関係図

org.keycloak.protocol.AbstractLoginProtocolFactory 連携図

公開メンバ関数
void	init (Config.Scope config)
void	postInit (KeycloakSessionFactory factory)
void	createDefaultClientScopes (RealmModel newRealm, boolean addScopesToExistingClients)
void	close ()
Map< String, ProtocolMapperModel >	getBuiltinMappers ()
Object	createProtocolEndpoint (RealmModel realm, EventBuilder event)
void	setupClientDefaults (ClientRepresentation rep, ClientModel newClient)

限定公開メンバ関数
abstract void	createDefaultClientScopesImpl (RealmModel newRealm)
void	addDefaultClientScopes (RealmModel realm, ClientModel newClient)
abstract void	addDefaults (ClientModel realm)

詳解

著者

Bill Burke

バージョン

Revision

1

関数詳解

addDefaultClientScopes()

void org.keycloak.protocol.AbstractLoginProtocolFactory.addDefaultClientScopes ( RealmModel  realm, ClientModel  newClient  )

inlineprotected

                                                                                   {
        for (ClientScopeModel clientScope : realm.getDefaultClientScopes(true)) {
            if (getId().equals(clientScope.getProtocol())) {
                newClient.addClientScope(clientScope, true);
            }
        }
        for (ClientScopeModel clientScope : realm.getDefaultClientScopes(false)) {
            if (getId().equals(clientScope.getProtocol())) {
                newClient.addClientScope(clientScope, false);
            }
        }
    }

addDefaults()

abstract void org.keycloak.protocol.AbstractLoginProtocolFactory.addDefaults ( ClientModel  realm )

abstractprotected

close()

void org.keycloak.protocol.AbstractLoginProtocolFactory.close ( )

inline

                        {

    }

createDefaultClientScopes()

void org.keycloak.protocol.AbstractLoginProtocolFactory.createDefaultClientScopes ( RealmModel  newRealm, boolean  addScopesToExistingClients  )

inline

org.keycloak.protocol.LoginProtocolFactoryを実装しています。

                                                                                                   {
        createDefaultClientScopesImpl(newRealm);

        // Create default client scopes for realm built-in clients too
        if (addScopesToExistingClients) {
            for (ClientModel client : newRealm.getClients()) {
                addDefaultClientScopes(newRealm, client);
            }
        }
    }

createDefaultClientScopesImpl()

abstract void org.keycloak.protocol.AbstractLoginProtocolFactory.createDefaultClientScopesImpl ( RealmModel  newRealm )

abstractprotected

Impl should create default client scopes. This is called usually when new realm is created

createProtocolEndpoint()

Object org.keycloak.protocol.LoginProtocolFactory.createProtocolEndpoint ( RealmModel  realm, EventBuilder  event  )

inherited

getBuiltinMappers()

Map<String, ProtocolMapperModel> org.keycloak.protocol.LoginProtocolFactory.getBuiltinMappers ( )

inherited

List of built in protocol mappers that can be used to apply to clients.

戻り値

init()

void org.keycloak.protocol.AbstractLoginProtocolFactory.init ( Config.Scope  config )

inline

                                          {
    }

postInit()

void org.keycloak.protocol.AbstractLoginProtocolFactory.postInit ( KeycloakSessionFactory  factory )

inline

                                                         {
        factory.register(new ProviderEventListener() {
            @Override
            public void onEvent(ProviderEvent event) {
                if (event instanceof RealmModel.ClientCreationEvent) {
                    ClientModel client = ((RealmModel.ClientCreationEvent)event).getCreatedClient();
                    addDefaultClientScopes(client.getRealm(), client);
                    addDefaults(client);
                }
            }
        });
    }

setupClientDefaults()

void org.keycloak.protocol.LoginProtocolFactory.setupClientDefaults ( ClientRepresentation  rep, ClientModel  newClient  )

inherited

Setup default values for new clients. This expects that the representation has already set up the client

引数

rep
newClient

---

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

• D:/AppData/doxygen/keycloak/spi-private/src/server-spi-private/src/main/java/org/keycloak/protocol/AbstractLoginProtocolFactory.java