keycloak-service
公開メンバ関数 | 関数 | 非公開メンバ関数 | 非公開変数類 | 全メンバ一覧
org.keycloak.services.DefaultKeycloakSession クラス
org.keycloak.services.DefaultKeycloakSession の継承関係図
Inheritance graph
org.keycloak.services.DefaultKeycloakSession 連携図
Collaboration graph

公開メンバ関数

 DefaultKeycloakSession (DefaultKeycloakSessionFactory factory)
 
KeycloakContext getContext ()
 
UserCache userCache ()
 
void enlistForClose (Provider provider)
 
Object getAttribute (String attribute)
 
Object removeAttribute (String attribute)
 
void setAttribute (String name, Object value)
 
KeycloakTransactionManager getTransactionManager ()
 
KeycloakSessionFactory getKeycloakSessionFactory ()
 
UserFederatedStorageProvider userFederatedStorage ()
 
UserProvider userLocalStorage ()
 
RealmProvider realmLocalStorage ()
 
ClientProvider clientLocalStorage ()
 
ClientProvider clientStorageManager ()
 
UserProvider userStorageManager ()
 
UserProvider users ()
 
UserCredentialManager userCredentialManager ()
 
Class<? extends Provider > getProviderClass (String providerClassName)
 
RealmProvider realms ()
 
UserSessionProvider sessions ()
 
AuthenticationSessionProvider authenticationSessions ()
 
KeyManager keys ()
 
ThemeManager theme ()
 
TokenManager tokens ()
 
void close ()
 

関数

public< T > T getAttribute (String attribute, Class< T > clazz)
 
public< T extends Provider > T getProvider (Class< T > clazz)
 
public< T extends Provider > T getProvider (Class< T > clazz, String id)
 
public< T extends Provider > T getProvider (Class< T > clazz, ComponentModel componentModel)
 
public< T extends Provider > Set< String > listProviderIds (Class< T > clazz)
 
public< T extends Provider > Set< T > getAllProviders (Class< T > clazz)
 

非公開メンバ関数

RealmProvider getRealmProvider ()
 

非公開変数類

final DefaultKeycloakSessionFactory factory
 
final Map< Integer, Provider > providers = new HashMap<>()
 
final List< Provider > closable = new LinkedList<Provider>()
 
final DefaultKeycloakTransactionManager transactionManager
 
final Map< String, Object > attributes = new HashMap<>()
 
RealmProvider model
 
UserStorageManager userStorageManager
 
ClientStorageManager clientStorageManager
 
UserCredentialStoreManager userCredentialStorageManager
 
UserSessionProvider sessionProvider
 
AuthenticationSessionProvider authenticationSessionProvider
 
UserFederatedStorageProvider userFederatedStorageProvider
 
KeycloakContext context
 
KeyManager keyManager
 
ThemeManager themeManager
 
TokenManager tokenManager
 

詳解

著者
Stian Thorgersen

構築子と解体子

◆ DefaultKeycloakSession()

org.keycloak.services.DefaultKeycloakSession.DefaultKeycloakSession ( DefaultKeycloakSessionFactory  factory)
inline
75  {
76  this.factory = factory;
77  this.transactionManager = new DefaultKeycloakTransactionManager(this);
78  context = new DefaultKeycloakContext(this);
79  }
KeycloakContext context
Definition: DefaultKeycloakSession.java:70
final DefaultKeycloakSessionFactory factory
Definition: DefaultKeycloakSession.java:58
final DefaultKeycloakTransactionManager transactionManager
Definition: DefaultKeycloakSession.java:61

関数詳解

◆ authenticationSessions()

AuthenticationSessionProvider org.keycloak.services.DefaultKeycloakSession.authenticationSessions ( )
inline
274  {
275  if (authenticationSessionProvider == null) {
276  authenticationSessionProvider = getProvider(AuthenticationSessionProvider.class);
277  }
279  }
AuthenticationSessionProvider authenticationSessionProvider
Definition: DefaultKeycloakSession.java:68
public< T extends Provider > T getProvider(Class< T > clazz)
Definition: DefaultKeycloakSession.java:189

