Package com.inductiveautomation.perspective.gateway.api

Interface AuthChallengeCompleteEvent.Result.Success

All Superinterfaces:

AuthChallengeCompleteEvent.Result

Enclosing interface:

AuthChallengeCompleteEvent.Result

public static interface AuthChallengeCompleteEvent.Result.Success
extends AuthChallengeCompleteEvent.Result

Representation of a successful authentication challenge result.

Nested Class Summary

Nested classes/interfaces inherited from interface com.inductiveautomation.perspective.gateway.api.AuthChallengeCompleteEvent.Result

AuthChallengeCompleteEvent.Result.Error, AuthChallengeCompleteEvent.Result.Success

Method Summary

Modifier and Type	Method	Description
default AuthChallengeCompleteEvent.Result.Error	getAsError()	Always throws an UnsupportedOperationException since this AuthChallengeCompleteEvent.Result represents success
default AuthChallengeCompleteEvent.Result.Success	getAsSuccess()
WebAuthUserContext	getWebAuthUserContext()
default boolean	isError()
default boolean	isSuccess()

Method Details

isSuccess

default boolean isSuccess()

Specified by:

isSuccess in interface AuthChallengeCompleteEvent.Result

Returns:

true since this AuthChallengeCompleteEvent.Result represents success

isError

default boolean isError()

Specified by:

isError in interface AuthChallengeCompleteEvent.Result

Returns:

false since this AuthChallengeCompleteEvent.Result represents success

getAsSuccess

default AuthChallengeCompleteEvent.Result.Success getAsSuccess()

Specified by:

getAsSuccess in interface AuthChallengeCompleteEvent.Result

Returns:

this AuthChallengeCompleteEvent.Result typed as AuthChallengeCompleteEvent.Result.Success

getAsError

default AuthChallengeCompleteEvent.Result.Error getAsError()

Always throws an UnsupportedOperationException since this AuthChallengeCompleteEvent.Result represents success

Specified by:

getAsError in interface AuthChallengeCompleteEvent.Result

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 AuthChallengeCompleteEvent.Result.isSuccess() or AuthChallengeCompleteEvent.Result.isError() before calling this method to ensure you get the correct result type.

getWebAuthUserContext

WebAuthUserContext getWebAuthUserContext()

Returns:

the WebAuthUserContext which contains details about the user who performed the successful authentication challenge