com.pingidentity.sdk

Class AuthenticationSelectorDescriptor

java.lang.Object

com.pingidentity.sdk.PluginDescriptor

com.pingidentity.sdk.AuthenticationSelectorDescriptor

public class AuthenticationSelectorDescriptor
extends PluginDescriptor

This class is used to describe an Authentication Selector implementation to the PingFederate server.

Since:

7.3

Field Summary

Fields inherited from class com.pingidentity.sdk.PluginDescriptor

UNDEFINED

Constructor Summary

Constructors

Constructor and Description
AuthenticationSelectorDescriptor(String type, ConfigurablePlugin plugin, GuiConfigDescriptorBuilder guiConfigDescBuilder, Set<String> results) The constructor for the AuthenticationSelectorDescriptor class.
AuthenticationSelectorDescriptor(String type, ConfigurablePlugin plugin, GuiConfigDescriptorBuilder guiConfigDescBuilder, Set<String> results, String version) The constructor for the AuthenticationSelectorDescriptor class.
AuthenticationSelectorDescriptor(String type, ConfigurablePlugin plugin, GuiConfigDescriptor guiConfigDesc, Set<String> results) The constructor for the AuthenticationSelectorDescriptor class.
AuthenticationSelectorDescriptor(String type, ConfigurablePlugin plugin, GuiConfigDescriptor guiConfigDesc, Set<String> results, String version) The constructor for the AuthenticationSelectorDescriptor class.

Method Summary

Modifier and Type	Method and Description
boolean	canSelectAuthnSourceResultType() Indicates if AuthenticationSelector.selectContext(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.util.Map<com.pingidentity.sdk.AuthenticationSourceKey, java.lang.String>, java.util.Map<java.lang.String, java.lang.Object>, java.lang.String) can possibly return an authentication source result type (i.e.: ResultType.ADAPTER_ID or ResultType.IDP_CONN_ID).
boolean	equals(Object o)
List<String>	getAdditionalResults(Configuration configuration) Instead of allowing extended result values to be specified in the Selector Result Values screen, a selector can override this method to add additional values based on the selector configuration.
int	hashCode()
boolean	isAnyMatchEnabled(Configuration configuration) The return value of this method determines whether the extended results for the selector are combined in to a single result, which is triggered when any of the selector's extended result values is matched.
boolean	isSortConfigurationAttributes(Configuration configuration) The return value of this method determines whether the configuration attributes for the selector need to be sorted, when viewed in the Authentication Policy tree.
void	setSelectAuthnSourceResultType(boolean selectAuthnSourceResultType) Sets if AuthenticationSelector.selectContext(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.util.Map<com.pingidentity.sdk.AuthenticationSourceKey, java.lang.String>, java.util.Map<java.lang.String, java.lang.Object>, java.lang.String) can possibly return an authentication source result type (i.e.: ResultType.ADAPTER_ID or ResultType.IDP_CONN_ID).
void	setSupportsExtendedResults(boolean supportsExtendedResults) This method is used to specify whether or not an Authentication Selector should allow additional result values to be specified via the Selector Result Values screen.

Methods inherited from class com.pingidentity.sdk.PluginDescriptor

getAttributeContractSet, getGuiConfigDescriptor, getGuiConfigDescriptorBuilder, getPluginClassName, getType, getVersion, isSupportsExtendedContract, setAttributeContactSet, setAttributeContractSet, setSupportsExtendedContract

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AuthenticationSelectorDescriptor

public AuthenticationSelectorDescriptor(String type,
                                        ConfigurablePlugin plugin,
                                        GuiConfigDescriptor guiConfigDesc,
                                        Set<String> results)

The constructor for the AuthenticationSelectorDescriptor class. The most notable parameter is the results Set which contains String values to be used for Authentication Selection runtime processing.

Parameters:

type - a text label for the Authentication Selector

plugin - the plugin instance

guiConfigDesc - the graphical user interface descriptor used for expressing the configurable fields of the Authentication Selector

results - the set of String values to be used for Authentication Selector runtime processing.

AuthenticationSelectorDescriptor

public AuthenticationSelectorDescriptor(String type,
                                        ConfigurablePlugin plugin,
                                        GuiConfigDescriptor guiConfigDesc,
                                        Set<String> results,
                                        String version)

The constructor for the AuthenticationSelectorDescriptor class. The most notable parameter is the results Set which contains String values to be used for Authentication Selection runtime processing.

Parameters:

type - a text label for the Authentication Selector

plugin - the plugin instance

guiConfigDesc - the graphical user interface descriptor used for expressing the configurable fields of the Authentication Selector

results - the set of String values to be used for Authentication Selector runtime processing.

version - The version of this PluginDescriptor.

