com.okta.authn.sdk.impl.resource

Class DefaultOptions

java.lang.Object

com.okta.sdk.impl.resource.AbstractPropertyRetriever

com.okta.sdk.impl.resource.AbstractResource

com.okta.authn.sdk.impl.resource.DefaultOptions

All Implemented Interfaces:

Options, com.okta.sdk.resource.ExtensibleResource, com.okta.sdk.resource.PropertyRetriever, com.okta.sdk.resource.Resource, Map<String,Object>

public class DefaultOptions
extends com.okta.sdk.impl.resource.AbstractResource
implements Options

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class com.okta.sdk.impl.resource.AbstractResource

properties

Fields inherited from class com.okta.sdk.impl.resource.AbstractPropertyRetriever

readLock, writeLock

Constructor Summary

Constructors

Constructor and Description
DefaultOptions(com.okta.sdk.impl.ds.InternalDataStore dataStore)
DefaultOptions(com.okta.sdk.impl.ds.InternalDataStore dataStore, Map<String,Object> properties)

Method Summary

Modifier and Type	Method and Description
Map<String,com.okta.sdk.impl.resource.Property>	getPropertyDescriptors()
Boolean	isMultiOptionalFactorEnroll() Returns true if the user should transition back to MFA_ENROLL state after successful factor enrollment when additional optional factors are available for enrollment.
Boolean	isWarnBeforePasswordExpired() Returns true if user should transition to PASSWORD_WARN state before SUCCESS if the user’s password is about to expire and within their password policy warn period.
Options	setMultiOptionalFactorEnroll(Boolean multiOptionalFactorEnroll) Sets whether user should transaction back to MFA_ENROLL state after successful factor enrollment when additional optional factors are available for enrollment.
Options	setWarnBeforePasswordExpired(Boolean warnBeforePasswordExpired) Sets whether if user should transition to PASSWORD_WARN state before SUCCESS if the user’s password is about to expire and within their password policy warn period.

Methods inherited from class com.okta.sdk.impl.resource.AbstractResource

clear, containsKey, containsValue, createPropertyDescriptorMap, createPropertyDescriptorMap, entrySet, equals, get, getDataStore, getDeletedPropertyNames, getInternalProperties, getParamsFromHref, getProperty, getPropertyNames, getResourceHref, getResourceListProperty, getResourceProperty, getUpdatedPropertyNames, hashCode, hasProperty, isDirty, isEmpty, isPrintableProperty, keySet, materialize, put, putAll, remove, setInternalProperties, setProperty, setProperty, setResourceHref, size, toString, values

Methods inherited from class com.okta.sdk.impl.resource.AbstractPropertyRetriever

getBoolean, getBoolean, getBooleanProperty, getCharArray, getDateProperty, getDoubleProperty, getDoubleProperty, getEnumListProperty, getEnumProperty, getEnumProperty, getInt, getInteger, getIntegerList, getIntProperty, getIntProperty, getListProperty, getListProperty, getMap, getMapProperty, getNonEmptyMap, getNullableBoolean, getNullableBooleanProperty, getNumber, getNumberList, getString, getString, getStringList, getStringProperty, setProperty, setProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.okta.sdk.resource.Resource

getResourceHref, setResourceHref

Methods inherited from interface com.okta.sdk.resource.PropertyRetriever

getBoolean, getInteger, getIntegerList, getNumber, getNumberList, getString, getStringList

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Constructor Detail

DefaultOptions

public DefaultOptions(com.okta.sdk.impl.ds.InternalDataStore dataStore)

DefaultOptions

public DefaultOptions(com.okta.sdk.impl.ds.InternalDataStore dataStore,
                      Map<String,Object> properties)

Method Detail

getPropertyDescriptors

public Map<String,com.okta.sdk.impl.resource.Property> getPropertyDescriptors()

Specified by:

getPropertyDescriptors in class com.okta.sdk.impl.resource.AbstractResource

isMultiOptionalFactorEnroll

public Boolean isMultiOptionalFactorEnroll()

Description copied from interface: Options

Returns true if the user should transition back to MFA_ENROLL state after successful factor enrollment when additional optional factors are available for enrollment. (not required)

Specified by:

isMultiOptionalFactorEnroll in interface Options

Returns:

true if user can enroll in multiple factors.

setMultiOptionalFactorEnroll

public Options setMultiOptionalFactorEnroll(Boolean multiOptionalFactorEnroll)

Description copied from interface: Options

Sets whether user should transaction back to MFA_ENROLL state after successful factor enrollment when additional optional factors are available for enrollment. (not required)

Specified by:

setMultiOptionalFactorEnroll in interface Options

Returns:

the current object for method chaining.

isWarnBeforePasswordExpired

public Boolean isWarnBeforePasswordExpired()

Description copied from interface: Options

Returns true if user should transition to PASSWORD_WARN state before SUCCESS if the user’s password is about to expire and within their password policy warn period. (not required)

Specified by:

isWarnBeforePasswordExpired in interface Options

Returns:

true if user should warned about password expiration.

setWarnBeforePasswordExpired

public Options setWarnBeforePasswordExpired(Boolean warnBeforePasswordExpired)

Description copied from interface: Options

Sets whether if user should transition to PASSWORD_WARN state before SUCCESS if the user’s password is about to expire and within their password policy warn period. (not required)

Specified by:

setWarnBeforePasswordExpired in interface Options

Returns:

the current object for method chaining.