com.pingidentity.pa.sdk.accessor

Interface ConfigurationModelAccessor<T>

Type Parameters:

T - the model type

All Known Subinterfaces:

KeyPairAccessor, ThirdPartyServiceAccessor, TrustedCertificateGroupAccessor

All Known Implementing Classes:

UIElement.NONE

public interface ConfigurationModelAccessor<T>

ConfigurationModelAccessors provide access to PingAccess administrative configuration from plugins.

To gain access to PingAccess administrative configuration, a plugin associates a ConfigurationModelAccessor implementation Class with one of its ConfigurationFields. A plugin can associate the ConfigurationModelAccessor implementation Class with one of its ConfigurationFields by any of the following mechanisms:

• Setting the Class instance via the UIElement.modelAccessor() element associated with the field in a PluginConfiguration class
• Invoking the ConfigurationBuilder.dynamicOptions(Class) method on the ConfigurationBuilder instance used to create the ConfigurationFields for the plugin.

PingAccess uses the ConfigurationModelAccessor Class associated with a ConfigurationField to do the following:

• Generate ConfigurationOptions instances that are used to create the plugin's descriptor in the Administrative API.
• Translate from the field value configured via the Administrative API to the configuration model instance.

Since PingAccess handles the translation of the field value to the configuration model and vice-versa, plugins do not typically need to utilize the ConfigurationModelAccessor interface.

If a plugin chooses to use the ConfigurationModelAccessor interface, a ConfigurationModelAccessorFactory instance is used to construct instances. A plugin should only utilize the ConfigurationModelAccessor interface in its ConfigurablePlugin.configure(PluginConfiguration) method. A ConfigurationModelAccessor instance must never be used in the context of handling a Request or Response, as in RequestInterceptor.handleRequest(Exchange) or ResponseInterceptor.handleResponse(Exchange).

Method Summary

Modifier and Type	Method and Description
Optional<T>	get(String id) Method for acquiring the configuration model using the field value from the configuration submitted to the Administrative API.
Collection<ConfigurationOption>	options() Method for acquiring the Collection of ConfigurationOptions to be exposed in the plugin's descriptor in the Administrative API.

Method Detail

options

Collection<ConfigurationOption> options()

Method for acquiring the Collection of ConfigurationOptions to be exposed in the plugin's descriptor in the Administrative API.

Returns:

an unmodifiable Collection of ConfigurationOption

get

Optional<T> get(String id)

Method for acquiring the configuration model using the field value from the configuration submitted to the Administrative API. The id provided is expected to be in the list of values provided by the options() call.

Parameters:

id - the ConfigurationOption value to lookup the configuration model

Returns:

the model identified by the specified id or an empty Optional if no model corresponds to the id