Package com.inductiveautomation.perspective.gateway.api

Interface AuthChallengeCompleteEvent.Result.Error

All Superinterfaces:

AuthChallengeCompleteEvent.Result

All Known Subinterfaces:

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

Enclosing interface:

AuthChallengeCompleteEvent.Result

public static interface AuthChallengeCompleteEvent.Result.Error
extends AuthChallengeCompleteEvent.Result

Representation of a failed authentication challenge result.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	AuthChallengeCompleteEvent.Result.Error.Cancelled	Representation of the result of an authentication challenge which failed due to the user cancelling the authentication challenge.
static interface	AuthChallengeCompleteEvent.Result.Error.Generic	Representation of the result of an authentication challenge which failed due to a generic error.
static interface	AuthChallengeCompleteEvent.Result.Error.Timeout	Representation of the result of an authentication challenge which failed due to a timeout.

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
AuthChallengeCompleteEvent.Result.Error.Cancelled	getAsCancelled()
default AuthChallengeCompleteEvent.Result.Error	getAsError()
AuthChallengeCompleteEvent.Result.Error.Generic	getAsGeneric()
default AuthChallengeCompleteEvent.Result.Success	getAsSuccess()	Always throws an UnsupportedOperationException since this AuthChallengeCompleteEvent.Result represents an error
AuthChallengeCompleteEvent.Result.Error.Timeout	getAsTimeout()
boolean	isCancelled()
default boolean	isError()
boolean	isGeneric()
default boolean	isSuccess()
boolean	isTimeout()

Method Detail

isSuccess

default boolean isSuccess()

Specified by:

isSuccess in interface AuthChallengeCompleteEvent.Result

Returns:

false since this AuthChallengeCompleteEvent.Result represents an error

isError

default boolean isError()

Specified by:

isError in interface AuthChallengeCompleteEvent.Result

Returns:

true since this AuthChallengeCompleteEvent.Result represents an error

getAsSuccess

default AuthChallengeCompleteEvent.Result.Success getAsSuccess()

Always throws an UnsupportedOperationException since this AuthChallengeCompleteEvent.Result represents an error

Specified by:

getAsSuccess in interface AuthChallengeCompleteEvent.Result

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

getAsError

default AuthChallengeCompleteEvent.Result.Error getAsError()

Specified by:

getAsError in interface AuthChallengeCompleteEvent.Result

Returns:

this AuthChallengeCompleteEvent.Result typed as AuthChallengeCompleteEvent.Result.Error

isGeneric

boolean isGeneric()

Returns:

true if the error is generic (in other words: a catch-all error scenario which is not specific). Call getAsGeneric() to get this AuthChallengeCompleteEvent.Result.Error object typed as a AuthChallengeCompleteEvent.Result.Error.Generic object for access to methods which provide specific details pertaining to the generic error.

isTimeout

boolean isTimeout()

Returns:

true if the error is due to a timeout. Call getAsTimeout() to get this AuthChallengeCompleteEvent.Result.Error object typed as a AuthChallengeCompleteEvent.Result.Error.Timeout object for access to methods which provide specific details pertaining to the timeout error.

isCancelled

boolean isCancelled()

Returns:

true if the error is due to the user cancelling the authentication challenge. Call getAsCancelled() to get this AuthChallengeCompleteEvent.Result.Error object typed as a AuthChallengeCompleteEvent.Result.Error.Cancelled object for access to methods which provide specific details pertaining to the cancelled error.

getAsGeneric

AuthChallengeCompleteEvent.Result.Error.Generic getAsGeneric()

Returns:

this AuthChallengeCompleteEvent.Result.Error object typed as a AuthChallengeCompleteEvent.Result.Error.Generic object if this error is generic, otherwise throws an UnsupportedOperationException if this error is not generic. Check isGeneric() before calling this method to ensure you get the correct result type.

getAsTimeout

AuthChallengeCompleteEvent.Result.Error.Timeout getAsTimeout()

Returns:

this AuthChallengeCompleteEvent.Result.Error object typed as a AuthChallengeCompleteEvent.Result.Error.Timeout object if this error is due to a timeout, otherwise throws an UnsupportedOperationException if this error is not due to a timeout. Check isTimeout() before calling this method to ensure you get the correct result type.

getAsCancelled

AuthChallengeCompleteEvent.Result.Error.Cancelled getAsCancelled()

Returns:

this AuthChallengeCompleteEvent.Result.Error object typed as a AuthChallengeCompleteEvent.Result.Error.Cancelled object if this error is due to the user cancelling the authentication challenge, otherwise throws an UnsupportedOperationException if this error is not due to the user cancelling the authentication challenge. Check isCancelled() before calling this method to ensure you get the correct result type.