Package io.jmix.securityflowui.authentication

Class AuthDetailsValidationResult

java.lang.Object

io.jmix.securityflowui.authentication.AuthDetailsValidationResult

public class AuthDetailsValidationResult
extends Object

Class that contains result of AuthDetails validation. Validation is optional in general and can be provided by different implementations of AuthDetailsValidator.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Exception	exception
protected final String	message
protected final boolean	valid

Method Summary

Modifier and Type	Method	Description
static AuthDetailsValidationResult	createInvalid(String message)	Creates invalid AuthDetailsValidationResult with provided message.
static AuthDetailsValidationResult	createInvalid(String message, Exception exception)	Creates invalid AuthDetailsValidationResult with provided message and optional exception.
static AuthDetailsValidationResult	createValid()	Creates valid AuthDetailsValidationResult without violation message and exception.
Exception	getException()
String	getMessage()
boolean	isValid()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

valid

protected final boolean valid

message

protected final String message

exception

protected final Exception exception

Method Details

createValid

public static AuthDetailsValidationResult createValid()

Creates valid AuthDetailsValidationResult without violation message and exception.

Returns:

Valid AuthDetailsValidationResult

createInvalid

public static AuthDetailsValidationResult createInvalid(String message)

Creates invalid AuthDetailsValidationResult with provided message.

Parameters:

message - description of validation violation

Returns:

invalid AuthDetailsValidationResult

See Also:

• createInvalid(String, Exception)

createInvalid

public static AuthDetailsValidationResult createInvalid(String message,
 @Nullable
 Exception exception)

Creates invalid AuthDetailsValidationResult with provided message and optional exception.

Parameters:

message - description of validation violation

exception - optional related exception

Returns:

invalid AuthDetailsValidationResult

isValid

public boolean isValid()

Returns:

true if validation has no violations

getMessage

@Nullable
public String getMessage()

Returns:

description of validation violation

getException

@Nullable
public Exception getException()

Returns:

exception related to validation violation