Package com.inductiveautomation.perspective.gateway.api

Interface AuthChallengeCompleteEvent.Result.Error.Generic

All Superinterfaces:

AuthChallengeCompleteEvent.Result, AuthChallengeCompleteEvent.Result.Error

Enclosing interface:

AuthChallengeCompleteEvent.Result.Error

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

Representation of the result of an authentication challenge which failed due to a generic error.

Nested Class Summary

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

AuthChallengeCompleteEvent.Result.Error, AuthChallengeCompleteEvent.Result.Success

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

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

Method Summary

Modifier and Type	Method	Description
default AuthChallengeCompleteEvent.Result.Error.Cancelled	getAsCancelled()	Always throws an UnsupportedOperationException since this is a AuthChallengeCompleteEvent.Result.Error.Generic error result
default AuthChallengeCompleteEvent.Result.Error.Generic	getAsGeneric()
default AuthChallengeCompleteEvent.Result.Error.Timeout	getAsTimeout()	Always throws an UnsupportedOperationException since this is a AuthChallengeCompleteEvent.Result.Error.Generic error result
java.util.Optional<java.lang.String>	getMessage()
default boolean	isCancelled()
default boolean	isGeneric()
default boolean	isTimeout()

Methods inherited from interface com.inductiveautomation.perspective.gateway.api.AuthChallengeCompleteEvent.Result.Error

getAsError, getAsSuccess, isError, isSuccess

Method Detail

isGeneric

default boolean isGeneric()

Specified by:

isGeneric in interface AuthChallengeCompleteEvent.Result.Error

Returns:

true since this AuthChallengeCompleteEvent.Result.Error result is generic

isTimeout

default boolean isTimeout()

Specified by:

isTimeout in interface AuthChallengeCompleteEvent.Result.Error

Returns:

false since this AuthChallengeCompleteEvent.Result.Error result is generic

isCancelled

default boolean isCancelled()

Specified by:

isCancelled in interface AuthChallengeCompleteEvent.Result.Error

Returns:

false since this AuthChallengeCompleteEvent.Result.Error result is generic

getAsGeneric

default AuthChallengeCompleteEvent.Result.Error.Generic getAsGeneric()

Specified by:

getAsGeneric in interface AuthChallengeCompleteEvent.Result.Error

Returns:

this AuthChallengeCompleteEvent.Result.Error result typed as AuthChallengeCompleteEvent.Result.Error.Generic

getAsTimeout

default AuthChallengeCompleteEvent.Result.Error.Timeout getAsTimeout()

Always throws an UnsupportedOperationException since this is a AuthChallengeCompleteEvent.Result.Error.Generic error result

Specified by:

getAsTimeout in interface AuthChallengeCompleteEvent.Result.Error

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

getAsCancelled

default AuthChallengeCompleteEvent.Result.Error.Cancelled getAsCancelled()

Always throws an UnsupportedOperationException since this is a AuthChallengeCompleteEvent.Result.Error.Generic error result

Specified by:

getAsCancelled in interface AuthChallengeCompleteEvent.Result.Error

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

getMessage

java.util.Optional<java.lang.String> getMessage()

Returns:

an Optional containing a diagnostic message pertaining to the generic error, or an empty Optional if such a message is not available