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

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

org.keycloak.authentication.ValidationContext 連携図

公開メンバ関数
void	validationError (MultivaluedMap< String, String > formData, List< FormMessage > errors)
void	error (String error)
void	success ()
void	excludeOtherErrors ()
EventBuilder	getEvent ()
EventBuilder	newEvent ()
AuthenticationExecutionModel	getExecution ()
UserModel	getUser ()
void	setUser (UserModel user)
RealmModel	getRealm ()
AuthenticationSessionModel	getAuthenticationSession ()
ClientConnection	getConnection ()
UriInfo	getUriInfo ()
KeycloakSession	getSession ()
HttpRequest	getHttpRequest ()
AuthenticatorConfigModel	getAuthenticatorConfig ()

詳解

Interface that encapsulates the current validation that is being performed. Calling success() or validationError() sets the status of this current validation.

著者

Bill Burke

バージョン

Revision

1

関数詳解

error()

void org.keycloak.authentication.ValidationContext.error

(

String

error

)

excludeOtherErrors()

void org.keycloak.authentication.ValidationContext.excludeOtherErrors

(

)

The error messages of this current validation will take precedence over any others. Other error messages will not be shown. This is useful to prevent validation from leaking to an attacker. For example, the recaptcha validator calls this method so that usernames cannot be phished

getAuthenticationSession()

AuthenticationSessionModel org.keycloak.authentication.FormContext.getAuthenticationSession ( )

inherited

AuthenticationSessionModel attached to this flow

戻り値

getAuthenticatorConfig()

AuthenticatorConfigModel org.keycloak.authentication.FormContext.getAuthenticatorConfig ( )

inherited

Get any configuration associated with the current execution

戻り値

getConnection()

ClientConnection org.keycloak.authentication.FormContext.getConnection ( )

inherited

Information about the IP address from the connecting HTTP client.

戻り値

getEvent()

EventBuilder org.keycloak.authentication.FormContext.getEvent ( )

inherited

Current event builder being used

戻り値

getExecution()

AuthenticationExecutionModel org.keycloak.authentication.FormContext.getExecution ( )

inherited

The current execution in the flow

戻り値

getHttpRequest()

HttpRequest org.keycloak.authentication.FormContext.getHttpRequest ( )

inherited

getRealm()

RealmModel org.keycloak.authentication.FormContext.getRealm ( )

inherited

Current realm

戻り値

getSession()

KeycloakSession org.keycloak.authentication.FormContext.getSession ( )

inherited

Current session

戻り値

getUriInfo()

UriInfo org.keycloak.authentication.FormContext.getUriInfo ( )

inherited

UriInfo of the current request

戻り値

getUser()

UserModel org.keycloak.authentication.FormContext.getUser ( )

inherited

Current user attached to this flow. It can return null if no uesr has been identified yet

戻り値

newEvent()

EventBuilder org.keycloak.authentication.FormContext.newEvent ( )

inherited

Create a refresh new EventBuilder to use within this context

戻り値

setUser()

void org.keycloak.authentication.FormContext.setUser ( UserModel  user )

inherited

Attach a specific user to this flow.

引数

user

success()

void org.keycloak.authentication.ValidationContext.success

(

)

Mark this validation as sucessful

validationError()

void org.keycloak.authentication.ValidationContext.validationError	(	MultivaluedMap< String, String >	formData,
		List< FormMessage >	errors
	)

Mark this validation as having a validation error

引数

formData	form data you want to display when the form is refreshed
errors	error messages to display on the form

---

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

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