keycloak
公開メンバ関数 | 限定公開変数類 | 非公開メンバ関数 | 全メンバ一覧
org.keycloak.authentication.RequiredActionContextResult クラス
org.keycloak.authentication.RequiredActionContextResult の継承関係図
Inheritance graph
org.keycloak.authentication.RequiredActionContextResult 連携図
Collaboration graph

公開メンバ関数

 RequiredActionContextResult (AuthenticationSessionModel authSession, RealmModel realm, EventBuilder eventBuilder, KeycloakSession session, HttpRequest httpRequest, UserModel user, RequiredActionFactory factory)
 
RequiredActionFactory getFactory ()
 
EventBuilder getEvent ()
 
UserModel getUser ()
 
RealmModel getRealm ()
 
AuthenticationSessionModel getAuthenticationSession ()
 
ClientConnection getConnection ()
 
UriInfo getUriInfo ()
 
KeycloakSession getSession ()
 
HttpRequest getHttpRequest ()
 
Status getStatus ()
 
void challenge (Response response)
 
void failure ()
 
void success ()
 
void ignore ()
 
URI getActionUrl (String code)
 
String generateCode ()
 
URI getActionUrl ()
 
URI getActionUrl (boolean authSessionIdParam)
 
LoginFormsProvider form ()
 
Response getChallenge ()
 

限定公開変数類

AuthenticationSessionModel authenticationSession
 
RealmModel realm
 
EventBuilder eventBuilder
 
KeycloakSession session
 
Status status
 
Response challenge
 
HttpRequest httpRequest
 
UserModel user
 
RequiredActionFactory factory
 

非公開メンバ関数

String getExecution ()
 

詳解

著者
Bill Burke
バージョン
Revision
1

構築子と解体子

◆ RequiredActionContextResult()

org.keycloak.authentication.RequiredActionContextResult.RequiredActionContextResult ( AuthenticationSessionModel  authSession,
RealmModel  realm,
EventBuilder  eventBuilder,
KeycloakSession  session,
HttpRequest  httpRequest,
UserModel  user,
RequiredActionFactory  factory 
)
inline
58  {
59  this.authenticationSession = authSession;
60  this.realm = realm;
62  this.session = session;
63  this.httpRequest = httpRequest;
64  this.user = user;
65  this.factory = factory;
66  }
KeycloakSession session
Definition: RequiredActionContextResult.java:48
RealmModel realm
Definition: RequiredActionContextResult.java:46
HttpRequest httpRequest
Definition: RequiredActionContextResult.java:51
UserModel user
Definition: RequiredActionContextResult.java:52
EventBuilder eventBuilder
Definition: RequiredActionContextResult.java:47
AuthenticationSessionModel authenticationSession
Definition: RequiredActionContextResult.java:45
RequiredActionFactory factory
Definition: RequiredActionContextResult.java:53

関数詳解

◆ challenge()

void org.keycloak.authentication.RequiredActionContextResult.challenge ( Response  response)
inline

org.keycloak.authentication.RequiredActionContextを実装しています。

118  {
119  status = Status.CHALLENGE;
120  challenge = response;
121 
122  }
Response challenge
Definition: RequiredActionContextResult.java:50
Status status
Definition: RequiredActionContextResult.java:49
CHALLENGE
Definition: RequiredActionContext.java:41

◆ failure()

void org.keycloak.authentication.RequiredActionContextResult.failure ( )
inline

org.keycloak.authentication.RequiredActionContextを実装しています。

125  {
126  status = Status.FAILURE;
127  }
Status status
Definition: RequiredActionContextResult.java:49
FAILURE
Definition: RequiredActionContext.java:44

◆ form()

LoginFormsProvider org.keycloak.authentication.RequiredActionContextResult.form ( )
inline

org.keycloak.authentication.RequiredActionContextを実装しています。

