Package com.pingidentity.sdk

Class GuiConfigDescriptor

  • Direct Known Subclasses:
    AdapterConfigurationGuiDescriptor
    public class GuiConfigDescriptor
extends Object
    This class is used to describe user interface components of a plugin implementation to the PingFederate server.

    • Constructor Detail

      • GuiConfigDescriptor

        public GuiConfigDescriptor()

      • GuiConfigDescriptor

        public GuiConfigDescriptor​(String description)

    • 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 descriptor.
        Parameters:
        fieldDescriptor - the field to add.

      • getFields

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

      • addAdvancedField

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

        'Advanced' fields do not show up on the GUI page initially - the user has to select to see and manipulate the advanced fields. Care should be used with advanced fields - they should be used for configuration options that will rarely need to be changed and default values that won't cause validation errors should be provided.

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

      • getAdvancedFields

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

      • addTable

        public void addTable​(TableDescriptor table)
        Add a table to the ordered list of Tables in this descriptor.

        Please note that TableDescriptor names must be unique per descriptor.
        Parameters:
        table - the Table to add.

      • getTables

        public List<TableDescriptor> getTables()
        Gets the ordered list of Tables.
        Returns:
        a List of Tables.

      • addValidator

        public void addValidator​(ConfigurationValidator configurationValidator)
        Add a ConfigurationValidator to the ordered list of ConfigurationValidators for this descriptor.
        Parameters:
        configurationValidator -

      • addListener

        public void addListener​(ConfigurationListener configurationListener)
        Add a ConfigurationListener to the ordered list of ConfigurationListeners for this descriptor.
        Parameters:
        configurationListener -

      • getValidationChain

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

      • getListenerChain

        public List<ConfigurationListener> getListenerChain()
        Gets the ordered list of ConfigurationListeners.
        Returns:
        a List of ConfigurationListeners.

      • addPreRenderCallback

        public void addPreRenderCallback​(PreRenderCallback callback)
        Add a PreRenderCallback to the ordered list of callbacks for this descriptor.
        Parameters:
        callback - the PreRenderCallback add
        Since:
        6.6

      • getPreRenderCallbackChain

        public List<PreRenderCallback> getPreRenderCallbackChain()
        Gets the ordered list of callbacks.
        Returns:
        a list of PreRenderCallback
        Since:
        6.6

      • addAction

        public void addAction​(ActionDescriptor action)
        Add an action to this descriptor.
        Parameters:
        action - the ActionDescriptor to add.

      • getActions

        public List<ActionDescriptor> getActions()
        Gets the list of ActionDescriptors.
        Returns:
        a List of ActionDescriptors.

      • hasActions

        public boolean hasActions()
        Returns whether or not this descriptor has actions.
        Returns:
        true when actions exist.

      • 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.

      • getAllDescriptorTypesInUse

        public Set<Class<? extends FieldDescriptor>> getAllDescriptorTypesInUse()
        Returns:
        Set containing all FieldDescriptor classes in use

      • addSummaryDescriptor

        public void addSummaryDescriptor​(ReadOnlyDescriptor readOnlyDescriptor)
        Add a read only summary descriptor to this GUI configuration descriptor. These will be rendered on the GUI summary page in the order that they were added.

        Please note that ReadOnlyDescriptor names must be unique per descriptor.
        Parameters:
        readOnlyDescriptor - the read only summary descriptor to add.
        Since:
        9.1

      • getSummaryDescriptors

        public List<ReadOnlyDescriptor> getSummaryDescriptors()
        Gets the ordered list of read only summary descriptors.
        Returns:
        a List of ReadOnlyDescriptor.
        Since:
        9.1