◆ clientLocalStorage()

ClientProvider org.keycloak.services.DefaultKeycloakSession.clientLocalStorage ( )
inline
156  {
157  return realmLocalStorage();
158  }
RealmProvider realmLocalStorage()
Definition: DefaultKeycloakSession.java:151

◆ clientStorageManager()

ClientProvider org.keycloak.services.DefaultKeycloakSession.clientStorageManager ( )
inline
161  {
162  if (clientStorageManager == null) clientStorageManager = new ClientStorageManager(this);
163  return clientStorageManager;
164  }
ClientProvider clientStorageManager()
Definition: DefaultKeycloakSession.java:161

◆ close()

void org.keycloak.services.DefaultKeycloakSession.close ( )
inline
305  {
306  for (Provider p : providers.values()) {
307  try {
308  p.close();
309  } catch (Exception e) {
310  }
311  }
312  for (Provider p : closable) {
313  try {
314  p.close();
315  } catch (Exception e) {
316  }
317  }
318  }
final List< Provider > closable
Definition: DefaultKeycloakSession.java:60
final Map< Integer, Provider > providers
Definition: DefaultKeycloakSession.java:59

◆ enlistForClose()

void org.keycloak.services.DefaultKeycloakSession.enlistForClose ( Provider  provider)
inline
102  {
103  closable.add(provider);
104  }
final List< Provider > closable
Definition: DefaultKeycloakSession.java:60

◆ getAllProviders()

public<T extends Provider> Set<T> org.keycloak.services.DefaultKeycloakSession.getAllProviders ( Class< T >  clazz)
inlinepackage
243  {
244  Set<T> providers = new HashSet<T>();
245  for (String id : listProviderIds(clazz)) {
246  providers.add(getProvider(clazz, id));
247  }
248  return providers;
249  }
public< T extends Provider > Set< String > listProviderIds(Class< T > clazz)
Definition: DefaultKeycloakSession.java:238
final Map< Integer, Provider > providers
Definition: DefaultKeycloakSession.java:59
public< T extends Provider > T getProvider(Class< T > clazz)
Definition: DefaultKeycloakSession.java:189

◆ getAttribute() [1/2]

Object org.keycloak.services.DefaultKeycloakSession.getAttribute ( String  attribute)
inline
107  {
108  return attributes.get(attribute);
109  }
final Map< String, Object > attributes
Definition: DefaultKeycloakSession.java:62

◆ getAttribute() [2/2]

public<T> T org.keycloak.services.DefaultKeycloakSession.getAttribute ( String  attribute,
Class< T >  clazz 
)
inlinepackage
112  {
113  Object value = getAttribute(attribute);
114  return value != null && clazz.isInstance(value) ? (T) value : null;
115  }
Object getAttribute(String attribute)
Definition: DefaultKeycloakSession.java:107

◆ getContext()

KeycloakContext org.keycloak.services.DefaultKeycloakSession.getContext ( )
inline
82  {
83  return context;
84  }
KeycloakContext context
Definition: DefaultKeycloakSession.java:70

◆ getKeycloakSessionFactory()

KeycloakSessionFactory org.keycloak.services.DefaultKeycloakSession.getKeycloakSessionFactory ( )
inline
133  {
134  return factory;
135  }
final DefaultKeycloakSessionFactory factory
Definition: DefaultKeycloakSession.java:58

◆ getProvider() [1/3]

