Package org.keycloak.authentication

Interface ValidationContext

All Superinterfaces:

FormContext

public interface ValidationContext
extends FormContext

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

Version:

$Revision: 1 $

Author:

Bill Burke

Method Summary

Modifier and Type	Method	Description
void	error(String error)
void	excludeOtherErrors()	The error messages of this current validation will take precedence over any others.
void	success()	Mark this validation as successful
void	validationError(jakarta.ws.rs.core.MultivaluedMap<String,String> formData, List<FormMessage> errors)	Mark this validation as having a validation error

Methods inherited from interface org.keycloak.authentication.FormContext

getAuthenticationSession, getAuthenticatorConfig, getConnection, getEvent, getExecution, getHttpRequest, getRealm, getSession, getUriInfo, getUser, newEvent, setUser

Method Details

validationError

void validationError(jakarta.ws.rs.core.MultivaluedMap<String,String> formData,
 List<FormMessage> errors)

Mark this validation as having a validation error

Parameters:

formData - form data you want to display when the form is refreshed

errors - error messages to display on the form

error

void error(String error)

success

void success()

Mark this validation as successful

excludeOtherErrors

void 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