com.pingidentity.sources.gui

Class FilterFieldsGuiDescriptor

java.lang.Object

com.pingidentity.sources.gui.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 Summary

Constructors

Constructor and Description
FilterFieldsGuiDescriptor() Default constructor
FilterFieldsGuiDescriptor(String description) Create a new FilterFieldsGuiDescriptor with a description.

Method Summary

Modifier and Type	Method and Description
void	addField(FieldDescriptor fieldDescriptor) Add a user entry field to this GUI configuration descriptor.
String	getDescription() Gets the description.
List<FieldDescriptor>	getFields() Gets the ordered list of FieldDescriptors.
void	setDescription(String description) Set the description that will be displayed at the top of the GUI configuration page.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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.