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

Class UsernamePasswordRequired

java.lang.Object

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

All Implemented Interfaces:

CaptchaEnabledState, CaptchaProviderEnabledState, ClientSideAuthenticatorEnabledState, ThisIsMyDeviceState, Serializable

public class UsernamePasswordRequired
extends Object
implements Serializable, CaptchaEnabledState, ThisIsMyDeviceState, CaptchaProviderEnabledState, ClientSideAuthenticatorEnabledState

An API state model containing additional details for states in which the user's credentials are required.

Since:

9.3

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
UsernamePasswordRequired()

Method Summary

Modifier and Type	Method	Description
Boolean	getAllowUsernameEdits()	Get whether the user should be allowed to input a username different from the username hint.
List<AlternativeAuthenticationSource>	getAlternativeAuthenticationSources()	Get the list of alternative authentication sources.
Map<String,Object>	getCaptchaAttributes()	Get the CAPTCHA attributes as provided by the CAPTCHA provider plugin.
String	getCaptchaProviderType()	Get the CAPTCHA provider plugin type.
String	getCaptchaSiteKey()	Get the CAPTCHA site key assigned to your application by Google.
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.
boolean	getShowCaptcha()	Return true when the 'CAPTCHA' for authentication feature is available.
boolean	getShowRememberMyUsername()	Return true when the 'Remember My Username' option is available.
boolean	getShowThisIsMyDevice()	Return true when the 'This Is My Device' option is available.
boolean	getThisIsMyDeviceSelected()	Return true when the 'This Is My Device' option is currently selected.
String	getUsername()	Get the username hint to be presented to the user.
boolean	isAuthenticatorEnabled()	Determines whether a client side authenticator is enabled for authentication.
boolean	isRememberMyUsernameSelected()	Return true when the 'Remember My Username' option is currently selected.
void	setAllowUsernameEdits(Boolean allowUsernameEdits)	Set whether the user should be allowed to input a username different from the username hint.
void	setAlternativeAuthenticationSources(List<AlternativeAuthenticationSource> alternativeAuthenticationSources)	Set the list of alternative authentication sources.
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	setCaptchaSiteKey(String captchaSiteKey)	Set the CAPTCHA site key assigned to your application by Google.
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	setRememberMyUsernameSelected(boolean rememberMyUsernameSelected)	Set the current selection of the 'Remember My Username' option
void	setShowCaptcha(boolean showCaptcha)	Set the 'CAPTCHA' for authentication feature availability
void	setShowRememberMyUsername(boolean showRememberMyUsername)	Set the 'Remember My Username' option availability
void	setShowThisIsMyDevice(boolean showThisIsMyDevice)	Set the 'This Is My Device' option availability
void	setThisIsMyDeviceSelected(boolean thisIsMyDeviceSelected)	Set the current selection of the 'This Is My Device' option
void	setUsername(String username)	Set the username hint to be presented to the user.

Methods inherited from class java.lang.Object

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

Constructor Details

UsernamePasswordRequired

public UsernamePasswordRequired()

Method Details

getUsername

public String getUsername()

Get the username hint to be presented to the user. This hint may be specified through a parameter on a protocol request or through an authentication policy mapping.

setUsername

public void setUsername(String username)

Set the username hint to be presented to the user.

getAllowUsernameEdits

public Boolean getAllowUsernameEdits()

Get whether the user should be allowed to input a username different from the username hint.

setAllowUsernameEdits

public void setAllowUsernameEdits(Boolean allowUsernameEdits)

Set whether the user should be allowed to input a username different from the username hint.

getShowRememberMyUsername

public boolean getShowRememberMyUsername()

Return true when the 'Remember My Username' option is available.

setShowRememberMyUsername

public void setShowRememberMyUsername(boolean showRememberMyUsername)

Set the 'Remember My Username' option availability

isRememberMyUsernameSelected

public boolean isRememberMyUsernameSelected()

Return true when the 'Remember My Username' option is currently selected.

setRememberMyUsernameSelected

public void setRememberMyUsernameSelected(boolean rememberMyUsernameSelected)

Set the current selection of the 'Remember My Username' option

getShowThisIsMyDevice

public boolean getShowThisIsMyDevice()

Description copied from interface: ThisIsMyDeviceState

Return true when the 'This Is My Device' option is available.

Specified by:

getShowThisIsMyDevice in interface ThisIsMyDeviceState

setShowThisIsMyDevice

public void setShowThisIsMyDevice(boolean showThisIsMyDevice)

Description copied from interface: ThisIsMyDeviceState

Set the 'This Is My Device' option availability

Specified by:

setShowThisIsMyDevice in interface ThisIsMyDeviceState

getThisIsMyDeviceSelected

public boolean getThisIsMyDeviceSelected()

Return true when the 'This Is My Device' option is currently selected.

setThisIsMyDeviceSelected

public void setThisIsMyDeviceSelected(boolean thisIsMyDeviceSelected)

Set the current selection of the 'This Is My Device' option

getShowCaptcha

public boolean getShowCaptcha()

Description copied from interface: CaptchaEnabledState

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

Specified by:

getShowCaptcha in interface CaptchaEnabledState

Specified by:

getShowCaptcha in interface CaptchaProviderEnabledState

setShowCaptcha

public void setShowCaptcha(boolean showCaptcha)

Description copied from interface: CaptchaEnabledState

Set the 'CAPTCHA' for authentication feature availability

Specified by:

setShowCaptcha in interface CaptchaEnabledState

Specified by:

setShowCaptcha in interface CaptchaProviderEnabledState

getCaptchaSiteKey

public String getCaptchaSiteKey()

Description copied from interface: CaptchaEnabledState

Get the CAPTCHA site key assigned to your application by Google. This field will only be populated if the CAPTCHA provider is reCAPTCHA v2, v3, or Enterprise.

Specified by:

getCaptchaSiteKey in interface CaptchaEnabledState

setCaptchaSiteKey

public void setCaptchaSiteKey(String captchaSiteKey)

Description copied from interface: CaptchaEnabledState

Set the CAPTCHA site key assigned to your application by Google.

Specified by:

setCaptchaSiteKey in interface CaptchaEnabledState

getAlternativeAuthenticationSources

public List<AlternativeAuthenticationSource> getAlternativeAuthenticationSources()

Get the list of alternative authentication sources.

setAlternativeAuthenticationSources

public void setAlternativeAuthenticationSources(List<AlternativeAuthenticationSource> alternativeAuthenticationSources)

Set the list of alternative authentication sources.

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