public<T extends Provider> T org.keycloak.services.DefaultKeycloakSession.getProvider ( Class< T >  clazz)
inlinepackage
189  {
190  Integer hash = clazz.hashCode();
191  T provider = (T) providers.get(hash);
192  if (provider == null) {
193  ProviderFactory<T> providerFactory = factory.getProviderFactory(clazz);
194  if (providerFactory != null) {
195  provider = providerFactory.create(this);
196  providers.put(hash, provider);
197  }
198  }
199  return provider;
200  }
public< T extends Provider > ProviderFactory< T > getProviderFactory(Class< T > clazz)
Definition: DefaultKeycloakSessionFactory.java:320
final DefaultKeycloakSessionFactory factory
Definition: DefaultKeycloakSession.java:58
final Map< Integer, Provider > providers
Definition: DefaultKeycloakSession.java:59

◆ getProvider() [2/3]

public<T extends Provider> T org.keycloak.services.DefaultKeycloakSession.getProvider ( Class< T >  clazz,
String  id 
)
inlinepackage
202  {
203  Integer hash = clazz.hashCode() + id.hashCode();
204  T provider = (T) providers.get(hash);
205  if (provider == null) {
206  ProviderFactory<T> providerFactory = factory.getProviderFactory(clazz, id);
207 
208  if (providerFactory != null) {
209  provider = providerFactory.create(this);
210  providers.put(hash, provider);
211  }
212  }
213  return provider;
214  }
public< T extends Provider > ProviderFactory< T > getProviderFactory(Class< T > clazz)
Definition: DefaultKeycloakSessionFactory.java:320
final DefaultKeycloakSessionFactory factory
Definition: DefaultKeycloakSession.java:58
final Map< Integer, Provider > providers
Definition: DefaultKeycloakSession.java:59

◆ getProvider() [3/3]

public<T extends Provider> T org.keycloak.services.DefaultKeycloakSession.getProvider ( Class< T >  clazz,
ComponentModel  componentModel 
)
inlinepackage
217  {
218  String modelId = componentModel.getId();
219 
220  Object found = getAttribute(modelId);
221  if (found != null) {
222  return clazz.cast(found);
223  }
224 
225  ProviderFactory<T> providerFactory = factory.getProviderFactory(clazz, componentModel.getProviderId());
226  if (providerFactory == null) {
227  return null;
228  }
229 
230  ComponentFactory<T, T> componentFactory = (ComponentFactory<T, T>) providerFactory;
231  T provider = componentFactory.create(this, componentModel);
232  enlistForClose(provider);
233  setAttribute(modelId, provider);
234 
235  return provider;
236  }
void setAttribute(String name, Object value)
Definition: DefaultKeycloakSession.java:123
public< T extends Provider > ProviderFactory< T > getProviderFactory(Class< T > clazz)
Definition: DefaultKeycloakSessionFactory.java:320
Object getAttribute(String attribute)
Definition: DefaultKeycloakSession.java:107
final DefaultKeycloakSessionFactory factory
Definition: DefaultKeycloakSession.java:58
void enlistForClose(Provider provider)
Definition: DefaultKeycloakSession.java:102

◆ getProviderClass()

Class<? extends Provider> org.keycloak.services.DefaultKeycloakSession.getProviderClass ( String  providerClassName)
inline
252  {
253  return factory.getProviderClass(providerClassName);
254  }
Class<? extends Provider > getProviderClass(String providerClassName)
Definition: DefaultKeycloakSessionFactory.java:351
final DefaultKeycloakSessionFactory factory
Definition: DefaultKeycloakSession.java:58

◆ getRealmProvider()

RealmProvider org.keycloak.services.DefaultKeycloakSession.getRealmProvider ( )
inlineprivate
86  {
87  CacheRealmProvider cache = getProvider(CacheRealmProvider.class);
88  if (cache != null) {
89  return cache;
90  } else {
91  return getProvider(RealmProvider.class);
92  }
93  }
public< T extends Provider > T getProvider(Class< T > clazz)
Definition: DefaultKeycloakSession.java:189

◆ getTransactionManager()

