Package com.inductiveautomation.perspective.gateway.api

Interface AuthChallengeCompleteEvent.Result

All Known Subinterfaces:

AuthChallengeCompleteEvent.Result.Error, AuthChallengeCompleteEvent.Result.Error.Cancelled, AuthChallengeCompleteEvent.Result.Error.Generic, AuthChallengeCompleteEvent.Result.Error.Timeout, AuthChallengeCompleteEvent.Result.Success

Enclosing interface:

AuthChallengeCompleteEvent

public static interface AuthChallengeCompleteEvent.Result

Representation of the result of an authentication challenge.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	AuthChallengeCompleteEvent.Result.Error	Representation of a failed authentication challenge result.
static interface	AuthChallengeCompleteEvent.Result.Success	Representation of a successful authentication challenge result.

Method Summary

Modifier and Type	Method	Description
AuthChallengeCompleteEvent.Result.Error	getAsError()
AuthChallengeCompleteEvent.Result.Success	getAsSuccess()
default boolean	isError()
boolean	isSuccess()

Method Details

isSuccess

boolean isSuccess()

Returns:

true if the authentication challenge was a success, otherwise returns false. If true, call getAsSuccess() to get this AuthChallengeCompleteEvent.Result object typed as a AuthChallengeCompleteEvent.Result.Success object for access to methods which provide specific details pertaining to the successful result, such as the authenticated user's identity attributes and security levels. If false, call getAsError() to get this AuthChallengeCompleteEvent.Result object typed as an AuthChallengeCompleteEvent.Result.Error object for access to methods which provide specific details pertaining to the error result, such as the type of error which occurred.

isError

default boolean isError()

Returns:

true if the authentication challenge failed due to an error, otherwise returns false. If true, call getAsError() to get this AuthChallengeCompleteEvent.Result object typed as an AuthChallengeCompleteEvent.Result.Error object for access to methods which provide specific details pertaining to the error result, such as the type of error which occurred. If false, call getAsSuccess() to get this AuthChallengeCompleteEvent.Result object typed as a AuthChallengeCompleteEvent.Result.Success object for access to methods which provide specific details pertaining to the successful result, such as the authenticated user's identity attributes and security levels.

getAsSuccess

AuthChallengeCompleteEvent.Result.Success getAsSuccess()

Returns:

the result as a AuthChallengeCompleteEvent.Result.Success object if the result is successful, otherwise throws an UnsupportedOperationException if the result is an error. Check isSuccess() or isError() before calling this method to ensure you get the correct result type.

getAsError

AuthChallengeCompleteEvent.Result.Error getAsError()

Returns:

the result as an AuthChallengeCompleteEvent.Result.Error object if the result is an error, otherwise throws an UnsupportedOperationException if the result is successful. Check isSuccess() or isError() before calling this method to ensure you get the correct result type.