public class DefaultKeycloakSession extends Object implements KeycloakSession
InvalidationHandler.InvalidableObjectType, InvalidationHandler.ObjectType
Constructor and Description |
---|
DefaultKeycloakSession(DefaultKeycloakSessionFactory factory) |
Modifier and Type | Method and Description |
---|---|
AuthenticationSessionProvider |
authenticationSessions() |
ClientProvider |
clientLocalStorage()
Keycloak specific local storage for clients.
|
ClientPolicyManager |
clientPolicy()
Client Policy Manager
|
ClientProvider |
clients()
Returns a managed provider instance.
|
ClientScopeProvider |
clientScopeLocalStorage()
Keycloak specific local storage for client scopes.
|
ClientScopeProvider |
clientScopes()
Returns a managed provider instance.
|
ClientScopeProvider |
clientScopeStorageManager() |
ClientProvider |
clientStorageManager() |
void |
close() |
void |
enlistForClose(Provider provider) |
<T extends Provider> |
getAllProviders(Class<T> clazz) |
Object |
getAttribute(String attribute) |
<T> T |
getAttribute(String attribute,
Class<T> clazz) |
<T extends Provider> |
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> |
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.
|
KeycloakContext |
getContext() |
KeycloakSessionFactory |
getKeycloakSessionFactory() |
<T extends Provider> |
getProvider(Class<T> clazz)
Get dedicated provider instance of provider type clazz that was created for this session.
|
<T extends Provider> |
getProvider(Class<T> clazz,
ComponentModel componentModel) |
<T extends Provider> |
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.
|
Class<? extends Provider> |
getProviderClass(String providerClassName) |
KeycloakTransactionManager |
getTransactionManager() |
GroupProvider |
groupLocalStorage()
Keycloak specific local storage for groups.
|
GroupProvider |
groups()
Returns a managed group provider instance.
|
GroupProvider |
groupStorageManager() |
void |
invalidate(InvalidationHandler.InvalidableObjectType type,
Object... ids)
Invalidates intermediate states of the given objects, both immediately and at the end of this session.
|
KeyManager |
keys()
Key manager
|
<T extends Provider> |
listProviderIds(Class<T> clazz)
Get all provider factories that manage provider instances of class.
|
UserLoginFailureProvider |
loginFailures()
Returns a managed provider instance.
|
RealmProvider |
realmLocalStorage() |
RealmProvider |
realms()
Returns a managed provider instance.
|
Object |
removeAttribute(String attribute) |
RoleProvider |
roleLocalStorage()
Keycloak specific local storage for roles.
|
RoleProvider |
roles()
Returns a managed provider instance.
|
RoleProvider |
roleStorageManager() |
UserSessionProvider |
sessions()
Returns a managed provider instance.
|
void |
setAttribute(String name,
Object value) |
ThemeManager |
theme()
Theme manager
|
TokenManager |
tokens()
Token manager
|
UserCache |
userCache()
The user cache
|
UserCredentialManager |
userCredentialManager()
Service that allows you to valid and update credentials for a user
|
UserFederatedStorageProvider |
userFederatedStorage()
Hybrid storage for UserStorageProviders that can't store a specific piece of keycloak data in their external storage.
|
UserProvider |
userLocalStorage()
Keycloak specific local storage for users.
|
UserProvider |
users()
A cached view of all users in system including users loaded by UserStorageProviders
|
UserProvider |
userStorageManager()
Un-cached view of all users in system including users loaded by UserStorageProviders
|
VaultTranscriber |
vault()
Vault transcriber
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getAttributeOrDefault
public DefaultKeycloakSession(DefaultKeycloakSessionFactory factory)
public KeycloakContext getContext()
getContext
in interface KeycloakSession
public UserCache userCache()
KeycloakSession
userCache
in interface KeycloakSession
public void invalidate(InvalidationHandler.InvalidableObjectType type, Object... ids)
KeycloakSession
invalidate
in interface KeycloakSession
invalidate
in interface InvalidationHandler
type
- Type of the objects to invalidateids
- Identifiers of the invalidated objectspublic void enlistForClose(Provider provider)
enlistForClose
in interface KeycloakSession
public Object getAttribute(String attribute)
getAttribute
in interface KeycloakSession
public <T> T getAttribute(String attribute, Class<T> clazz)
getAttribute
in interface KeycloakSession
public Object removeAttribute(String attribute)
removeAttribute
in interface KeycloakSession
public void setAttribute(String name, Object value)
setAttribute
in interface KeycloakSession
public KeycloakTransactionManager getTransactionManager()
getTransactionManager
in interface KeycloakSession
public KeycloakSessionFactory getKeycloakSessionFactory()
getKeycloakSessionFactory
in interface KeycloakSession
public UserFederatedStorageProvider userFederatedStorage()
KeycloakSession
userFederatedStorage
in interface KeycloakSession
public UserProvider userLocalStorage()
KeycloakSession
userLocalStorage
in interface KeycloakSession
public RealmProvider realmLocalStorage()
realmLocalStorage
in interface KeycloakSession
public ClientProvider clientLocalStorage()
KeycloakSession
clientLocalStorage
in interface KeycloakSession
public ClientScopeProvider clientScopeLocalStorage()
KeycloakSession
clientScopeLocalStorage
in interface KeycloakSession
public GroupProvider groupLocalStorage()
KeycloakSession
groupLocalStorage
in interface KeycloakSession
public ClientProvider clientStorageManager()
clientStorageManager
in interface KeycloakSession
public ClientScopeProvider clientScopeStorageManager()
clientScopeStorageManager
in interface KeycloakSession
public RoleProvider roleLocalStorage()
KeycloakSession
roleLocalStorage
in interface KeycloakSession
public RoleProvider roleStorageManager()
roleStorageManager
in interface KeycloakSession
public GroupProvider groupStorageManager()
groupStorageManager
in interface KeycloakSession
public UserProvider userStorageManager()
KeycloakSession
userStorageManager
in interface KeycloakSession
public UserProvider users()
KeycloakSession
users
in interface KeycloakSession
public UserCredentialManager userCredentialManager()
KeycloakSession
userCredentialManager
in interface KeycloakSession
public <T extends Provider> T getProvider(Class<T> clazz)
KeycloakSession
getProvider
in interface KeycloakSession
public <T extends Provider> T getProvider(Class<T> clazz, String id)
KeycloakSession
getProvider
in interface KeycloakSession
public <T extends Provider> T getComponentProvider(Class<T> clazz, String componentId)
KeycloakSession
KeycloakContext.getRealm()
.getComponentProvider
in interface KeycloakSession
componentId
- Component configurationcomponentId
, null
if it cannot be instantiated.public <T extends Provider> T getComponentProvider(Class<T> clazz, String componentId, Function<KeycloakSessionFactory,ComponentModel> modelGetter)
KeycloakSession
KeycloakContext.getRealm()
.getComponentProvider
in interface KeycloakSession
componentId
- Component configurationmodelGetter
- Getter to retrieve componentModelcomponentId
, null
if it cannot be instantiated.public <T extends Provider> T getProvider(Class<T> clazz, ComponentModel componentModel)
getProvider
in interface KeycloakSession
public <T extends Provider> Set<String> listProviderIds(Class<T> clazz)
KeycloakSession
listProviderIds
in interface KeycloakSession
public <T extends Provider> Set<T> getAllProviders(Class<T> clazz)
getAllProviders
in interface KeycloakSession
public Class<? extends Provider> getProviderClass(String providerClassName)
getProviderClass
in interface KeycloakSession
public RealmProvider realms()
KeycloakSession
realms
in interface KeycloakSession
public ClientProvider clients()
KeycloakSession
clients
in interface KeycloakSession
public ClientScopeProvider clientScopes()
KeycloakSession
clientScopes
in interface KeycloakSession
public GroupProvider groups()
KeycloakSession
groups
in interface KeycloakSession
public RoleProvider roles()
KeycloakSession
roles
in interface KeycloakSession
public UserSessionProvider sessions()
KeycloakSession
sessions
in interface KeycloakSession
public UserLoginFailureProvider loginFailures()
KeycloakSession
loginFailures
in interface KeycloakSession
UserLoginFailureProvider
public AuthenticationSessionProvider authenticationSessions()
authenticationSessions
in interface KeycloakSession
public KeyManager keys()
KeycloakSession
keys
in interface KeycloakSession
public ThemeManager theme()
KeycloakSession
theme
in interface KeycloakSession
public TokenManager tokens()
KeycloakSession
tokens
in interface KeycloakSession
public VaultTranscriber vault()
KeycloakSession
vault
in interface KeycloakSession
public ClientPolicyManager clientPolicy()
KeycloakSession
clientPolicy
in interface KeycloakSession
public void close()
close
in interface KeycloakSession
Copyright © 2021 JBoss by Red Hat. All rights reserved.