Package org.keycloak.storage.client

Class AbstractClientStorageAdapter

java.lang.Object

org.keycloak.storage.client.UnsupportedOperationsClientStorageAdapter

org.keycloak.storage.client.AbstractClientStorageAdapter

All Implemented Interfaces:

ClientModel, ClientScopeModel, OrderedModel, ProtocolMapperContainerModel, RoleContainerModel, ScopeContainerModel

Direct Known Subclasses:

AbstractReadOnlyClientStorageAdapter

public abstract class AbstractClientStorageAdapter
extends UnsupportedOperationsClientStorageAdapter

Helper base class for ClientModel implementations for ClientStorageProvider implementations. Contains default implementations of some methods

Version:

$Revision: 1 $

Author:

Bill Burke

Nested Class Summary

Nested classes/interfaces inherited from interface org.keycloak.models.ClientModel

ClientModel.ClientCreationEvent, ClientModel.ClientIdChangeEvent, ClientModel.ClientProtocolUpdatedEvent, ClientModel.ClientRemovedEvent, ClientModel.ClientUpdatedEvent, ClientModel.SearchableFields

Nested classes/interfaces inherited from interface org.keycloak.models.ClientScopeModel

ClientScopeModel.ClientScopeRemovedEvent

Nested classes/interfaces inherited from interface org.keycloak.models.OrderedModel

OrderedModel.OrderedModelComparator<OM extends OrderedModel>

Nested classes/interfaces inherited from interface org.keycloak.models.RoleContainerModel

RoleContainerModel.RoleRemovedEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientStorageProviderModel	component
protected RealmModel	realm
protected KeycloakSession	session

Fields inherited from interface org.keycloak.models.ClientModel

LOGO_URI, POLICY_URI, PRIVATE_KEY, PUBLIC_KEY, TOS_URI, X509CERTIFICATE

Fields inherited from interface org.keycloak.models.ClientScopeModel

CONSENT_SCREEN_TEXT, DISPLAY_ON_CONSENT_SCREEN, DYNAMIC_SCOPE_REGEXP, GUI_ORDER, INCLUDE_IN_TOKEN_SCOPE, IS_DYNAMIC_SCOPE

Constructor Summary

Constructors

Constructor	Description
AbstractClientStorageAdapter(KeycloakSession session, RealmModel realm, ClientStorageProviderModel component)

Method Summary

Modifier and Type	Method	Description
String	getId()	Creates federated id based on getClientId() method
final RealmModel	getRealm()
Map<String,Integer>	getRegisteredNodes()	This is for logout.
boolean	isSurrogateAuthRequired()	This method really isn't used by anybody anywhere.
void	registerNode(String nodeHost, int registrationTime)	This is for logout.
void	setSurrogateAuthRequired(boolean surrogateAuthRequired)	This method really isn't used by anybody anywhere.
void	unregisterNode(String nodeHost)	This is for logout.
void	updateClient()	Overriding implementations should call super.updateClient() as this fires off an update event.

Methods inherited from class org.keycloak.storage.client.UnsupportedOperationsClientStorageAdapter

addRole, addRole, getRole, getRolesStream, getRolesStream, removeRole, searchForRolesStream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.keycloak.models.ClientModel

addClientScope, addClientScopes, addRedirectUri, addWebOrigin, getAttribute, getAttributes, getAuthenticationFlowBindingOverride, getAuthenticationFlowBindingOverrides, getBaseUrl, getClientAuthenticatorType, getClientId, getClientScopes, getConsentScreenText, getDescription, getDynamicClientScope, getManagementUrl, getName, getNodeReRegistrationTimeout, getNotBefore, getProtocol, getRedirectUris, getRegistrationToken, getRootUrl, getSecret, getWebOrigins, hasDirectScope, isAlwaysDisplayInConsole, isBearerOnly, isConsentRequired, isDirectAccessGrantsEnabled, isDisplayOnConsentScreen, isEnabled, isFrontchannelLogout, isFullScopeAllowed, isImplicitFlowEnabled, isPublicClient, isServiceAccountsEnabled, isStandardFlowEnabled, removeAttribute, removeAuthenticationFlowBindingOverride, removeClientScope, removeRedirectUri, removeWebOrigin, setAlwaysDisplayInConsole, setAttribute, setAuthenticationFlowBindingOverride, setBaseUrl, setBearerOnly, setClientAuthenticatorType, setClientId, setConsentRequired, setDescription, setDirectAccessGrantsEnabled, setEnabled, setFrontchannelLogout, setFullScopeAllowed, setImplicitFlowEnabled, setManagementUrl, setName, setNodeReRegistrationTimeout, setNotBefore, setProtocol, setPublicClient, setRedirectUris, setRegistrationToken, setRootUrl, setSecret, setServiceAccountsEnabled, setStandardFlowEnabled, setWebOrigins, validateSecret

Methods inherited from interface org.keycloak.models.ClientScopeModel

getDynamicScopeRegexp, getGuiOrder, isDynamicScope, isIncludeInTokenScope, setConsentScreenText, setDisplayOnConsentScreen, setGuiOrder, setIncludeInTokenScope, setIsDynamicScope

Methods inherited from interface org.keycloak.models.ProtocolMapperContainerModel

addProtocolMapper, getProtocolMapperById, getProtocolMapperByName, getProtocolMappersStream, removeProtocolMapper, updateProtocolMapper

Methods inherited from interface org.keycloak.models.ScopeContainerModel

addScopeMapping, deleteScopeMapping, getRealmScopeMappingsStream, getScopeMappingsStream, hasScope

Field Details

session

protected KeycloakSession session

realm

protected RealmModel realm

component

protected ClientStorageProviderModel component

Constructor Details

AbstractClientStorageAdapter

public AbstractClientStorageAdapter(KeycloakSession session,
 RealmModel realm,
 ClientStorageProviderModel component)

Method Details

getId

public String getId()

Creates federated id based on getClientId() method

Returns:

getRealm

public final RealmModel getRealm()

isSurrogateAuthRequired

public boolean isSurrogateAuthRequired()

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

Returns:

setSurrogateAuthRequired

public void setSurrogateAuthRequired(boolean surrogateAuthRequired)

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

getRegisteredNodes

public Map<String,Integer> getRegisteredNodes()

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

Returns:

registerNode

public void registerNode(String nodeHost,
 int registrationTime)

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

unregisterNode

public void unregisterNode(String nodeHost)

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

updateClient

public void updateClient()

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

See Also:

• ProviderEvent
• ProviderEventManager
• ClientModel.ClientUpdatedEvent