180  {
181  String accessCode = generateCode();
182  URI action = getActionUrl(accessCode);
183  LoginFormsProvider provider = getSession().getProvider(LoginFormsProvider.class)
184  .setAuthenticationSession(getAuthenticationSession())
185  .setUser(getUser())
186  .setActionUri(action)
187  .setExecution(getExecution())
188  .setClientSessionCode(accessCode);
189  return provider;
190  }
URI getActionUrl()
Definition: RequiredActionContextResult.java:164
AuthenticationSessionModel getAuthenticationSession()
Definition: RequiredActionContextResult.java:88
String generateCode()
Definition: RequiredActionContextResult.java:156
< T extends Provider > T getProvider(Class< T > clazz)
UserModel getUser()
Definition: RequiredActionContextResult.java:78
KeycloakSession getSession()
Definition: RequiredActionContextResult.java:103
String getExecution()
Definition: RequiredActionContextResult.java:151

◆ generateCode()

String org.keycloak.authentication.RequiredActionContextResult.generateCode ( )
inline

org.keycloak.authentication.RequiredActionContextを実装しています。

156  {
157  ClientSessionCode<AuthenticationSessionModel> accessCode = new ClientSessionCode<>(session, getRealm(), getAuthenticationSession());
159  return accessCode.getOrGenerateCode();
160  }
KeycloakSession session
Definition: RequiredActionContextResult.java:48
AuthenticationSessionModel getAuthenticationSession()
Definition: RequiredActionContextResult.java:88
RootAuthenticationSessionModel getParentSession()
AuthenticationSessionModel authenticationSession
Definition: RequiredActionContextResult.java:45
RealmModel getRealm()
Definition: RequiredActionContextResult.java:83

◆ getActionUrl() [1/3]

URI org.keycloak.authentication.RequiredActionContextResult.getActionUrl ( String  code)
inline

org.keycloak.authentication.RequiredActionContextを実装しています。

141  {
142  ClientModel client = authenticationSession.getClient();
143  return LoginActionsService.requiredActionProcessor(getUriInfo())
144  .queryParam(LoginActionsService.SESSION_CODE, code)
145  .queryParam(Constants.EXECUTION, getExecution())
146  .queryParam(Constants.CLIENT_ID, client.getClientId())
147  .queryParam(Constants.TAB_ID, authenticationSession.getTabId())
148  .build(getRealm().getName());
149  }
UriInfo getUriInfo()
Definition: RequiredActionContextResult.java:98
AuthenticationSessionModel authenticationSession
Definition: RequiredActionContextResult.java:45
String getExecution()
Definition: RequiredActionContextResult.java:151
RealmModel getRealm()
Definition: RequiredActionContextResult.java:83

◆ getActionUrl() [2/3]

URI org.keycloak.authentication.RequiredActionContextResult.getActionUrl ( )
inline

org.keycloak.authentication.RequiredActionContextを実装しています。

164  {
165  String accessCode = generateCode();
166  return getActionUrl(accessCode);
167 
168  }
URI getActionUrl()
Definition: RequiredActionContextResult.java:164
String generateCode()
Definition: RequiredActionContextResult.java:156

◆ getActionUrl() [3/3]

URI org.keycloak.authentication.RequiredActionContextResult.getActionUrl ( boolean  authSessionIdParam)
inline

org.keycloak.authentication.RequiredActionContextを実装しています。

171  {
172  URI uri = getActionUrl();
173  if (authSessionIdParam) {
174  uri = UriBuilder.fromUri(uri).queryParam(LoginActionsService.AUTH_SESSION_ID, getAuthenticationSession().getParentSession().getId()).build();
175  }
176  return uri;
177  }
URI getActionUrl()
Definition: RequiredActionContextResult.java:164
AuthenticationSessionModel getAuthenticationSession()
Definition: RequiredActionContextResult.java:88

◆ getAuthenticationSession()

AuthenticationSessionModel org.keycloak.authentication.RequiredActionContextResult.getAuthenticationSession ( )
inline

org.keycloak.authentication.RequiredActionContextを実装しています。

88  {
89  return authenticationSession;
90  }
AuthenticationSessionModel authenticationSession
Definition: RequiredActionContextResult.java:45

◆ getChallenge()

Response org.keycloak.authentication.RequiredActionContextResult.getChallenge ( )
inline

org.keycloak.authentication.RequiredActionContextを実装しています。

194  {
195  return challenge;
196  }
Response challenge
Definition: RequiredActionContextResult.java:50

◆ getConnection()

ClientConnection org.keycloak.authentication.RequiredActionContextResult.getConnection ( )
inline

org.keycloak.authentication.RequiredActionContextを実装しています。

93  {
94  return session.getContext().getConnection();
95  }
KeycloakSession session
Definition: RequiredActionContextResult.java:48

