Package com.pingidentity.sdk.api.authn.model.state

Class IdentifierRequired

java.lang.Object

com.pingidentity.sdk.api.authn.model.state.IdentifierRequired

All Implemented Interfaces:

CaptchaProviderEnabledState, ClientSideAuthenticatorEnabledState

public class IdentifierRequired
extends Object
implements CaptchaProviderEnabledState, ClientSideAuthenticatorEnabledState

An API state model containing additional details for states in which an identifier is required for authentication to proceed.

Since:

10.0

Constructor Summary

Constructors

Constructor	Description
IdentifierRequired()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getCaptchaAttributes()	Get the CAPTCHA attributes as provided by the CAPTCHA provider plugin.
String	getCaptchaProviderType()	Get the CAPTCHA provider plugin type.
Map<String,Object>	getClientSideAuthenticatorAttributes()	Get the attributes that are required for the client side authenticator to operate.
List<String>	getJavascriptFilenames()	Get the list of javascript filenames that should be loaded for client side authentication.
List<String>	getPreviouslySubmittedIdentifiers()	Get the list of previously submitted identifiers.
boolean	getShowCaptcha()	Return true when the 'CAPTCHA' for authentication feature is available.
boolean	isAuthenticatorEnabled()	Determines whether a client side authenticator is enabled for authentication.
void	setAuthenticatorEnabled(boolean enabled)	Sets whether a client side authenticator is enabled for authentication.
void	setCaptchaAttributes(Map<String,Object> captchaAttributes)	Set the CAPTCHA attributes as provided by the CAPTCHA provider plugin.
void	setCaptchaProviderType(String captchaProviderType)	Set the CAPTCHA provider plugin type.
void	setClientSideAuthenticatorAttributes(Map<String,Object> authenticatorAttributes)	Sets the attributes that will be used by the associated client side authenticator javascript files.
void	setJavascriptFilenames(List<String> javascriptFilenames)	Set the Javascript filesnames that will be required for client side authentication.
void	setPreviouslySubmittedIdentifiers(List<String> previouslySubmittedIdentifiers)	Set the list of previously submitted identifiers.
void	setShowCaptcha(boolean showCaptcha)	Set the 'CAPTCHA' for authentication feature availability.

Methods inherited from class java.lang.Object

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

Constructor Details

IdentifierRequired

public IdentifierRequired()

Method Details

getPreviouslySubmittedIdentifiers

public List<String> getPreviouslySubmittedIdentifiers()

Get the list of previously submitted identifiers.

setPreviouslySubmittedIdentifiers

public void setPreviouslySubmittedIdentifiers(List<String> previouslySubmittedIdentifiers)

Set the list of previously submitted identifiers.

getShowCaptcha

public boolean getShowCaptcha()

Description copied from interface: CaptchaProviderEnabledState

Return true when the 'CAPTCHA' for authentication feature is available.

Specified by:

getShowCaptcha in interface CaptchaProviderEnabledState

setShowCaptcha

public void setShowCaptcha(boolean showCaptcha)

Description copied from interface: CaptchaProviderEnabledState

Set the 'CAPTCHA' for authentication feature availability.

Specified by:

setShowCaptcha in interface CaptchaProviderEnabledState

getCaptchaProviderType

public String getCaptchaProviderType()

Description copied from interface: CaptchaProviderEnabledState

Get the CAPTCHA provider plugin type.

Specified by:

getCaptchaProviderType in interface CaptchaProviderEnabledState

setCaptchaProviderType

public void setCaptchaProviderType(String captchaProviderType)

Description copied from interface: CaptchaProviderEnabledState

Set the CAPTCHA provider plugin type.

Specified by:

setCaptchaProviderType in interface CaptchaProviderEnabledState

getCaptchaAttributes

public Map<String,Object> getCaptchaAttributes()

Description copied from interface: CaptchaProviderEnabledState

Get the CAPTCHA attributes as provided by the CAPTCHA provider plugin. The CAPTCHA provider plugin CAPTCHA attributes. Google's reCAPTCHA v2 CAPTCHA provider will provide 'siteKey', Google's reCAPTCHA v3 and reCAPTCHA Enterprise CAPTCHA provider will provide 'siteKey' and 'action' to be able to invoke the challenge.

Specified by:

getCaptchaAttributes in interface CaptchaProviderEnabledState

setCaptchaAttributes

public void setCaptchaAttributes(Map<String,Object> captchaAttributes)

Description copied from interface: CaptchaProviderEnabledState

Set the CAPTCHA attributes as provided by the CAPTCHA provider plugin.

Specified by:

setCaptchaAttributes in interface CaptchaProviderEnabledState

isAuthenticatorEnabled

public boolean isAuthenticatorEnabled()

Description copied from interface: ClientSideAuthenticatorEnabledState

Determines whether a client side authenticator is enabled for authentication.

Specified by:

isAuthenticatorEnabled in interface ClientSideAuthenticatorEnabledState

setAuthenticatorEnabled

public void setAuthenticatorEnabled(boolean enabled)

Description copied from interface: ClientSideAuthenticatorEnabledState

Sets whether a client side authenticator is enabled for authentication.

Specified by:

setAuthenticatorEnabled in interface ClientSideAuthenticatorEnabledState

getClientSideAuthenticatorAttributes

public Map<String,Object> getClientSideAuthenticatorAttributes()

Description copied from interface: ClientSideAuthenticatorEnabledState

Get the attributes that are required for the client side authenticator to operate. These will be used as context for the provided javascript files.

Specified by:

getClientSideAuthenticatorAttributes in interface ClientSideAuthenticatorEnabledState

setClientSideAuthenticatorAttributes

public void setClientSideAuthenticatorAttributes(Map<String,Object> authenticatorAttributes)

Description copied from interface: ClientSideAuthenticatorEnabledState

Sets the attributes that will be used by the associated client side authenticator javascript files.

Specified by:

setClientSideAuthenticatorAttributes in interface ClientSideAuthenticatorEnabledState

getJavascriptFilenames

public List<String> getJavascriptFilenames()

Description copied from interface: ClientSideAuthenticatorEnabledState

Get the list of javascript filenames that should be loaded for client side authentication. These javascript files names are defined by the client side authenticator class.

Specified by:

getJavascriptFilenames in interface ClientSideAuthenticatorEnabledState

setJavascriptFilenames

public void setJavascriptFilenames(List<String> javascriptFilenames)

Description copied from interface: ClientSideAuthenticatorEnabledState

Set the Javascript filesnames that will be required for client side authentication.

Specified by:

setJavascriptFilenames in interface ClientSideAuthenticatorEnabledState