Class AuthChallengeRequest.Builder
java.lang.Object
com.inductiveautomation.perspective.gateway.api.AuthChallengeRequest.Builder
- Enclosing class:
- AuthChallengeRequest
Provides a fluent-API (builder-style) pattern for creating new
AuthChallengeRequest
objects-
Method Summary
Modifier and TypeMethodDescriptionbuild()
setForceAuth
(Boolean forceAuth) setFramingOption
(FramingOption framingOption) setPayload
(com.inductiveautomation.ignition.common.gson.JsonElement payload) setTimeout
(Integer timeout)
-
Method Details
-
setIdp
- Parameters:
idp
- the name of the IdP which should handle the authentication challenge request. set to null to use the project default IdP. defaults to null if not set.- Returns:
- this
AuthChallengeRequest.Builder
-
setForceAuth
- Parameters:
forceAuth
- whether the user should be required to re-enter their credentials at the IdP, even if they are already logged in. set to null to use the project default setting. defaults to null if not set.- Returns:
- this
AuthChallengeRequest.Builder
-
setTimeout
- Parameters:
timeout
- the number of minutes the system will wait in between the authentication request and the authentication response before timing out the request. set to null to use the default value of two minutes. defaults to null if not set.- Returns:
- this
AuthChallengeRequest.Builder
-
setPayload
public AuthChallengeRequest.Builder setPayload(@Nullable com.inductiveautomation.ignition.common.gson.JsonElement payload) - Parameters:
payload
- the opaque payload represented as aJsonElement
. may be set to null if no payload is necessary. defaults to null if not set.- Returns:
- this
AuthChallengeRequest.Builder
-
setFramingOption
- Parameters:
framingOption
- theFramingOption
which should be used to present the authentication UI. set to null to use the default ofFramingOption.SELF
. defaults to null if not set.- Returns:
- this
AuthChallengeRequest.Builder
-
build
- Returns:
- a new
AuthChallengeRequest
instance with the field values set using this builder's setter methods
-