org.keycloak.sessions.AuthenticationSessionModel の継承関係図

org.keycloak.sessions.AuthenticationSessionModel 連携図

公開メンバ関数
String	getTabId ()

RootAuthenticationSessionModel	getParentSession ()

Map< String, ExecutionStatus >	getExecutionStatus ()

void	setExecutionStatus (String authenticator, ExecutionStatus status)

void	clearExecutionStatus ()

UserModel	getAuthenticatedUser ()

void	setAuthenticatedUser (UserModel user)

Set< String >	getRequiredActions ()

void	addRequiredAction (String action)

void	removeRequiredAction (String action)

void	addRequiredAction (UserModel.RequiredAction action)

void	removeRequiredAction (UserModel.RequiredAction action)

void	setUserSessionNote (String name, String value)

Map< String, String >	getUserSessionNotes ()

void	clearUserSessionNotes ()

String	getAuthNote (String name)

void	setAuthNote (String name, String value)

void	removeAuthNote (String name)

void	clearAuthNotes ()

String	getClientNote (String name)

void	setClientNote (String name, String value)

void	removeClientNote (String name)

Map< String, String >	getClientNotes ()

void	clearClientNotes ()

Set< String >	getClientScopes ()

void	setClientScopes (Set< String > clientScopes)

String	getRedirectUri ()

void	setRedirectUri (String uri)

RealmModel	getRealm ()

ClientModel	getClient ()

String	getAction ()

void	setAction (String action)

String	getProtocol ()

void	setProtocol (String method)

詳解

Represents the state of the authentication. If the login is requested from different tabs of same browser, every browser tab has it's own state of the authentication. So there is separate AuthenticationSessionModel for every tab. Whole browser is represented by RootAuthenticationSessionModel

著者: Marek Posolda

関数詳解

◆ addRequiredAction() [1/2]

void org.keycloak.sessions.AuthenticationSessionModel.addRequiredAction ( String action )

◆ addRequiredAction() [2/2]

void org.keycloak.sessions.AuthenticationSessionModel.addRequiredAction ( UserModel.RequiredAction action )

◆ clearAuthNotes()

void org.keycloak.sessions.AuthenticationSessionModel.clearAuthNotes ( )

Clears all authentication note. Authentication notes are notes used typically by authenticators and authentication flows. They are cleared when authentication session is restarted

◆ clearClientNotes()

void org.keycloak.sessions.AuthenticationSessionModel.clearClientNotes ( )

Clears all client notes. Client notes are notes specific to client protocol. They are NOT cleared when authentication session is restarted.

◆ clearExecutionStatus()

void org.keycloak.sessions.AuthenticationSessionModel.clearExecutionStatus ( )

◆ clearUserSessionNotes()

void org.keycloak.sessions.AuthenticationSessionModel.clearUserSessionNotes ( )

Clears all user session notes. User session notes are notes you want be applied to the UserSessionModel when the client session is attached to it.

◆ getAction()

String org.keycloak.sessions.CommonClientSessionModel.getAction ( )

inherited

org.keycloak.models.session.PersistentAuthenticatedClientSessionAdapterで実装されています。

◆ getAuthenticatedUser()

UserModel org.keycloak.sessions.AuthenticationSessionModel.getAuthenticatedUser ( )

◆ getAuthNote()

String org.keycloak.sessions.AuthenticationSessionModel.getAuthNote ( String name )

Retrieves value of the given authentication note to the given value. Authentication notes are notes used typically by authenticators and authentication flows. They are cleared when authentication session is restarted

◆ getClient()

ClientModel org.keycloak.sessions.CommonClientSessionModel.getClient ( )

inherited

org.keycloak.models.session.PersistentAuthenticatedClientSessionAdapterで実装されています。

◆ getClientNote()

String org.keycloak.sessions.AuthenticationSessionModel.getClientNote ( String name )

Retrieves value of the given client note to the given value. Client notes are notes specific to client protocol. They are NOT cleared when authentication session is restarted.

◆ getClientNotes()

Map<String, String> org.keycloak.sessions.AuthenticationSessionModel.getClientNotes ( )

Retrieves the (name, value) map of client notes. Client notes are notes specific to client protocol. They are NOT cleared when authentication session is restarted.

◆ getClientScopes()

Set<String> org.keycloak.sessions.AuthenticationSessionModel.getClientScopes ( )

Get client scope IDs

◆ getExecutionStatus()

Map<String, ExecutionStatus> org.keycloak.sessions.AuthenticationSessionModel.getExecutionStatus ( )

◆ getParentSession()

RootAuthenticationSessionModel org.keycloak.sessions.AuthenticationSessionModel.getParentSession ( )

◆ getProtocol()

String org.keycloak.sessions.CommonClientSessionModel.getProtocol ( )

inherited

org.keycloak.models.session.PersistentAuthenticatedClientSessionAdapterで実装されています。

◆ getRealm()

RealmModel org.keycloak.sessions.CommonClientSessionModel.getRealm ( )

inherited

