Package org.sourceid.saml20.adapter.gui

Class OAuthScopeSelectionFieldDescriptor

java.lang.Object

org.sourceid.saml20.adapter.gui.FieldDescriptor

org.sourceid.saml20.adapter.gui.FilterableSelectionFieldDescriptor

org.sourceid.saml20.adapter.gui.OAuthScopeSelectionFieldDescriptor

All Implemented Interfaces:

Serializable

public class OAuthScopeSelectionFieldDescriptor
extends FilterableSelectionFieldDescriptor

A filterable dropdown control that enables the selection of OAuth scopes in a way that's user-friendly and scalable.

Since:

12.1

See Also:

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

Modifier and Type	Field	Description
static String	COMMON_SCOPE_GROUP_SUFFIX
static String	COMMON_SCOPE_SUFFIX
static String	EXCLUSIVE_SCOPE_GROUP_SUFFIX
static String	EXCLUSIVE_SCOPE_SUFFIX

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

SELECTED_VALUE_DELIMITER, STORAGE_KEY_DELIMITER

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
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.
static String	storageKeyToScopeName(String storageKey)	Returns the scope name from the storage key value.

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

Field Detail

COMMON_SCOPE_SUFFIX

public static final String COMMON_SCOPE_SUFFIX

See Also:

Constant Field Values

COMMON_SCOPE_GROUP_SUFFIX

public static final String COMMON_SCOPE_GROUP_SUFFIX

See Also:

Constant Field Values

EXCLUSIVE_SCOPE_SUFFIX

public static final String EXCLUSIVE_SCOPE_SUFFIX

See Also:

Constant Field Values

EXCLUSIVE_SCOPE_GROUP_SUFFIX

public static final String EXCLUSIVE_SCOPE_GROUP_SUFFIX

See Also:

Constant Field Values

Constructor Detail

OAuthScopeSelectionFieldDescriptor

public OAuthScopeSelectionFieldDescriptor(String name,
                                          String description)

Creates a new OAuthScopeSelectionFieldDescriptor.

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

storageKeyToScopeName

public static String storageKeyToScopeName(String storageKey)

Returns the scope name from the storage key value.

Parameters:

storageKey - the value stored.

Returns:

the scope name.