KeycloakTransactionManager org.keycloak.services.DefaultKeycloakSession.getTransactionManager ( )
inline
128  {
129  return transactionManager;
130  }
final DefaultKeycloakTransactionManager transactionManager
Definition: DefaultKeycloakSession.java:61

◆ keys()

KeyManager org.keycloak.services.DefaultKeycloakSession.keys ( )
inline
282  {
283  if (keyManager == null) {
284  keyManager = new DefaultKeyManager(this);
285  }
286  return keyManager;
287  }
KeyManager keyManager
Definition: DefaultKeycloakSession.java:71

◆ listProviderIds()

public<T extends Provider> Set<String> org.keycloak.services.DefaultKeycloakSession.listProviderIds ( Class< T >  clazz)
inlinepackage
238  {
239  return factory.getAllProviderIds(clazz);
240  }
< T extends Provider > Set< String > getAllProviderIds(Class< T > clazz)
Definition: DefaultKeycloakSessionFactory.java:343
final DefaultKeycloakSessionFactory factory
Definition: DefaultKeycloakSession.java:58

◆ realmLocalStorage()

RealmProvider org.keycloak.services.DefaultKeycloakSession.realmLocalStorage ( )
inline
151  {
152  return getProvider(RealmProvider.class);
153  }
public< T extends Provider > T getProvider(Class< T > clazz)
Definition: DefaultKeycloakSession.java:189

◆ realms()

RealmProvider org.keycloak.services.DefaultKeycloakSession.realms ( )
inline
257  {
258  if (model == null) {
260  }
261  return model;
262  }
RealmProvider model
Definition: DefaultKeycloakSession.java:63
RealmProvider getRealmProvider()
Definition: DefaultKeycloakSession.java:86

◆ removeAttribute()

Object org.keycloak.services.DefaultKeycloakSession.removeAttribute ( String  attribute)
inline
118  {
119  return attributes.remove(attribute);
120  }
final Map< String, Object > attributes
Definition: DefaultKeycloakSession.java:62

◆ sessions()

UserSessionProvider org.keycloak.services.DefaultKeycloakSession.sessions ( )
inline
266  {
267  if (sessionProvider == null) {
268  sessionProvider = getProvider(UserSessionProvider.class);
269  }
270  return sessionProvider;
271  }
UserSessionProvider sessionProvider
Definition: DefaultKeycloakSession.java:67
public< T extends Provider > T getProvider(Class< T > clazz)
Definition: DefaultKeycloakSession.java:189

◆ setAttribute()

void org.keycloak.services.DefaultKeycloakSession.setAttribute ( String  name,
Object  value 
)
inline
123  {
124  attributes.put(name, value);
125  }
final Map< String, Object > attributes
Definition: DefaultKeycloakSession.java:62

◆ theme()

ThemeManager org.keycloak.services.DefaultKeycloakSession.theme ( )
inline
290  {
291  if (themeManager == null) {
292  themeManager = new DefaultThemeManager(this);
293  }
294  return themeManager;
295  }
ThemeManager themeManager
Definition: DefaultKeycloakSession.java:72

◆ tokens()

TokenManager org.keycloak.services.DefaultKeycloakSession.tokens ( )
inline
298  {
299  if (tokenManager == null) {
300  tokenManager = new DefaultTokenManager(this);
301  }
302  return tokenManager;
303  }
TokenManager tokenManager
Definition: DefaultKeycloakSession.java:73

◆ userCache()

UserCache org.keycloak.services.DefaultKeycloakSession.userCache ( )
inline
96  {
97  return getProvider(UserCache.class);
98 
99  }
public< T extends Provider > T getProvider(Class< T > clazz)
Definition: DefaultKeycloakSession.java:189

◆ userCredentialManager()

UserCredentialManager org.keycloak.services.DefaultKeycloakSession.userCredentialManager ( )
inline
184  {
185  if (userCredentialStorageManager == null) userCredentialStorageManager = new UserCredentialStoreManager(this);
187  }
UserCredentialStoreManager userCredentialStorageManager
Definition: DefaultKeycloakSession.java:66

