public interface KeycloakSession
Modifier and Type | Method and Description |
---|---|
AuthenticationSessionProvider |
authenticationSessions() |
void |
close() |
void |
enlistForClose(Provider provider) |
<T extends Provider> |
getAllProviders(Class<T> clazz) |
Object |
getAttribute(String attribute) |
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() |
KeyManager |
keys()
Key manager
|
<T extends Provider> |
listProviderIds(Class<T> clazz)
Get all provider factories that manage provider instances of class.
|
RealmProvider |
realms()
Returns a managed provider instance.
|
Object |
removeAttribute(String attribute) |
UserSessionProvider |
sessions()
Returns a managed provider instance.
|
void |
setAttribute(String name,
Object value) |
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
|
KeycloakContext getContext()
KeycloakTransactionManager getTransactionManager()
<T extends Provider> T getProvider(Class<T> clazz)
T
- clazz
- <T extends Provider> T getProvider(Class<T> clazz, String id)
T
- clazz
- id
- <T extends Provider> T getProvider(Class<T> clazz, ComponentModel componentModel)
<T extends Provider> Set<String> listProviderIds(Class<T> clazz)
T
- clazz
- void enlistForClose(Provider provider)
KeycloakSessionFactory getKeycloakSessionFactory()
RealmProvider realms()
IllegalStateException
- if transaction is not activeUserSessionProvider sessions()
IllegalStateException
- if transaction is not activeAuthenticationSessionProvider authenticationSessions()
void close()
UserCache userCache()
UserProvider users()
UserProvider userStorageManager()
UserCredentialManager userCredentialManager()
UserProvider userLocalStorage()
UserFederatedStorageProvider userFederatedStorage()
KeyManager keys()
Copyright © 2018 JBoss by Red Hat. All rights reserved.