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

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

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

公開メンバ関数
	AbstractReadOnlyClientStorageAdapter (KeycloakSession session, RealmModel realm, ClientStorageProviderModel component)
void	setClientId (String clientId)
void	setName (String name)
void	setDescription (String description)
void	setEnabled (boolean enabled)
void	setWebOrigins (Set< String > webOrigins)
void	addWebOrigin (String webOrigin)
void	removeWebOrigin (String webOrigin)
void	setRedirectUris (Set< String > redirectUris)
void	addRedirectUri (String redirectUri)
void	removeRedirectUri (String redirectUri)
void	setManagementUrl (String url)
void	setRootUrl (String url)
void	setBaseUrl (String url)
void	setBearerOnly (boolean only)
void	setNodeReRegistrationTimeout (int timeout)
void	setClientAuthenticatorType (String clientAuthenticatorType)
void	setSecret (String secret)
void	setRegistrationToken (String registrationToken)
void	setProtocol (String protocol)
void	setAttribute (String name, String value)
void	removeAttribute (String name)
void	removeAuthenticationFlowBindingOverride (String binding)
void	setAuthenticationFlowBindingOverride (String binding, String flowId)
void	setFrontchannelLogout (boolean flag)
void	setPublicClient (boolean flag)
void	setConsentRequired (boolean consentRequired)
void	setStandardFlowEnabled (boolean standardFlowEnabled)
void	setImplicitFlowEnabled (boolean implicitFlowEnabled)
void	setDirectAccessGrantsEnabled (boolean directAccessGrantsEnabled)
void	setServiceAccountsEnabled (boolean serviceAccountsEnabled)
void	addClientScope (ClientScopeModel clientScope, boolean defaultScope)
void	removeClientScope (ClientScopeModel clientScope)
void	setNotBefore (int notBefore)
ProtocolMapperModel	addProtocolMapper (ProtocolMapperModel model)
void	removeProtocolMapper (ProtocolMapperModel mapping)
void	updateProtocolMapper (ProtocolMapperModel mapping)
void	setFullScopeAllowed (boolean value)
void	addScopeMapping (RoleModel role)
void	deleteScopeMapping (RoleModel role)
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

詳解

著者

Bill Burke

バージョン

Revision

1

構築子と解体子

AbstractReadOnlyClientStorageAdapter()

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

inline

                                                                                                                                 {
        super(session, realm, component);
    }

関数詳解

addClientScope()

void org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.addClientScope ( ClientScopeModel  clientScope, boolean  defaultScope  )

inline

                                                                                   {
        throw new ReadOnlyException("client is read only for this update");
    }

addDefaultRole()

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

inlineinherited

                                                  {
        throw new ModelException("Unsupported operation");

    }

addProtocolMapper()

ProtocolMapperModel org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.addProtocolMapper ( ProtocolMapperModel  model )

inline

                                                                            {
        throw new ReadOnlyException("client is read only for this update");
    }

addRedirectUri()

void org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.addRedirectUri ( String  redirectUri )

inline

                                                   {
        throw new ReadOnlyException("client is read only for this update");

    }

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");
    }

addScopeMapping()

void org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.addScopeMapping ( RoleModel  role )

inline

                                                {
        throw new ReadOnlyException("client is read only for this update");

    }

addWebOrigin()

void org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.addWebOrigin ( String  webOrigin )

inline

                                               {
        throw new ReadOnlyException("client is read only for this update");
    }

deleteScopeMapping()

void org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.deleteScopeMapping ( RoleModel  role )

inline

                                                   {
        throw new ReadOnlyException("client is read only for this update");

    }

getDefaultRoles()

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

inlineinherited

                                                {
        return Collections.EMPTY_LIST;
    }

getId()

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

inlineinherited

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 ( )

inlineinherited

                                       {
        return realm;
    }

getRegisteredNodes()

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

inlineinherited

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 ( )

inlineinherited

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  )

inlineinherited

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

戻り値

                                                                    {
        // do nothing
    }

removeAttribute()

void org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.removeAttribute ( String  name )

inline

                                             {
        throw new ReadOnlyException("client is read only for this update");

    }

removeAuthenticationFlowBindingOverride()

void org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.removeAuthenticationFlowBindingOverride ( String  binding )

inline

                                                                        {
        throw new ReadOnlyException("client is read only for this update");

    }

removeClientScope()

void org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.removeClientScope ( ClientScopeModel  clientScope )

inline

                                                                {
        throw new ReadOnlyException("client is read only for this update");
    }

removeDefaultRoles()

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

inlineinherited

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

removeProtocolMapper()

void org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.removeProtocolMapper ( ProtocolMapperModel  mapping )

inline

                                                                  {
        throw new ReadOnlyException("client is read only for this update");

    }

removeRedirectUri()

void org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.removeRedirectUri ( String  redirectUri )

inline

                                                      {
        throw new ReadOnlyException("client is read only for this update");

    }

removeRole()

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

inlineinherited

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

removeWebOrigin()

void org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.removeWebOrigin ( String  webOrigin )

