public class OAuthClientSelectionFieldDescriptor extends FilterableSelectionFieldDescriptor
| Modifier and Type | Class and Description |
|---|---|
static class |
OAuthClientSelectionFieldDescriptor.GrantType
Used in the constructor of OAuthClientSelectionFieldDescriptor to specify grant type requirement of OAuth clients that are searchable in the resulting filterable drop-down menu.
|
FilterableSelectionFieldDescriptor.FilterableSelectionFieldDefaultValidator, FilterableSelectionFieldDescriptor.QueryParam, FilterableSelectionFieldDescriptor.SearchableType, FilterableSelectionFieldDescriptor.SearchableTypeConfigFieldDescriptor.FieldValidationWrapperSELECTED_VALUE_DELIMITER, STORAGE_KEY_DELIMITER| Constructor and Description |
|---|
OAuthClientSelectionFieldDescriptor(String name,
String description,
List<OAuthClientSelectionFieldDescriptor.GrantType> includeGrantTypeList)
Creates a new OAuthClientSelectionFieldDescriptor.
|
| Modifier and Type | Method and Description |
|---|---|
String |
getFormattedValue(String value)
Gets the formatted value, by default returns the same string value returned by getSelectedDisplayName.
|
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.
|
String |
parseSelectedValueForStorage(String selectedValue)
Parses the selected value of the filterable drop-down menu for storage.
|
isValidFormataddValidator, addValidator, getDefaultForLegacyConfig, getDefaultValue, getDescription, getLabel, getName, getValidationChain, isHidden, setDefaultForLegacyConfig, setDefaultValue, setHidden, setLabelpublic OAuthClientSelectionFieldDescriptor(String name, String description, List<OAuthClientSelectionFieldDescriptor.GrantType> includeGrantTypeList)
name - the field namedescription - a helpful description of the fieldincludeGrantTypeList - a list of grant types to restrict searchable clients in the resulting filterable drop-down menu
NOTE:
An OAuth client is included in the search space of the filterable drop-down menu if and only if it supports
at least one of the grant types specified in this list. If the list is empty, all clients are included.
public String parseSelectedValueForStorage(String selectedValue)
FilterableSelectionFieldDescriptorparseSelectedValueForStorage in class FilterableSelectionFieldDescriptorselectedValue - selected value of the filterable drop-down menu, following the format "[search type tab title]-[selected entry ID]"
NOTE:
The search type tab title part is only useful when the filterable selection field descriptor implementation
supports multiple search types, so for implementation that supports only one search type, the tab title may
be parsed out and discarded.
For example, for the selected value, 'OAuth Clients-sampleOAuthClient', where 'OAuth Clients' is the search
type tab title and 'sampleOAuthClient' is the unique OAuth client ID that may be used to retrieve an OAuth
client data object from a data store, a FilterableSelectionFieldDescriptor implementation that only supports
searches over OAuth clients may have no reason to keep track of the search type, so the tab title
'OAuth Clients' may be discarded.
public String getSelectedDisplayName(String valueForStorage)
FilterableSelectionFieldDescriptor
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.
getSelectedDisplayName in class FilterableSelectionFieldDescriptorvalueForStorage - typically an unique ID of a data object, e.g. a connection (system) ID, an adapter ID, or an OAuth client ID etc.public String getFormattedValue(String value)
FilterableSelectionFieldDescriptorgetFormattedValue in class FilterableSelectionFieldDescriptorvalue - typically an unique ID of a data object, e.g. a connection ID, an adapter ID, or an OAuth client ID etc.public List<FilterableSelectionFieldDescriptor.SearchableTypeConfig> getSearchableTypes()
FilterableSelectionFieldDescriptorgetSearchableTypes in class FilterableSelectionFieldDescriptorCopyright 2019 Ping Identity Corp. All rights reserved.