Package org.keycloak.services

Class DefaultKeycloakSession

java.lang.Object

org.keycloak.services.DefaultKeycloakSession

All Implemented Interfaces:

AutoCloseable, KeycloakSession

public abstract class DefaultKeycloakSession
extends Object
implements KeycloakSession

Author:

Stian Thorgersen

Constructor Summary

Constructors

Constructor	Description
DefaultKeycloakSession(DefaultKeycloakSessionFactory factory)

Method Summary

Modifier and Type	Method	Description
AuthenticationSessionProvider	authenticationSessions()
ClientPolicyManager	clientPolicy()
ClientProvider	clients()
ClientScopeProvider	clientScopes()
void	close()
protected RuntimeException	closeTransactionManager()
protected abstract DefaultKeycloakContext	createKeycloakContext(KeycloakSession session)
void	enlistForClose(Provider provider)
<T extends Provider> Set<T>	getAllProviders(Class<T> clazz)
Object	getAttribute(String attribute)
<T> T	getAttribute(String attribute, Class<T> clazz)
Map<String,Object>	getAttributes()
<T extends Provider> T	getComponentProvider(Class<T> clazz, String componentId)
<T extends Provider> T	getComponentProvider(Class<T> clazz, String componentId, Function<KeycloakSessionFactory,ComponentModel> modelGetter)
KeycloakContext	getContext()
KeycloakSessionFactory	getKeycloakSessionFactory()
<T extends Provider> T	getProvider(Class<T> clazz)
<T extends Provider> T	getProvider(Class<T> clazz, String id)
<T extends Provider> T	getProvider(Class<T> clazz, ComponentModel componentModel)
Class<? extends Provider>	getProviderClass(String providerClassName)
KeycloakTransactionManager	getTransactionManager()
GroupProvider	groups()
IdentityProviderStorageProvider	identityProviders()
void	invalidate(InvalidationHandler.InvalidableObjectType type, Object... ids)
boolean	isClosed()
KeyManager	keys()
<T extends Provider> Set<String>	listProviderIds(Class<T> clazz)
UserLoginFailureProvider	loginFailures()
RealmProvider	realms()
Object	removeAttribute(String attribute)
RoleProvider	roles()
UserSessionProvider	sessions()
void	setAttribute(String name, Object value)
SingleUseObjectProvider	singleUseObjects()
ThemeManager	theme()
TokenManager	tokens()
String	toString()
UserProvider	users()
VaultTranscriber	vault()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.models.KeycloakSession

getAttributeOrDefault

Constructor Details

DefaultKeycloakSession

public DefaultKeycloakSession(DefaultKeycloakSessionFactory factory)

Method Details

getContext

public KeycloakContext getContext()

Specified by:

getContext in interface KeycloakSession

invalidate

public void invalidate(InvalidationHandler.InvalidableObjectType type,
 Object... ids)

Specified by:

invalidate in interface KeycloakSession

enlistForClose

public void enlistForClose(Provider provider)

Specified by:

enlistForClose in interface KeycloakSession

getAttribute

public Object getAttribute(String attribute)

Specified by:

getAttribute in interface KeycloakSession

getAttribute

public <T> T getAttribute(String attribute,
 Class<T> clazz)

Specified by:

getAttribute in interface KeycloakSession

removeAttribute

public Object removeAttribute(String attribute)

Specified by:

removeAttribute in interface KeycloakSession

setAttribute

public void setAttribute(String name,
 Object value)

Specified by:

setAttribute in interface KeycloakSession

getAttributes

public Map<String,Object> getAttributes()

Specified by:

getAttributes in interface KeycloakSession

getTransactionManager

public KeycloakTransactionManager getTransactionManager()

Specified by:

getTransactionManager in interface KeycloakSession

getKeycloakSessionFactory

public KeycloakSessionFactory getKeycloakSessionFactory()

Specified by:

getKeycloakSessionFactory in interface KeycloakSession

users

public UserProvider users()

Specified by:

users in interface KeycloakSession

getProvider

public <T extends Provider> T getProvider(Class<T> clazz)

Specified by:

getProvider in interface KeycloakSession

getProvider

public <T extends Provider> T getProvider(Class<T> clazz,
 String id)

Specified by:

getProvider in interface KeycloakSession

getComponentProvider

public <T extends Provider> T getComponentProvider(Class<T> clazz,
 String componentId)

Specified by:

getComponentProvider in interface KeycloakSession

getComponentProvider

public <T extends Provider> T getComponentProvider(Class<T> clazz,
 String componentId,
 Function<KeycloakSessionFactory,ComponentModel> modelGetter)

Specified by:

getComponentProvider in interface KeycloakSession

getProvider

public <T extends Provider> T getProvider(Class<T> clazz,
 ComponentModel componentModel)

Specified by:

getProvider in interface KeycloakSession

listProviderIds

public <T extends Provider> Set<String> listProviderIds(Class<T> clazz)

Specified by:

listProviderIds in interface KeycloakSession

getAllProviders

public <T extends Provider> Set<T> getAllProviders(Class<T> clazz)

Specified by:

getAllProviders in interface KeycloakSession

getProviderClass

public Class<? extends Provider> getProviderClass(String providerClassName)

Specified by:

getProviderClass in interface KeycloakSession

realms

public RealmProvider realms()

Specified by:

realms in interface KeycloakSession

clients

public ClientProvider clients()

Specified by:

clients in interface KeycloakSession

clientScopes

public ClientScopeProvider clientScopes()

Specified by:

clientScopes in interface KeycloakSession

groups

public GroupProvider groups()

Specified by:

groups in interface KeycloakSession

roles

public RoleProvider roles()

Specified by:

roles in interface KeycloakSession

sessions

public UserSessionProvider sessions()

Specified by:

sessions in interface KeycloakSession

loginFailures

public UserLoginFailureProvider loginFailures()

Specified by:

loginFailures in interface KeycloakSession

authenticationSessions

public AuthenticationSessionProvider authenticationSessions()

Specified by:

authenticationSessions in interface KeycloakSession

singleUseObjects

public SingleUseObjectProvider singleUseObjects()

Specified by:

singleUseObjects in interface KeycloakSession

identityProviders

public IdentityProviderStorageProvider identityProviders()

Specified by:

identityProviders in interface KeycloakSession

keys

public KeyManager keys()

Specified by:

keys in interface KeycloakSession

theme

public ThemeManager theme()

Specified by:

theme in interface KeycloakSession

tokens

public TokenManager tokens()

Specified by:

tokens in interface KeycloakSession

vault

public VaultTranscriber vault()

Specified by:

vault in interface KeycloakSession

clientPolicy

public ClientPolicyManager clientPolicy()

Specified by:

clientPolicy in interface KeycloakSession

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface KeycloakSession

closeTransactionManager

protected RuntimeException closeTransactionManager()

toString

public String toString()

Overrides:

toString in class Object

createKeycloakContext

protected abstract DefaultKeycloakContext createKeycloakContext(KeycloakSession session)

isClosed

public boolean isClosed()

Specified by:

isClosed in interface KeycloakSession