org.keycloak.storage.client.AbstractClientStorageAdapter クラス

org.keycloak.storage.client.AbstractClientStorageAdapter の継承関係図

org.keycloak.storage.client.AbstractClientStorageAdapter 連携図

公開メンバ関数
	AbstractClientStorageAdapter (KeycloakSession session, RealmModel realm, ClientStorageProviderModel component)
String	getId ()
final RealmModel	getRealm ()
boolean	isSurrogateAuthRequired ()
void	setSurrogateAuthRequired (boolean surrogateAuthRequired)
Map< String, Integer >	getRegisteredNodes ()
void	registerNode (String nodeHost, int registrationTime)
void	unregisterNode (String nodeHost)
void	updateClient ()
final RoleModel	getRole (String name)
final RoleModel	addRole (String name)
final RoleModel	addRole (String id, String name)
final boolean	removeRole (RoleModel role)
final Set< RoleModel >	getRoles ()
final List< String >	getDefaultRoles ()
final void	addDefaultRole (String name)
final void	updateDefaultRoles (String... defaultRoles)
final void	removeDefaultRoles (String... defaultRoles)

限定公開変数類
KeycloakSession	session
RealmModel	realm
ClientStorageProviderModel	component

非公開変数類
StorageId	storageId

詳解

Helper base class for ClientModel implementations for ClientStorageProvider implementations.

Contains default implementations of some methods

著者

Bill Burke

バージョン

Revision

1

構築子と解体子

AbstractClientStorageAdapter()

org.keycloak.storage.client.AbstractClientStorageAdapter.AbstractClientStorageAdapter ( KeycloakSession  session, RealmModel  realm, ClientStorageProviderModel  component  )

inline

                                                                                                                         {
        this.session = session;
        this.realm = realm;
        this.component = component;
    }

関数詳解

addDefaultRole()

final void org.keycloak.storage.client.UnsupportedOperationsClientStorageAdapter.addDefaultRole ( String  name )

inlineinherited

                                                  {
        throw new ModelException("Unsupported operation");

    }

addRole() [1/2]

final RoleModel org.keycloak.storage.client.UnsupportedOperationsClientStorageAdapter.addRole ( String  name )

inlineinherited

                                                {
        throw new ModelException("Unsupported operation");
    }

addRole() [2/2]

final RoleModel org.keycloak.storage.client.UnsupportedOperationsClientStorageAdapter.addRole ( String  id, String  name  )

inlineinherited

                                                           {
        throw new ModelException("Unsupported operation");
    }

getDefaultRoles()

final List<String> org.keycloak.storage.client.UnsupportedOperationsClientStorageAdapter.getDefaultRoles ( )

inlineinherited

                                                {
        return Collections.EMPTY_LIST;
    }

getId()

String org.keycloak.storage.client.AbstractClientStorageAdapter.getId ( )

inline

Creates federated id based on getClientId() method

戻り値

                          {
        if (storageId == null) {
            storageId = new StorageId(component.getId(), getClientId());
        }
        return storageId.getId();
    }

getRealm()

final RealmModel org.keycloak.storage.client.AbstractClientStorageAdapter.getRealm ( )

inline

                                       {
        return realm;
    }

getRegisteredNodes()

Map<String, Integer> org.keycloak.storage.client.AbstractClientStorageAdapter.getRegisteredNodes ( )

inline

This is for logout. Empty implementation for now. Can override if you can store this information somewhere.

戻り値

                                                     {
        return Collections.EMPTY_MAP;
    }

getRole()

final RoleModel org.keycloak.storage.client.UnsupportedOperationsClientStorageAdapter.getRole ( String  name )

inlineinherited

                                                {
        return null;
    }

getRoles()

final Set<RoleModel> org.keycloak.storage.client.UnsupportedOperationsClientStorageAdapter.getRoles ( )

inlineinherited

                                           {
        return Collections.EMPTY_SET;
    }

isSurrogateAuthRequired()

boolean org.keycloak.storage.client.AbstractClientStorageAdapter.isSurrogateAuthRequired ( )

inline

This method really isn't used by anybody anywhere. Legacy feature never supported.

戻り値

                                             {
        return false;
    }

registerNode()

void org.keycloak.storage.client.AbstractClientStorageAdapter.registerNode ( String  nodeHost, int  registrationTime  )

inline

This is for logout. Empty implementation for now. Can override if you can store this information somewhere.

戻り値

                                                                    {
        // do nothing
    }

removeDefaultRoles()

final void org.keycloak.storage.client.UnsupportedOperationsClientStorageAdapter.removeDefaultRoles ( String...  defaultRoles )

inlineinherited

                                                                 {
        throw new ModelException("Unsupported operation");
    }

removeRole()

final boolean org.keycloak.storage.client.UnsupportedOperationsClientStorageAdapter.removeRole ( RoleModel  role )

inlineinherited

                                                    {
        throw new ModelException("Unsupported operation");
    }

setSurrogateAuthRequired()

void org.keycloak.storage.client.AbstractClientStorageAdapter.setSurrogateAuthRequired ( boolean  surrogateAuthRequired )

inline

This method really isn't used by anybody anywhere. Legacy feature never supported.

戻り値

                                                                        {
        // do nothing, we don't do anything with this.
    }

unregisterNode()

void org.keycloak.storage.client.AbstractClientStorageAdapter.unregisterNode ( String  nodeHost )

inline

This is for logout. Empty implementation for now. Can override if you can store this information somewhere.

戻り値

                                                {
        // do nothing
    }

updateClient()

void org.keycloak.storage.client.AbstractClientStorageAdapter.updateClient ( )

inline

Overriding implementations should call super.updateClient() as this fires off an update event.

                               {
        session.getKeycloakSessionFactory().publish(new RealmModel.ClientUpdatedEvent() {

            @Override
            public ClientModel getUpdatedClient() {
                return AbstractClientStorageAdapter.this;
            }

            @Override
            public KeycloakSession getKeycloakSession() {
                return session;
            }
        });

    }

updateDefaultRoles()

final void org.keycloak.storage.client.UnsupportedOperationsClientStorageAdapter.updateDefaultRoles ( String...  defaultRoles )

inlineinherited

                                                                 {
        throw new ModelException("Unsupported operation");

    }

メンバ詳解

component

ClientStorageProviderModel org.keycloak.storage.client.AbstractClientStorageAdapter.component

protected

realm

RealmModel org.keycloak.storage.client.AbstractClientStorageAdapter.realm

protected

session

KeycloakSession org.keycloak.storage.client.AbstractClientStorageAdapter.session

protected

storageId

StorageId org.keycloak.storage.client.AbstractClientStorageAdapter.storageId

private

---

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

• D:/AppData/doxygen/keycloak/spi-private/src/server-spi-private/src/main/java/org/keycloak/storage/client/AbstractClientStorageAdapter.java