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

org.keycloak.models.UserSessionModel の継承関係図

org.keycloak.models.UserSessionModel 連携図

クラス
enum	State

公開メンバ関数
String	getId ()
RealmModel	getRealm ()
String	getBrokerSessionId ()
String	getBrokerUserId ()
UserModel	getUser ()
String	getLoginUsername ()
String	getIpAddress ()
String	getAuthMethod ()
boolean	isRememberMe ()
int	getStarted ()
int	getLastSessionRefresh ()
void	setLastSessionRefresh (int seconds)
boolean	isOffline ()
Map< String, AuthenticatedClientSessionModel >	getAuthenticatedClientSessions ()
default AuthenticatedClientSessionModel	getAuthenticatedClientSessionByClient (String clientUUID)
void	removeAuthenticatedClientSessions (Collection< String > removedClientUUIDS)
String	getNote (String name)
void	setNote (String name, String value)
void	removeNote (String name)
Map< String, String >	getNotes ()
State	getState ()
void	setState (State state)
void	restartSession (RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId)

詳解

著者

Stian Thorgersen

---

クラス詳解

org::keycloak::models::UserSessionModel::State

enum org::keycloak::models::UserSessionModel::State

org.keycloak.models.UserSessionModel.State 連携図

列挙値
LOGGED_IN
LOGGED_OUT
LOGGING_OUT

関数詳解

getAuthenticatedClientSessionByClient()

default AuthenticatedClientSessionModel org.keycloak.models.UserSessionModel.getAuthenticatedClientSessionByClient ( String  clientUUID )

inline

Returns a client session for the given client UUID.

戻り値

                                                                                                     {
        return getAuthenticatedClientSessions().get(clientUUID);
    };

getAuthenticatedClientSessions()

Map<String, AuthenticatedClientSessionModel> org.keycloak.models.UserSessionModel.getAuthenticatedClientSessions

(

)

Returns map where key is ID of the client (its UUID) and value is ID respective AuthenticatedClientSessionModel object.

戻り値

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

getAuthMethod()

String org.keycloak.models.UserSessionModel.getAuthMethod

(

)

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

getBrokerSessionId()

String org.keycloak.models.UserSessionModel.getBrokerSessionId

(

)

If created via a broker external login, this is an identifier that can be used to match external broker backchannel logout requests to a UserSession

戻り値

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

getBrokerUserId()

String org.keycloak.models.UserSessionModel.getBrokerUserId

(

)

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

getId()

String org.keycloak.models.UserSessionModel.getId

(

)

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

getIpAddress()

String org.keycloak.models.UserSessionModel.getIpAddress

(

)

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

getLastSessionRefresh()

int org.keycloak.models.UserSessionModel.getLastSessionRefresh

(

)

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

getLoginUsername()

String org.keycloak.models.UserSessionModel.getLoginUsername

(

)

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

getNote()

String org.keycloak.models.UserSessionModel.getNote

(

String

name

)

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

getNotes()

Map<String, String> org.keycloak.models.UserSessionModel.getNotes

(

)

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

getRealm()

RealmModel org.keycloak.models.UserSessionModel.getRealm

(

)

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

getStarted()

int org.keycloak.models.UserSessionModel.getStarted

(

)

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

getState()

State org.keycloak.models.UserSessionModel.getState

(

)

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

getUser()

UserModel org.keycloak.models.UserSessionModel.getUser

(

)

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

isOffline()

boolean org.keycloak.models.UserSessionModel.isOffline

(

)

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

isRememberMe()

boolean org.keycloak.models.UserSessionModel.isRememberMe

(

)

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

removeAuthenticatedClientSessions()

void org.keycloak.models.UserSessionModel.removeAuthenticatedClientSessions

(

Collection< String >

removedClientUUIDS

)

Removes authenticated client sessions for all clients whose UUID is present in

removedClientUUIDS 

parameter.

引数

removedClientUUIDS

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

removeNote()

void org.keycloak.models.UserSessionModel.removeNote

(

String

name

)

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

restartSession()

void org.keycloak.models.UserSessionModel.restartSession	(	RealmModel	realm,
		UserModel	user,
		String	loginUsername,
		String	ipAddress,
		String	authMethod,
		boolean	rememberMe,
		String	brokerSessionId,
		String	brokerUserId
	)

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

setLastSessionRefresh()

void org.keycloak.models.UserSessionModel.setLastSessionRefresh

(

int

seconds

)

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

setNote()

void org.keycloak.models.UserSessionModel.setNote	(	String	name,
		String	value
	)

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

setState()

void org.keycloak.models.UserSessionModel.setState

(

State

state

)

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

---

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

• D:/AppData/doxygen/keycloak/oidc-service/src/main/java/org/keycloak/models/UserSessionModel.java