org.keycloak.models.session.PersistentAuthenticatedClientSessionAdapterで実装されています。

◆ getRedirectUri()

String org.keycloak.sessions.CommonClientSessionModel.getRedirectUri ( )

inherited

org.keycloak.models.session.PersistentAuthenticatedClientSessionAdapterで実装されています。

◆ getRequiredActions()

Set<String> org.keycloak.sessions.AuthenticationSessionModel.getRequiredActions ( )

Required actions that are attached to this client session.

戻り値

◆ getTabId()

String org.keycloak.sessions.AuthenticationSessionModel.getTabId ( )

戻り値: ID of this subsession (in other words, usually browser tab). For lookup the AuthenticationSessionModel, you need: ID of rootSession (parent), client UUID and tabId. For lookup the ID of the parent, use getParentSession().getId()

◆ getUserSessionNotes()

Map<String, String> org.keycloak.sessions.AuthenticationSessionModel.getUserSessionNotes ( )

Retrieves value of given user session note. User session notes are notes you want be applied to the UserSessionModel when the client session is attached to it.

◆ removeAuthNote()

void org.keycloak.sessions.AuthenticationSessionModel.removeAuthNote ( String name )

Removes the given authentication note. Authentication notes are notes used typically by authenticators and authentication flows. They are cleared when authentication session is restarted

◆ removeClientNote()

void org.keycloak.sessions.AuthenticationSessionModel.removeClientNote ( String name )

Removes the given client note. Client notes are notes specific to client protocol. They are NOT cleared when authentication session is restarted.

◆ removeRequiredAction() [1/2]

void org.keycloak.sessions.AuthenticationSessionModel.removeRequiredAction ( String action )

◆ removeRequiredAction() [2/2]

void org.keycloak.sessions.AuthenticationSessionModel.removeRequiredAction ( UserModel.RequiredAction action )

◆ setAction()

void org.keycloak.sessions.CommonClientSessionModel.setAction ( String action )

inherited

org.keycloak.models.session.PersistentAuthenticatedClientSessionAdapterで実装されています。

◆ setAuthenticatedUser()

void org.keycloak.sessions.AuthenticationSessionModel.setAuthenticatedUser ( UserModel user )

◆ setAuthNote()

void org.keycloak.sessions.AuthenticationSessionModel.setAuthNote	(	String	name,
		String	value
	)

Sets the given authentication note to the given value. Authentication notes are notes used typically by authenticators and authentication flows. They are cleared when authentication session is restarted

◆ setClientNote()

void org.keycloak.sessions.AuthenticationSessionModel.setClientNote	(	String	name,
		String	value
	)

Sets the given client note to the given value. Client notes are notes specific to client protocol. They are NOT cleared when authentication session is restarted.

◆ setClientScopes()

void org.keycloak.sessions.AuthenticationSessionModel.setClientScopes ( Set< String > clientScopes )

Set client scope IDs

◆ setExecutionStatus()

void org.keycloak.sessions.AuthenticationSessionModel.setExecutionStatus	(	String	authenticator,
		ExecutionStatus	status
	)

◆ setProtocol()

void org.keycloak.sessions.CommonClientSessionModel.setProtocol ( String method )

inherited

org.keycloak.models.session.PersistentAuthenticatedClientSessionAdapterで実装されています。

◆ setRedirectUri()

void org.keycloak.sessions.CommonClientSessionModel.setRedirectUri ( String uri )

inherited

org.keycloak.models.session.PersistentAuthenticatedClientSessionAdapterで実装されています。

◆ setUserSessionNote()

void org.keycloak.sessions.AuthenticationSessionModel.setUserSessionNote	(	String	name,
		String	value
	)

Sets the given user session note to the given value. User session notes are notes you want be applied to the UserSessionModel when the client session is attached to it.

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

D:/AppData/doxygen/keycloak/oidc-service/src/main/java/org/keycloak/sessions/AuthenticationSessionModel.java

公開メンバ関数

詳解

関数詳解

◆ addRequiredAction() [1/2]

◆ addRequiredAction() [2/2]

◆ clearAuthNotes()

◆ clearClientNotes()

◆ clearExecutionStatus()

◆ clearUserSessionNotes()

◆ getAction()

◆ getAuthenticatedUser()

◆ getAuthNote()

◆ getClient()

◆ getClientNote()

◆ getClientNotes()

◆ getClientScopes()

◆ getExecutionStatus()

◆ getParentSession()

◆ getProtocol()

◆ getRealm()

◆ getRedirectUri()

◆ getRequiredActions()

◆ getTabId()

◆ getUserSessionNotes()

◆ removeAuthNote()

◆ removeClientNote()

◆ removeRequiredAction() [1/2]

◆ removeRequiredAction() [2/2]

◆ setAction()

◆ setAuthenticatedUser()

◆ setAuthNote()

◆ setClientNote()

◆ setClientScopes()

◆ setExecutionStatus()

◆ setProtocol()

◆ setRedirectUri()

◆ setUserSessionNote()