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
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
The selected field value is stored in the following format: connectionId|environmentId
PingOneEnvironmentValidator
class to validate this descriptor.
The selected field value is stored in the following format: connectionId|environmentId
- Since:
- 10.2
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.sourceid.saml20.adapter.gui.FilterableSelectionFieldDescriptor
FilterableSelectionFieldDescriptor.FilterableSelectionFieldDefaultValidator, FilterableSelectionFieldDescriptor.QueryParam, FilterableSelectionFieldDescriptor.SearchableType, FilterableSelectionFieldDescriptor.SearchableTypeConfigNested 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
ConstructorsConstructorDescriptionPingOneEnvironmentFieldDescriptor(String name, String description) Creates a new PingOneEnvironmentFieldDescriptor. -
Method Summary
Modifier and TypeMethodDescriptionstatic StringgetConnectionId(String fieldValue) Obtains the connection ID from the stored field value.static StringgetEnvironmentId(String fieldValue) Obtains the PingOne environment ID from the stored field value.Gets the list of search type configurations of a FilterableSelectionFieldDescriptor instance.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, parseSelectedValueForStorageMethods inherited from class org.sourceid.saml20.adapter.gui.FieldDescriptor
addValidator, addValidator, getDefaultForLegacyConfig, getDefaultValue, getDescription, getLabel, getName, getValidationChain, isHidden, setDefaultForLegacyConfig, setDefaultValue, setHidden, setLabel
-
Constructor Details
-
PingOneEnvironmentFieldDescriptor
Creates a new PingOneEnvironmentFieldDescriptor.- Parameters:
name- the field namedescription- a helpful description of the field
-
-
Method Details
-
getSearchableTypes
Description copied from class:FilterableSelectionFieldDescriptorGets the list of search type configurations of a FilterableSelectionFieldDescriptor instance.- Specified by:
getSearchableTypesin classFilterableSelectionFieldDescriptor- Returns:
- a list of search type configuration supported by this filterable selection field descriptor
-
getSelectedDisplayName
Description copied from class:FilterableSelectionFieldDescriptorGets 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:
getSelectedDisplayNamein classFilterableSelectionFieldDescriptor- 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
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
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.
-