Modifier and Type | Interface and Description |
---|---|
interface |
ComponentFactory<CreatedType,ProviderType extends Provider> |
interface |
SubComponentFactory<CreatedType,ProviderType extends Provider>
Useful when you want to describe config properties that are effected by the parent ComponentModel
|
Constructor and Description |
---|
JsonConfigComponentModel(Class<? extends Provider> providerType,
String realmId,
String providerId,
com.fasterxml.jackson.databind.JsonNode configNode) |
Modifier and Type | Interface and Description |
---|---|
interface |
CredentialProvider<T extends CredentialModel> |
interface |
UserCredentialStore |
static interface |
UserCredentialStore.Streams
The
UserCredentialStore.Streams interface makes all collection-based methods in UserCredentialStore
default by providing implementations that delegate to the Stream -based variants instead of the other way around. |
Modifier and Type | Interface and Description |
---|---|
interface |
PasswordHashProvider |
Modifier and Type | Interface and Description |
---|---|
interface |
LocaleSelectorProvider |
interface |
LocaleUpdaterProvider |
Modifier and Type | Method and Description |
---|---|
Class<? extends Provider> |
LocaleUpdaterSPI.getProviderClass() |
Class<? extends Provider> |
LocaleSelectorSPI.getProviderClass() |
Modifier and Type | Interface and Description |
---|---|
interface |
ClientProvider
Provider of the client records.
|
interface |
ClientScopeProvider
Provider of the client scopes records.
|
interface |
GroupProvider
Provider of group records
|
interface |
RealmProvider |
interface |
RoleProvider
Provider of the role records.
|
interface |
UserCredentialManager |
static interface |
UserCredentialManager.Streams
The
UserCredentialManager.Streams interface makes all collection-based methods in UserCredentialManager
default by providing implementations that delegate to the Stream -based variants instead of the other way around. |
interface |
UserLoginFailureProvider |
interface |
UserProvider |
static interface |
UserProvider.Streams
The
UserProvider.Streams interface makes all collection-based methods in UserProvider default by
providing implementations that delegate to the Stream -based variants instead of the other way around. |
interface |
UserSessionProvider |
Modifier and Type | Method and Description |
---|---|
<T extends Provider> |
KeycloakSession.getAllProviders(Class<T> clazz) |
<T extends Provider> |
KeycloakSession.getComponentProvider(Class<T> clazz,
String componentId)
Returns a component provider for a component from the realm that is relevant to this session.
|
<T extends Provider> |
KeycloakSession.getComponentProvider(Class<T> clazz,
String componentId,
Function<KeycloakSessionFactory,ComponentModel> modelGetter)
Returns a component provider for a component from the realm that is relevant to this session.
|
<T extends Provider> |
KeycloakSession.getProvider(Class<T> clazz)
Get dedicated provider instance of provider type clazz that was created for this session.
|
<T extends Provider> |
KeycloakSession.getProvider(Class<T> clazz,
ComponentModel componentModel)
Deprecated.
Deprecated in favor of {@link #getComponentProvider)
|
<T extends Provider> |
KeycloakSession.getProvider(Class<T> clazz,
String id)
Get dedicated provider instance for a specific provider factory of id of provider type clazz that was created for this session.
|
<T extends Provider> |
KeycloakSessionFactory.getProviderFactory(Class<T> clazz) |
<T extends Provider> |
KeycloakSessionFactory.getProviderFactory(Class<T> clazz,
String id) |
<T extends Provider> |
KeycloakSessionFactory.getProviderFactory(Class<T> clazz,
String realmId,
String componentId,
Function<KeycloakSessionFactory,ComponentModel> modelGetter) |
<T extends Provider> |
KeycloakSession.listProviderIds(Class<T> clazz)
Get all provider factories that manage provider instances of class.
|
Modifier and Type | Method and Description |
---|---|
Class<? extends Provider> |
KeycloakSession.getProviderClass(String providerClassName) |
Modifier and Type | Method and Description |
---|---|
void |
KeycloakSession.enlistForClose(Provider provider) |
Modifier and Type | Method and Description |
---|---|
default List<ProviderFactory> |
KeycloakSessionFactory.getProviderFactories(Class<? extends Provider> clazz)
Deprecated.
Use
getProviderFactoriesStream instead. |
Stream<ProviderFactory> |
KeycloakSessionFactory.getProviderFactoriesStream(Class<? extends Provider> clazz)
Returns stream of provider factories for the given provider.
|
Spi |
KeycloakSessionFactory.getSpi(Class<? extends Provider> providerClass) |
default Stream<ComponentModel> |
RealmModel.getStorageProviders(Class<? extends Provider> storageProviderClass)
Returns stream of ComponentModels that represent StorageProviders for class storageProviderClass in this realm.
|
Modifier and Type | Interface and Description |
---|---|
interface |
UserCache
All these methods effect an entire cluster of Keycloak instances.
|
static interface |
UserCache.Streams
The
UserCache.Streams interface differs from UserCache in that it extends the UserProvider.Streams
interface, allowing implementations of UserCache to focus on the Stream -based methods
in the UserProvider interface. |
Modifier and Type | Interface and Description |
---|---|
interface |
PasswordPolicyProvider |
Modifier and Type | Interface and Description |
---|---|
interface |
ProviderFactory<T extends Provider>
At boot time, keycloak discovers all factories.
|
Modifier and Type | Method and Description |
---|---|
Class<? extends Provider> |
Spi.getProviderClass() |
Modifier and Type | Interface and Description |
---|---|
interface |
ClientPolicyManager
Provides a method for handling an event defined in
ClientPolicyEvent . |
Modifier and Type | Interface and Description |
---|---|
interface |
AuthenticationSessionProvider |
Modifier and Type | Interface and Description |
---|---|
interface |
UserStorageProvider
A class implementing this interface represents a user storage provider to Keycloak.
|
Modifier and Type | Method and Description |
---|---|
Class<? extends Provider> |
UserStorageProviderSpi.getProviderClass() |
Modifier and Type | Interface and Description |
---|---|
interface |
ClientStorageProvider
Base interface for components that want to provide an alternative storage mechanism for clients
This is currently a private incomplete SPI.
|
Modifier and Type | Interface and Description |
---|---|
interface |
UserFederatedStorageProvider |
static interface |
UserFederatedStorageProvider.Streams
The
UserFederatedStorageProvider.Streams interface makes all collection-based methods in UserFederatedStorageProvider
default by providing implementations that delegate to the Stream -based variants instead of the other way
around. |
interface |
UserFederatedUserCredentialStore |
static interface |
UserFederatedUserCredentialStore.Streams
The
UserFederatedUserCredentialStore.Streams interface makes all collection-based methods in UserFederatedUserCredentialStore
default by providing implementations that delegate to the Stream -based variants instead of the other way
around. |
Modifier and Type | Method and Description |
---|---|
Class<? extends Provider> |
UserFederatedStorageProviderSpi.getProviderClass() |
Modifier and Type | Interface and Description |
---|---|
interface |
GroupStorageProvider |
Modifier and Type | Interface and Description |
---|---|
interface |
RoleStorageProvider
Base interface for components that want to provide an alternative storage mechanism for roles
|
Modifier and Type | Interface and Description |
---|---|
interface |
ThemeResourceProvider
A theme resource provider can be used to load additional templates and resources.
|
interface |
ThemeSelectorProvider |
Modifier and Type | Method and Description |
---|---|
Class<? extends Provider> |
ThemeSelectorSpi.getProviderClass() |
Class<? extends Provider> |
ThemeResourceSpi.getProviderClass() |
Modifier and Type | Interface and Description |
---|---|
interface |
HostnameProvider
The Hostname provider is used by Keycloak to decide URLs for frontend and backend requests.
|
Modifier and Type | Method and Description |
---|---|
Class<? extends Provider> |
HostnameSpi.getProviderClass() |
Modifier and Type | Interface and Description |
---|---|
interface |
VaultProvider
Provider interface for a vault.
|
Modifier and Type | Method and Description |
---|---|
Class<? extends Provider> |
VaultSpi.getProviderClass() |
Copyright © 2021 JBoss by Red Hat. All rights reserved.