org.keycloak.authentication.AbstractAuthenticationFlowContext インタフェース

org.keycloak.authentication.AbstractAuthenticationFlowContext の継承関係図

org.keycloak.authentication.AbstractAuthenticationFlowContext 連携図

公開メンバ関数
EventBuilder	getEvent ()
EventBuilder	newEvent ()
AuthenticationExecutionModel	getExecution ()
RealmModel	getRealm ()
ClientConnection	getConnection ()
UriInfo	getUriInfo ()
KeycloakSession	getSession ()
HttpRequest	getHttpRequest ()
BruteForceProtector	getProtector ()
AuthenticatorConfigModel	getAuthenticatorConfig ()
FormMessage	getForwardedErrorMessage ()
FormMessage	getForwardedSuccessMessage ()
String	generateAccessCode ()
AuthenticationExecutionModel.Requirement	getCategoryRequirementFromCurrentFlow (String authenticatorCategory)
void	success ()
void	failure (AuthenticationFlowError error)
void	failure (AuthenticationFlowError error, Response response)
void	challenge (Response challenge)
void	forceChallenge (Response challenge)
void	failureChallenge (AuthenticationFlowError error, Response challenge)
void	attempted ()
FlowStatus	getStatus ()
AuthenticationFlowError	getError ()

詳解

著者

Bill Burke

バージョン

Revision

1

関数詳解

attempted()

void org.keycloak.authentication.AbstractAuthenticationFlowContext.attempted

(

)

There was no failure or challenge. The authenticator was attempted, but not fulfilled. If the current execution requirement is alternative or optional, then this status is ignored by the flow.

challenge()

void org.keycloak.authentication.AbstractAuthenticationFlowContext.challenge

(

Response

challenge

)

Sends a challenge response back to the HTTP client. If the current execution requirement is optional, this response will not be sent. If the current execution requirement is alternative, then this challenge will be sent if no other alternative execution was successful.

引数

challenge

failure() [1/2]

void org.keycloak.authentication.AbstractAuthenticationFlowContext.failure

(

AuthenticationFlowError

error

)

Aborts the current flow

引数

error

failure() [2/2]

void org.keycloak.authentication.AbstractAuthenticationFlowContext.failure	(	AuthenticationFlowError	error,
		Response	response
	)

Aborts the current flow.

引数

error
response	Response that will be sent back to HTTP client

failureChallenge()

void org.keycloak.authentication.AbstractAuthenticationFlowContext.failureChallenge	(	AuthenticationFlowError	error,
		Response	challenge
	)

Same behavior as forceChallenge(), but the error count in brute force attack detection will be incremented. For example, if a user enters in a bad password, the user is directed to try again, but Keycloak will keep track of how many failures have happened.

引数

error
challenge

forceChallenge()

void org.keycloak.authentication.AbstractAuthenticationFlowContext.forceChallenge

(

Response

challenge

)

Sends the challenge back to the HTTP client irregardless of the current executionr requirement

引数

challenge

generateAccessCode()

String org.keycloak.authentication.AbstractAuthenticationFlowContext.generateAccessCode

(

)

Generates access code and updates clientsession timestamp Access codes must be included in form action callbacks as a query parameter.

戻り値

getAuthenticatorConfig()

AuthenticatorConfigModel org.keycloak.authentication.AbstractAuthenticationFlowContext.getAuthenticatorConfig

(

)

Get any configuration associated with the current execution

戻り値

getCategoryRequirementFromCurrentFlow()

AuthenticationExecutionModel.Requirement org.keycloak.authentication.AbstractAuthenticationFlowContext.getCategoryRequirementFromCurrentFlow

(

String

authenticatorCategory

)

getConnection()

ClientConnection org.keycloak.authentication.AbstractAuthenticationFlowContext.getConnection

(

)

Information about the IP address from the connecting HTTP client.

戻り値

getError()

AuthenticationFlowError org.keycloak.authentication.AbstractAuthenticationFlowContext.getError

(

)

Get the error condition of a failed execution.

戻り値

may return null if there was no error

getEvent()

EventBuilder org.keycloak.authentication.AbstractAuthenticationFlowContext.getEvent

(

)

Current event builder being used

戻り値

getExecution()

AuthenticationExecutionModel org.keycloak.authentication.AbstractAuthenticationFlowContext.getExecution

(

)

The current execution in the flow

戻り値

getForwardedErrorMessage()

FormMessage org.keycloak.authentication.AbstractAuthenticationFlowContext.getForwardedErrorMessage

(

)

This could be an error message forwarded from another authenticator that is restarting or continuing the flo. For example the brokering API sends this when the broker failed authentication and we want to continue authentication locally. forwardedErrorMessage can then be displayed by whatever form is challenging.

getForwardedSuccessMessage()

FormMessage org.keycloak.authentication.AbstractAuthenticationFlowContext.getForwardedSuccessMessage

(

)

This could be an success message forwarded from another authenticator that is restarting or continuing the flow. For example a reset password sends an email, then resets the flow with a success message. forwardedSuccessMessage can then be displayed by whatever form is challenging.

getHttpRequest()

HttpRequest org.keycloak.authentication.AbstractAuthenticationFlowContext.getHttpRequest

(

)

getProtector()

BruteForceProtector org.keycloak.authentication.AbstractAuthenticationFlowContext.getProtector

(

)

getRealm()

RealmModel org.keycloak.authentication.AbstractAuthenticationFlowContext.getRealm

(

)

Current realm

戻り値

getSession()

KeycloakSession org.keycloak.authentication.AbstractAuthenticationFlowContext.getSession

(

)

Current session

戻り値

getStatus()

FlowStatus org.keycloak.authentication.AbstractAuthenticationFlowContext.getStatus

(

)

Get the current status of the current execution.

戻り値

may return null if not set yet.

getUriInfo()

UriInfo org.keycloak.authentication.AbstractAuthenticationFlowContext.getUriInfo

(

)

UriInfo of the current request

戻り値

newEvent()

EventBuilder org.keycloak.authentication.AbstractAuthenticationFlowContext.newEvent

(

)

Create a refresh new EventBuilder to use within this context

戻り値

success()

void org.keycloak.authentication.AbstractAuthenticationFlowContext.success

(

)

Mark the current execution as successful. The flow will then continue

---

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

• D:/AppData/doxygen/keycloak/spi-private/src/server-spi-private/src/main/java/org/keycloak/authentication/AbstractAuthenticationFlowContext.java