◆ getEvent()

EventBuilder org.keycloak.authentication.RequiredActionContextResult.getEvent ( )
inline

org.keycloak.authentication.RequiredActionContextを実装しています。

73  {
74  return eventBuilder;
75  }
EventBuilder eventBuilder
Definition: RequiredActionContextResult.java:47

◆ getExecution()

String org.keycloak.authentication.RequiredActionContextResult.getExecution ( )
inlineprivate
151  {
152  return factory.getId();
153  }
RequiredActionFactory factory
Definition: RequiredActionContextResult.java:53

◆ getFactory()

RequiredActionFactory org.keycloak.authentication.RequiredActionContextResult.getFactory ( )
inline
68  {
69  return factory;
70  }
RequiredActionFactory factory
Definition: RequiredActionContextResult.java:53

◆ getHttpRequest()

HttpRequest org.keycloak.authentication.RequiredActionContextResult.getHttpRequest ( )
inline

org.keycloak.authentication.RequiredActionContextを実装しています。

108  {
109  return httpRequest;
110  }
HttpRequest httpRequest
Definition: RequiredActionContextResult.java:51

◆ getRealm()

RealmModel org.keycloak.authentication.RequiredActionContextResult.getRealm ( )
inline

org.keycloak.authentication.RequiredActionContextを実装しています。

83  {
84  return realm;
85  }
RealmModel realm
Definition: RequiredActionContextResult.java:46

◆ getSession()

KeycloakSession org.keycloak.authentication.RequiredActionContextResult.getSession ( )
inline

org.keycloak.authentication.RequiredActionContextを実装しています。

103  {
104  return session;
105  }
KeycloakSession session
Definition: RequiredActionContextResult.java:48

◆ getStatus()

Status org.keycloak.authentication.RequiredActionContextResult.getStatus ( )
inline

org.keycloak.authentication.RequiredActionContextを実装しています。

113  {
114  return status;
115  }
Status status
Definition: RequiredActionContextResult.java:49

◆ getUriInfo()

UriInfo org.keycloak.authentication.RequiredActionContextResult.getUriInfo ( )
inline

org.keycloak.authentication.RequiredActionContextを実装しています。

98  {
99  return session.getContext().getUri();
100  }
KeycloakSession session
Definition: RequiredActionContextResult.java:48

◆ getUser()

UserModel org.keycloak.authentication.RequiredActionContextResult.getUser ( )
inline

org.keycloak.authentication.RequiredActionContextを実装しています。

78  {
79  return user;
80  }
UserModel user
Definition: RequiredActionContextResult.java:52

◆ ignore()

void org.keycloak.authentication.RequiredActionContextResult.ignore ( )
inline

org.keycloak.authentication.RequiredActionContextを実装しています。

136  {
137  status = Status.IGNORE;
138  }
IGNORE
Definition: RequiredActionContext.java:43
Status status
Definition: RequiredActionContextResult.java:49

◆ success()

void org.keycloak.authentication.RequiredActionContextResult.success ( )
inline

org.keycloak.authentication.RequiredActionContextを実装しています。

130  {
131  status = Status.SUCCESS;
132 
133  }
SUCCESS
Definition: RequiredActionContext.java:42
Status status
Definition: RequiredActionContextResult.java:49

メンバ詳解

◆ authenticationSession

AuthenticationSessionModel org.keycloak.authentication.RequiredActionContextResult.authenticationSession
protected

◆ challenge

Response org.keycloak.authentication.RequiredActionContextResult.challenge
protected

◆ eventBuilder

EventBuilder org.keycloak.authentication.RequiredActionContextResult.eventBuilder
protected

◆ factory

RequiredActionFactory org.keycloak.authentication.RequiredActionContextResult.factory
protected

◆ httpRequest

HttpRequest org.keycloak.authentication.RequiredActionContextResult.httpRequest
protected

◆ realm

RealmModel org.keycloak.authentication.RequiredActionContextResult.realm
protected

◆ session

KeycloakSession org.keycloak.authentication.RequiredActionContextResult.session
protected

◆ status

Status org.keycloak.authentication.RequiredActionContextResult.status
protected

◆ user

UserModel org.keycloak.authentication.RequiredActionContextResult.user
protected

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