Package com.inductiveautomation.perspective.gateway.api

Class AuthChallengeRequest.Builder

java.lang.Object

com.inductiveautomation.perspective.gateway.api.AuthChallengeRequest.Builder

Enclosing class:

AuthChallengeRequest

public static class AuthChallengeRequest.Builder
extends java.lang.Object

Provides a fluent-API (builder-style) pattern for creating new AuthChallengeRequest objects

Method Summary

Modifier and Type	Method	Description
AuthChallengeRequest	build()
AuthChallengeRequest.Builder	setForceAuth(java.lang.Boolean forceAuth)
AuthChallengeRequest.Builder	setFramingOption(FramingOption framingOption)
AuthChallengeRequest.Builder	setIdp(java.lang.String idp)
AuthChallengeRequest.Builder	setPayload(com.inductiveautomation.ignition.common.gson.JsonElement payload)
AuthChallengeRequest.Builder	setTimeout(java.lang.Integer timeout)

Methods inherited from class java.lang.Object

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

Method Detail

setIdp

public AuthChallengeRequest.Builder setIdp(@Nullable
                                           java.lang.String idp)

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

public AuthChallengeRequest.Builder setForceAuth(@Nullable
                                                 java.lang.Boolean forceAuth)

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

public AuthChallengeRequest.Builder setTimeout(@Nullable
                                               java.lang.Integer timeout)

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 a JsonElement. may be set to null if no payload is necessary. defaults to null if not set.

Returns:

this AuthChallengeRequest.Builder

setFramingOption

public AuthChallengeRequest.Builder setFramingOption(@Nullable
                                                     FramingOption framingOption)

Parameters:

framingOption - the FramingOption which should be used to present the authentication UI. set to null to use the default of FramingOption.SELF. defaults to null if not set.

Returns:

this AuthChallengeRequest.Builder

build

public AuthChallengeRequest build()

Returns:

a new AuthChallengeRequest instance with the field values set using this builder's setter methods