com.pingidentity.pa.sdk.accessor

Interface DependantFieldAccessor

All Known Implementing Classes:

ParentField.NONE

public interface DependantFieldAccessor

A DependantFieldAccessor allows a plugin to indicate the values that are valid for one of its ConfigurationField, based on the value of another of its ConfigurationFields. This relationship between fields is described by a ConfigurationDependentFieldOption

A plugin can establish this relationship between ConfigurationFields by:

• Setting the Class instance for the concrete DependantFieldAccessor via the ParentField.dependantFieldAccessor() element associated with the field in a PluginConfiguration class that controls the valid values for the other field.
• Construct a DynamicConfigurationParentField via its DynamicConfigurationParentField.DynamicConfigurationParentField(String, Class) constructor and pass it to the ConfigurationField.setParentField(ConfigurationParentField) method for the ConfigurationField, the valid values for which are controlled by the values of the parent field.

Typically, a plugin should not need to utilize this interface directly.

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

See Also:

ConfigurationDependentFieldOption

Method Summary

Modifier and Type	Method and Description
List<ConfigurationDependentFieldOption>	dependentOptions() Method for acquiring the List of ConfigurationDependentFieldOptions to be exposed in the plugin's descriptor in the Administrative API.

Method Detail

dependentOptions

List<ConfigurationDependentFieldOption> dependentOptions()

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

Returns:

the unmodifiable List of ConfigurationDependentFieldOption