Package com.pingidentity.sources.gui

Class FilterFieldsGuiDescriptor

  • public class FilterFieldsGuiDescriptor
extends Object
    This class provides metadata to PingFederate that is used to display a dynamic UI. The user enters information into this UI that can filter or limit the result set. The filter information is then sent to the CustomDataSourceDriver.retrieveValues(Collection, SimpleFieldList) method during attribute retrieval.

    Note: One of the available fields to add to the FilterFieldsGuiDescriptor is UploadFileFieldDescriptor. This field descriptor allows a user to upload a file. If this field is added to the FilterFieldsGuiDescriptor, the file will be uploaded when the initialize upload is invoked and then saved as part of the connection. To refresh the information (if the file content changes) the user will need to edit the connection and re-invoke the UpLoadFileFieldDescriptor. This information will be saved as part of the connection information, possiblely making the connection xml footprint very large (depending upon the file size).
    See Also:
    CustomDataSourceDriverDescriptor, CustomDataSourceDriver.retrieveValues(Collection, SimpleFieldList)

    • Constructor Detail

      • FilterFieldsGuiDescriptor

        public FilterFieldsGuiDescriptor()
        Default constructor

      • FilterFieldsGuiDescriptor

        public FilterFieldsGuiDescriptor​(String description)
        Create a new FilterFieldsGuiDescriptor with a description.
        Parameters:
        description - the description that will be displayed at the top of the GUI configuration page.

    • Method Detail

      • addField

        public void addField​(FieldDescriptor fieldDescriptor)
        Add a user entry field to this GUI configuration descriptor. The field will be rendered on the GUI page in the order that they were added.

        Please note that FieldDescriptor names must be unique per FilterFieldsGuiDescriptor.
        Parameters:
        fieldDescriptor - the field to add.

      • getFields

        public List<FieldDescriptor> getFields()
        Gets the ordered list of FieldDescriptors.
        Returns:
        a List of FieldDescriptors.

      • getDescription

        public String getDescription()
        Gets the description.
        Returns:
        the description.

      • setDescription

        public void setDescription​(String description)
        Set the description that will be displayed at the top of the GUI configuration page.
        Parameters:
        description - the new description.

      • addValidator

        public void addValidator​(ConfigurationValidator configurationValidator)
        Add a ConfigurationValidator to the ordered list of ConfigurationValidators for this descriptor. This ConfigurationValidator will be invoked when validating the filter. It can be used when the plugin configuration is needed to perform filter validation, or to validate the contents of interdependent filter fields.
        Parameters:
        configurationValidator -

      • getValidationChain

        public List<ConfigurationValidator> getValidationChain()
        Gets the ordered list of ConfigurationValidators.
        Returns:
        a List of ConfigurationValidators.