Package com.inductiveautomation.perspective.gateway.api

Class AuthChallengeRequest

java.lang.Object

com.inductiveautomation.perspective.gateway.api.AuthChallengeRequest

public class AuthChallengeRequest
extends Object

Immutable representation of an authentication challenge request

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AuthChallengeRequest.Builder	Provides a fluent-API (builder-style) pattern for creating new AuthChallengeRequest objects
static class	AuthChallengeRequest.GsonAdapter	A JsonSerializer and JsonDeserializer implementation for serializing and de-serializing AuthChallengeRequest objects to / from JSON using GSON APIs.

Method Summary

Modifier and Type	Method	Description
static AuthChallengeRequest.Builder	builder(AuthChallengeRequest authChallengeRequest)
static AuthChallengeRequest.Builder	builder(String client)
String	getClient()
Optional<Boolean>	getForceAuth()
Optional<FramingOption>	getFramingOption()
Optional<String>	getIdp()
Optional<com.inductiveautomation.ignition.common.gson.JsonElement>	getPayload()
Optional<Integer>	getTimeout()
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

getClient

public String getClient()

Returns:

the client identifier associated with this auth challenge request

getIdp

public Optional<String> getIdp()

Returns:

an Optional containing the name of the IdP which will handle this auth challenge request, or an empty Optional of no IdP is specified

getForceAuth

public Optional<Boolean> getForceAuth()

Returns:

an Optional containing a Boolean indicating whether or not the user will be asked to re-enter their credentials at the IdP, even if they are already logged in. Returns an empty Optional if this property is not specified.

getTimeout

public Optional<Integer> getTimeout()

Returns:

an Optional containing the number of minutes the system will wait in between the authentication request and the authentication response before timing out the request. Returns an empty Optional if the timeout is not specified.

getPayload

public Optional<com.inductiveautomation.ignition.common.gson.JsonElement> getPayload()

Returns:

an Optional containing an opaque payload represented as a JsonElement, or an empty Optional if no payload was set

getFramingOption

public Optional<FramingOption> getFramingOption()

Returns:

an Optional containing the FramingOption for this authentication challenge request, or an empty Optional if this property was not specified.

toString

public String toString()

Overrides:

toString in class Object

builder

public static AuthChallengeRequest.Builder builder(String client)

Returns:

a new AuthChallengeRequest.Builder instance

builder

public static AuthChallengeRequest.Builder builder(AuthChallengeRequest authChallengeRequest)

Parameters:

authChallengeRequest - the AuthChallengeRequest whose properties will be used to initialize the new AuthChallengeRequest.Builder instance returned from this method

Returns:

a new AuthChallengeRequest.Builder instance with the properties set from the provided AuthChallengeRequest