◆ userFederatedStorage()

UserFederatedStorageProvider org.keycloak.services.DefaultKeycloakSession.userFederatedStorage ( )
inline
138  {
139  if (userFederatedStorageProvider == null) {
140  userFederatedStorageProvider = getProvider(UserFederatedStorageProvider.class);
141  }
143  }
UserFederatedStorageProvider userFederatedStorageProvider
Definition: DefaultKeycloakSession.java:69
public< T extends Provider > T getProvider(Class< T > clazz)
Definition: DefaultKeycloakSession.java:189

◆ userLocalStorage()

UserProvider org.keycloak.services.DefaultKeycloakSession.userLocalStorage ( )
inline
146  {
147  return getProvider(UserProvider.class);
148  }
public< T extends Provider > T getProvider(Class< T > clazz)
Definition: DefaultKeycloakSession.java:189

◆ users()

UserProvider org.keycloak.services.DefaultKeycloakSession.users ( )
inline
174  {
175  UserCache cache = getProvider(UserCache.class);
176  if (cache != null) {
177  return cache;
178  } else {
179  return userStorageManager();
180  }
181  }
UserProvider userStorageManager()
Definition: DefaultKeycloakSession.java:168
public< T extends Provider > T getProvider(Class< T > clazz)
Definition: DefaultKeycloakSession.java:189

◆ userStorageManager()

UserProvider org.keycloak.services.DefaultKeycloakSession.userStorageManager ( )
inline
168  {
169  if (userStorageManager == null) userStorageManager = new UserStorageManager(this);
170  return userStorageManager;
171  }
UserProvider userStorageManager()
Definition: DefaultKeycloakSession.java:168

メンバ詳解

◆ attributes

final Map<String, Object> org.keycloak.services.DefaultKeycloakSession.attributes = new HashMap<>()
private

◆ authenticationSessionProvider

AuthenticationSessionProvider org.keycloak.services.DefaultKeycloakSession.authenticationSessionProvider
private

◆ clientStorageManager

ClientStorageManager org.keycloak.services.DefaultKeycloakSession.clientStorageManager
private

◆ closable

final List<Provider> org.keycloak.services.DefaultKeycloakSession.closable = new LinkedList<Provider>()
private

◆ context

KeycloakContext org.keycloak.services.DefaultKeycloakSession.context
private

◆ factory

final DefaultKeycloakSessionFactory org.keycloak.services.DefaultKeycloakSession.factory
private

◆ keyManager

KeyManager org.keycloak.services.DefaultKeycloakSession.keyManager
private

◆ model

RealmProvider org.keycloak.services.DefaultKeycloakSession.model
private

◆ providers

final Map<Integer, Provider> org.keycloak.services.DefaultKeycloakSession.providers = new HashMap<>()
private

◆ sessionProvider

UserSessionProvider org.keycloak.services.DefaultKeycloakSession.sessionProvider
private

◆ themeManager

ThemeManager org.keycloak.services.DefaultKeycloakSession.themeManager
private

◆ tokenManager

TokenManager org.keycloak.services.DefaultKeycloakSession.tokenManager
private

◆ transactionManager

final DefaultKeycloakTransactionManager org.keycloak.services.DefaultKeycloakSession.transactionManager
private

◆ userCredentialStorageManager

UserCredentialStoreManager org.keycloak.services.DefaultKeycloakSession.userCredentialStorageManager
private

◆ userFederatedStorageProvider

UserFederatedStorageProvider org.keycloak.services.DefaultKeycloakSession.userFederatedStorageProvider
private

◆ userStorageManager

UserStorageManager org.keycloak.services.DefaultKeycloakSession.userStorageManager
private

このクラス詳解は次のファイルから抽出されました: