org.keycloak.models.KeycloakSession インタフェース

org.keycloak.models.KeycloakSession 連携図

公開メンバ関数
KeycloakContext	getContext ()
KeycloakTransactionManager	getTransactionManager ()
< 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)
< T extends Provider > Set< String >	listProviderIds (Class< T > clazz)
< T extends Provider > Set< T >	getAllProviders (Class< T > clazz)
Class<? extends Provider >	getProviderClass (String providerClassName)
Object	getAttribute (String attribute)
< T > T	getAttribute (String attribute, Class< T > clazz)
Object	removeAttribute (String attribute)
void	setAttribute (String name, Object value)
void	enlistForClose (Provider provider)
KeycloakSessionFactory	getKeycloakSessionFactory ()
RealmProvider	realms ()
UserSessionProvider	sessions ()
AuthenticationSessionProvider	authenticationSessions ()
void	close ()
UserCache	userCache ()
UserProvider	users ()
ClientProvider	clientStorageManager ()
UserProvider	userStorageManager ()
UserCredentialManager	userCredentialManager ()
UserProvider	userLocalStorage ()
RealmProvider	realmLocalStorage ()
ClientProvider	clientLocalStorage ()
UserFederatedStorageProvider	userFederatedStorage ()
KeyManager	keys ()
ThemeManager	theme ()
TokenManager	tokens ()

詳解

著者

Bill Burke

バージョン

Revision

1

関数詳解

authenticationSessions()

AuthenticationSessionProvider org.keycloak.models.KeycloakSession.authenticationSessions

(

)

clientLocalStorage()

ClientProvider org.keycloak.models.KeycloakSession.clientLocalStorage

(

)

Keycloak specific local storage for clients. No cache in front, this api talks directly to database configured for Keycloak

戻り値

clientStorageManager()

ClientProvider org.keycloak.models.KeycloakSession.clientStorageManager

(

)

close()

void org.keycloak.models.KeycloakSession.close

(

)

enlistForClose()

void org.keycloak.models.KeycloakSession.enlistForClose

(

Provider

provider

)

getAllProviders()

<T extends Provider> Set<T> org.keycloak.models.KeycloakSession.getAllProviders

(

Class< T >

clazz

)

getAttribute() [1/2]

Object org.keycloak.models.KeycloakSession.getAttribute

(

String

attribute

)

getAttribute() [2/2]

<T> T org.keycloak.models.KeycloakSession.getAttribute	(	String	attribute,
		Class< T >	clazz
	)

getContext()

KeycloakContext org.keycloak.models.KeycloakSession.getContext

(

)

getKeycloakSessionFactory()

KeycloakSessionFactory org.keycloak.models.KeycloakSession.getKeycloakSessionFactory

(

)

getProvider() [1/3]

<T extends Provider> T org.keycloak.models.KeycloakSession.getProvider

(

Class< T >

clazz

)

Get dedicated provider instance of provider type clazz that was created for this session. If one hasn't been created yet, find the factory and allocate by calling ProviderFactory.create(KeycloakSession). The provider to use is determined by the "provider" config entry in keycloak-server boot configuration. (keycloak-server.json)

引数

clazz
<T>

戻り値

getProvider() [2/3]

<T extends Provider> T org.keycloak.models.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. If one hasn't been created yet, find the factory and allocate by calling ProviderFactory.create(KeycloakSession).

引数

clazz
id
<T>

戻り値

getProvider() [3/3]

<T extends Provider> T org.keycloak.models.KeycloakSession.getProvider	(	Class< T >	clazz,
		ComponentModel	componentModel
	)

getProviderClass()

Class<? extends Provider> org.keycloak.models.KeycloakSession.getProviderClass

(

String

providerClassName

)

getTransactionManager()

KeycloakTransactionManager org.keycloak.models.KeycloakSession.getTransactionManager

(

)

keys()

KeyManager org.keycloak.models.KeycloakSession.keys

(

)

Key manager

戻り値

listProviderIds()

<T extends Provider> Set<String> org.keycloak.models.KeycloakSession.listProviderIds

(

Class< T >

clazz

)

Get all provider factories that manage provider instances of class.

引数

clazz
<T>

戻り値

realmLocalStorage()

RealmProvider org.keycloak.models.KeycloakSession.realmLocalStorage

(

)

realms()

RealmProvider org.keycloak.models.KeycloakSession.realms

(

)

Returns a managed provider instance. Will start a provider transaction. This transaction is managed by the KeycloakSession transaction.

戻り値

例外

IllegalStateException

if transaction is not active

removeAttribute()

Object org.keycloak.models.KeycloakSession.removeAttribute

(

String

attribute

)

sessions()

UserSessionProvider org.keycloak.models.KeycloakSession.sessions

(

)

Returns a managed provider instance. Will start a provider transaction. This transaction is managed by the KeycloakSession transaction.

戻り値

例外

IllegalStateException

if transaction is not active

setAttribute()

void org.keycloak.models.KeycloakSession.setAttribute	(	String	name,
		Object	value
	)

theme()

ThemeManager org.keycloak.models.KeycloakSession.theme

(

)

Theme manager

戻り値

tokens()

TokenManager org.keycloak.models.KeycloakSession.tokens

(

)

Token manager

戻り値

userCache()

UserCache org.keycloak.models.KeycloakSession.userCache

(

)

The user cache

戻り値

may be null if cache is disabled

userCredentialManager()

UserCredentialManager org.keycloak.models.KeycloakSession.userCredentialManager

(

)

Service that allows you to valid and update credentials for a user

戻り値

userFederatedStorage()

UserFederatedStorageProvider org.keycloak.models.KeycloakSession.userFederatedStorage

(

)

Hybrid storage for UserStorageProviders that can't store a specific piece of keycloak data in their external storage. No cache in front.

戻り値

userLocalStorage()

UserProvider org.keycloak.models.KeycloakSession.userLocalStorage

(

)

Keycloak specific local storage for users. No cache in front, this api talks directly to database configured for Keycloak

戻り値

users()

UserProvider org.keycloak.models.KeycloakSession.users

(

)

A cached view of all users in system including users loaded by UserStorageProviders

戻り値

userStorageManager()

UserProvider org.keycloak.models.KeycloakSession.userStorageManager

(

)

Un-cached view of all users in system including users loaded by UserStorageProviders

戻り値

---

このインタフェース詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/spi/src/server-spi/src/main/java/org/keycloak/models/KeycloakSession.java