Package org.sourceid.saml20.adapter.gui

Class PingOneEnvironmentFieldDescriptor

java.lang.Object

org.sourceid.saml20.adapter.gui.FieldDescriptor

org.sourceid.saml20.adapter.gui.FilterableSelectionFieldDescriptor

org.sourceid.saml20.adapter.gui.PingOneEnvironmentFieldDescriptor

All Implemented Interfaces:

Serializable

public class PingOneEnvironmentFieldDescriptor
extends FilterableSelectionFieldDescriptor

A filterable dropdown control that enables the selection of a PingOne connection and corresponding environment in a way that's user friendly and scalable. It is recommended to use the PingOneEnvironmentValidator class to validate this descriptor.

The selected field value is stored in the following format: connectionId|environmentId

Since:

10.2

See Also:

PingOneEnvironmentValidator, PingOneEnvironmentAccessor, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.sourceid.saml20.adapter.gui.FilterableSelectionFieldDescriptor

FilterableSelectionFieldDescriptor.FilterableSelectionFieldDefaultValidator, FilterableSelectionFieldDescriptor.QueryParam, FilterableSelectionFieldDescriptor.SearchableType, FilterableSelectionFieldDescriptor.SearchableTypeConfig

Nested classes/interfaces inherited from class org.sourceid.saml20.adapter.gui.FieldDescriptor

FieldDescriptor.FieldValidationWrapper

Field Summary

Fields inherited from class org.sourceid.saml20.adapter.gui.FilterableSelectionFieldDescriptor

SELECTED_VALUE_DELIMITER, STORAGE_KEY_DELIMITER

Constructor Summary

Constructors

Constructor	Description
PingOneEnvironmentFieldDescriptor(String name, String description)	Creates a new PingOneEnvironmentFieldDescriptor.

Method Summary

Modifier and Type	Method	Description
static String	getConnectionId(String fieldValue)	Obtains the connection ID from the stored field value.
static String	getEnvironmentId(String fieldValue)	Obtains the PingOne environment ID from the stored field value.
List<FilterableSelectionFieldDescriptor.SearchableTypeConfig>	getSearchableTypes()	Gets the list of search type configurations of a FilterableSelectionFieldDescriptor instance.
String	getSelectedDisplayName(String valueForStorage)	Gets the display string value of a stored value returned by parseSelectedValueForStorage.

Methods inherited from class org.sourceid.saml20.adapter.gui.FilterableSelectionFieldDescriptor

getFormattedValue, isValidFormat, parseSelectedValueForStorage

Methods inherited from class org.sourceid.saml20.adapter.gui.FieldDescriptor

addValidator, addValidator, getDefaultForLegacyConfig, getDefaultValue, getDescription, getLabel, getName, getValidationChain, isHidden, setDefaultForLegacyConfig, setDefaultValue, setHidden, setLabel

Methods inherited from class java.lang.Object

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

Constructor Detail

PingOneEnvironmentFieldDescriptor

public PingOneEnvironmentFieldDescriptor(String name,
                                         String description)

Creates a new PingOneEnvironmentFieldDescriptor.

Parameters:

name - the field name

description - a helpful description of the field

Method Detail

getSearchableTypes

public List<FilterableSelectionFieldDescriptor.SearchableTypeConfig> getSearchableTypes()

Description copied from class: FilterableSelectionFieldDescriptor

Gets the list of search type configurations of a FilterableSelectionFieldDescriptor instance.

Specified by:

getSearchableTypes in class FilterableSelectionFieldDescriptor

Returns:

a list of search type configuration supported by this filterable selection field descriptor

getSelectedDisplayName

public String getSelectedDisplayName(String valueForStorage)

Description copied from class: FilterableSelectionFieldDescriptor

Gets the display string value of a stored value returned by parseSelectedValueForStorage.

     For example, when a unique OAuth client ID is returned by parseSelectedValueForStorage, instead of using the
     client ID as the display string, a FilterableSelectionFieldDescriptor implementation may opt to display the
     corresponding client name of client ID instead, possibly obtained through data store query.
 

Overrides:

getSelectedDisplayName in class FilterableSelectionFieldDescriptor

Parameters:

valueForStorage - typically an unique ID of a data object, e.g. a connection (system) ID, an adapter ID, or an OAuth client ID etc.

Returns:

drop-down box display value for the selected item

getConnectionId

public static String getConnectionId(String fieldValue)

Obtains the connection ID from the stored field value.

Parameters:

fieldValue - The stored field value.

Returns:

The connection ID, or null if the fieldValue is incorrectly formatted.

getEnvironmentId

public static String getEnvironmentId(String fieldValue)

Obtains the PingOne environment ID from the stored field value.

Parameters:

fieldValue - The stored field value.

Returns:

The environment ID, or null if the fieldValue is incorrectly formatted.