inline

                                                  {
        throw new ReadOnlyException("client is read only for this update");

    }

setAttribute()

void org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.setAttribute ( String  name, String  value  )

inline

                                                        {
        throw new ReadOnlyException("client is read only for this update");

    }

setAuthenticationFlowBindingOverride()

void org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.setAuthenticationFlowBindingOverride ( String  binding, String  flowId  )

inline

                                                                                    {
        throw new ReadOnlyException("client is read only for this update");

    }

setBaseUrl()

void org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.setBaseUrl ( String  url )

inline

                                       {
        throw new ReadOnlyException("client is read only for this update");

    }

setBearerOnly()

void org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.setBearerOnly ( boolean  only )

inline

                                            {
        throw new ReadOnlyException("client is read only for this update");

    }

setClientAuthenticatorType()

void org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.setClientAuthenticatorType ( String  clientAuthenticatorType )

inline

                                                                           {
        throw new ReadOnlyException("client is read only for this update");

    }

setClientId()

void org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.setClientId ( String  clientId )

inline

                                             {
        throw new ReadOnlyException("client is read only for this update");

    }

setConsentRequired()

void org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.setConsentRequired ( boolean  consentRequired )

inline

                                                            {
        throw new ReadOnlyException("client is read only for this update");

    }

setDescription()

void org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.setDescription ( String  description )

inline

                                                   {
        throw new ReadOnlyException("client is read only for this update");

    }

setDirectAccessGrantsEnabled()

void org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.setDirectAccessGrantsEnabled ( boolean  directAccessGrantsEnabled )

inline

                                                                                {
        throw new ReadOnlyException("client is read only for this update");

    }

setEnabled()

void org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.setEnabled ( boolean  enabled )

inline

                                            {
        throw new ReadOnlyException("client is read only for this update");

    }

setFrontchannelLogout()

void org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.setFrontchannelLogout ( boolean  flag )

inline

                                                    {
        throw new ReadOnlyException("client is read only for this update");

    }

setFullScopeAllowed()

void org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.setFullScopeAllowed ( boolean  value )

inline

                                                   {
        throw new ReadOnlyException("client is read only for this update");

    }

setImplicitFlowEnabled()

void org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.setImplicitFlowEnabled ( boolean  implicitFlowEnabled )

inline

                                                                    {
        throw new ReadOnlyException("client is read only for this update");

    }

setManagementUrl()

void org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.setManagementUrl ( String  url )

inline

                                             {
        throw new ReadOnlyException("client is read only for this update");

    }

setName()

void org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.setName ( String  name )

inline

                                     {
        throw new ReadOnlyException("client is read only for this update");

    }

setNodeReRegistrationTimeout()

void org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.setNodeReRegistrationTimeout ( int  timeout )

inline

                                                          {

        throw new ReadOnlyException("client is read only for this update");
    }

setNotBefore()

void org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.setNotBefore ( int  notBefore )

inline

                                            {
        throw new ReadOnlyException("client is read only for this update");

    }

setProtocol()

void org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.setProtocol ( String  protocol )

inline

                                             {
        throw new ReadOnlyException("client is read only for this update");

    }

setPublicClient()

void org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.setPublicClient ( boolean  flag )

inline

                                              {
        throw new ReadOnlyException("client is read only for this update");

    }

setRedirectUris()

void org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.setRedirectUris ( Set< String >  redirectUris )

inline

                                                          {
        throw new ReadOnlyException("client is read only for this update");

    }

setRegistrationToken()

void org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.setRegistrationToken ( String  registrationToken )

inline

                                                               {
        throw new ReadOnlyException("client is read only for this update");

    }

setRootUrl()

void org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.setRootUrl ( String  url )

inline

                                       {
        throw new ReadOnlyException("client is read only for this update");

    }

setSecret()

void org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.setSecret ( String  secret )

inline

                                         {
        throw new ReadOnlyException("client is read only for this update");

    }

setServiceAccountsEnabled()

void org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.setServiceAccountsEnabled ( boolean  serviceAccountsEnabled )

inline

                                                                          {
        throw new ReadOnlyException("client is read only for this update");

    }

setStandardFlowEnabled()

void org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.setStandardFlowEnabled ( boolean  standardFlowEnabled )

inline

                                                                    {
        throw new ReadOnlyException("client is read only for this update");

    }

setSurrogateAuthRequired()

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

inlineinherited

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

戻り値

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

setWebOrigins()

void org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.setWebOrigins ( Set< String >  webOrigins )

inline

                                                      {
        throw new ReadOnlyException("client is read only for this update");

    }

unregisterNode()

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

inlineinherited

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 ( )

inlineinherited

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");

    }

updateProtocolMapper()

void org.keycloak.storage.client.AbstractReadOnlyClientStorageAdapter.updateProtocolMapper ( ProtocolMapperModel  mapping )

inline

                                                                  {
        throw new ReadOnlyException("client is read only for this update");

    }

メンバ詳解

component

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

protectedinherited

realm

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

protectedinherited

session

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

protectedinherited

---

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

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