AuthenticationSelectorDescriptor

public AuthenticationSelectorDescriptor(String type,
                                        ConfigurablePlugin plugin,
                                        GuiConfigDescriptorBuilder guiConfigDescBuilder,
                                        Set<String> results)

The constructor for the AuthenticationSelectorDescriptor class. The most notable parameter is the results Set which contains String values to be used for Authentication Selection runtime processing.

Parameters:

type - a text label for the Authentication Selector

plugin - the plugin instance

guiConfigDescBuilder - the graphical user interface descriptor builder used for expressing the configurable fields of the Authentication Selector. Everytime a GUI configuration descriptor is needed, a new one will be created by the builder.

results - the set of String values to be used for Authentication Selector runtime processing.

AuthenticationSelectorDescriptor

public AuthenticationSelectorDescriptor(String type,
                                        ConfigurablePlugin plugin,
                                        GuiConfigDescriptorBuilder guiConfigDescBuilder,
                                        Set<String> results,
                                        String version)

The constructor for the AuthenticationSelectorDescriptor class. The most notable parameter is the results Set which contains String values to be used for Authentication Selection runtime processing.

Parameters:

type - a text label for the Authentication Selector

plugin - the plugin instance

guiConfigDescBuilder - the graphical user interface descriptor builder used for expressing the configurable fields of the Authentication Selector. Everytime a GUI configuration descriptor is needed, a new one will be created by the builder.

results - the set of String values to be used for Authentication Selector runtime processing.

version - The version of this PluginDescriptor.

Method Detail

setSupportsExtendedResults

public void setSupportsExtendedResults(boolean supportsExtendedResults)

This method is used to specify whether or not an Authentication Selector should allow additional result values to be specified via the Selector Result Values screen.

Parameters:

supportsExtendedResults - flag indicating whether extended results should be allowed to be specified via the Selector Result Values screen.

canSelectAuthnSourceResultType

public boolean canSelectAuthnSourceResultType()

Indicates if AuthenticationSelector.selectContext(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.util.Map<com.pingidentity.sdk.AuthenticationSourceKey, java.lang.String>, java.util.Map<java.lang.String, java.lang.Object>, java.lang.String) can possibly return an authentication source result type (i.e.: ResultType.ADAPTER_ID or ResultType.IDP_CONN_ID). Returns false by default

Returns:

true if AuthenticationSelector.selectContext(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.util.Map<com.pingidentity.sdk.AuthenticationSourceKey, java.lang.String>, java.util.Map<java.lang.String, java.lang.Object>, java.lang.String) will return an authentication source result type.

Since:

9.0.3

setSelectAuthnSourceResultType

public void setSelectAuthnSourceResultType(boolean selectAuthnSourceResultType)

Sets if AuthenticationSelector.selectContext(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.util.Map<com.pingidentity.sdk.AuthenticationSourceKey, java.lang.String>, java.util.Map<java.lang.String, java.lang.Object>, java.lang.String) can possibly return an authentication source result type (i.e.: ResultType.ADAPTER_ID or ResultType.IDP_CONN_ID).

Parameters:

selectAuthnSourceResultType - true if AuthenticationSelector.selectContext(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.util.Map<com.pingidentity.sdk.AuthenticationSourceKey, java.lang.String>, java.util.Map<java.lang.String, java.lang.Object>, java.lang.String) will return an authentication source result type, false otherwise.

Since:

9.0.3

getAdditionalResults

public List<String> getAdditionalResults(Configuration configuration)

Instead of allowing extended result values to be specified in the Selector Result Values screen, a selector can override this method to add additional values based on the selector configuration. If setSupportsExtendedResults(boolean) has been called with 'true', then this method will not be invoked.

Parameters:

configuration - The configuration of a selector instance.

Returns:

Additional result values for the instance.

Since:

9.1

isAnyMatchEnabled

public boolean isAnyMatchEnabled(Configuration configuration)

The return value of this method determines whether the extended results for the selector are combined in to a single result, which is triggered when any of the selector's extended result values is matched.

Parameters:

configuration - The configuration of a selector instance.

Returns:

true or false signifying whether "Any" match has been enabled for the instance.

Since:

9.3

isSortConfigurationAttributes

public boolean isSortConfigurationAttributes(Configuration configuration)

The return value of this method determines whether the configuration attributes for the selector need to be sorted, when viewed in the Authentication Policy tree.

Parameters:

configuration - The configuration of a selector instance.

Returns:

true or false signifying whether sorting is needed

Since:

9.3

equals

public boolean equals(Object o)

Overrides:

equals in class PluginDescriptor

hashCode

public int hashCode()

Overrides:

hashCode in class PluginDescriptor