Package com.pingidentity.sources

Class CustomDataSourceDriverDescriptor

java.lang.Object

com.pingidentity.sdk.PluginDescriptor

com.pingidentity.sources.SourceDescriptor

com.pingidentity.sources.CustomDataSourceDriverDescriptor

All Implemented Interfaces:

Serializable

public class CustomDataSourceDriverDescriptor
extends SourceDescriptor

This class provides metadata describing a driver that implements the CustomDataSourceDriver interface. The metadata can be easily transformed by PingFederate into dynamic UI screen(s).

This descriptor adds the ability to provide fields that can be used to filter data to the CustomDataSourceDriver during value retrieval CustomDataSourceDriver.retrieveValues(Collection, SimpleFieldList).

See Also:

ConfigurableDriver.getSourceDescriptor(), Serialized Form

Field Summary

Fields inherited from class com.pingidentity.sdk.PluginDescriptor

UNDEFINED

Constructor Summary

Constructors

Constructor	Description
CustomDataSourceDriverDescriptor(ConfigurableDriver adapter, String type)	Passthrough constructor to the superclass - SourceDescriptor
CustomDataSourceDriverDescriptor(ConfigurableDriver adapter, String type, AdapterConfigurationGuiDescriptor adapterConfigurationGuiDesc, FilterFieldsGuiDescriptor fieldsDescriptor)	Passthrough constructor to the superclass - SourceDescriptor
CustomDataSourceDriverDescriptor(ConfigurableDriver adapter, String type, AdapterConfigurationGuiDescriptor adapterConfigurationGuiDesc, FilterFieldsGuiDescriptor fieldsDescriptor, boolean showSelectCustomSourceFields)	Passthrough constructor to the superclass - SourceDescriptor
CustomDataSourceDriverDescriptor(ConfigurableDriver adapter, String type, AdapterConfigurationGuiDescriptor adapterConfigurationGuiDesc, FilterFieldsGuiDescriptor fieldsDescriptor, boolean showSelectCustomSourceFields, GuiConfigDescriptorBuilder guiConfigDescriptorBuilder)	Passthrough constructor to the superclass - SourceDescriptor

Method Summary

Modifier and Type	Method	Description
FilterFieldsGuiDescriptor	getFilterFieldsDescriptor()	Returns the filter metadata associated with a CustomDataSourceDriver
boolean	isShowSelectCustomSourceFields()	Indicates if the administrative console tab to select fields for this custom data source will be visible during attribute fulfillment.
void	setFilterFieldsDescriptor(FilterFieldsGuiDescriptor fieldsDescriptor)	Sets the filter descriptor for a CustomDataSourceDriver
void	setShowSelectCustomSourceFields(boolean showSelectCustomSourceFields)	Set the flag to indicate if the administrative console tab to select fields for this data source will be visible during attribute fulfillment.

Methods inherited from class com.pingidentity.sources.SourceDescriptor

getConfigurationGuiDescriptor, getDriverClassName, hasActions

Methods inherited from class com.pingidentity.sdk.PluginDescriptor

equals, getAttributeContractSet, getGuiConfigDescriptor, getGuiConfigDescriptorBuilder, getMetadata, getPluginClassName, getType, getVersion, hashCode, isSupportsExtendedContract, setAttributeContactSet, setAttributeContractSet, setMetadata, setSupportsExtendedContract

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CustomDataSourceDriverDescriptor

public CustomDataSourceDriverDescriptor(ConfigurableDriver adapter,
                                        String type)

Passthrough constructor to the superclass - SourceDescriptor

See Also:

SourceDescriptor(ConfigurableDriver, String)

CustomDataSourceDriverDescriptor

public CustomDataSourceDriverDescriptor(ConfigurableDriver adapter,
                                        String type,
                                        AdapterConfigurationGuiDescriptor adapterConfigurationGuiDesc,
                                        FilterFieldsGuiDescriptor fieldsDescriptor)

Passthrough constructor to the superclass - SourceDescriptor

See Also:

SourceDescriptor(ConfigurableDriver, String, AdapterConfigurationGuiDescriptor)

CustomDataSourceDriverDescriptor

public CustomDataSourceDriverDescriptor(ConfigurableDriver adapter,
                                        String type,
                                        AdapterConfigurationGuiDescriptor adapterConfigurationGuiDesc,
                                        FilterFieldsGuiDescriptor fieldsDescriptor,
                                        boolean showSelectCustomSourceFields)

Passthrough constructor to the superclass - SourceDescriptor

See Also:

SourceDescriptor(ConfigurableDriver, String, AdapterConfigurationGuiDescriptor)

CustomDataSourceDriverDescriptor

public CustomDataSourceDriverDescriptor(ConfigurableDriver adapter,
                                        String type,
                                        AdapterConfigurationGuiDescriptor adapterConfigurationGuiDesc,
                                        FilterFieldsGuiDescriptor fieldsDescriptor,
                                        boolean showSelectCustomSourceFields,
                                        GuiConfigDescriptorBuilder guiConfigDescriptorBuilder)

Passthrough constructor to the superclass - SourceDescriptor

See Also:

SourceDescriptor(ConfigurableDriver, String, AdapterConfigurationGuiDescriptor)

Method Detail

getFilterFieldsDescriptor

public FilterFieldsGuiDescriptor getFilterFieldsDescriptor()

Returns the filter metadata associated with a CustomDataSourceDriver

Returns:

the FilterFieldsGuiDescriptor

setFilterFieldsDescriptor

public void setFilterFieldsDescriptor(FilterFieldsGuiDescriptor fieldsDescriptor)

Sets the filter descriptor for a CustomDataSourceDriver

Parameters:

fieldsDescriptor - FilterFieldsGuiDescriptor

isShowSelectCustomSourceFields

public boolean isShowSelectCustomSourceFields()

Indicates if the administrative console tab to select fields for this custom data source will be visible during attribute fulfillment.

Returns:

showSelectCustomSourceFields

Since:

9.2

setShowSelectCustomSourceFields

public void setShowSelectCustomSourceFields(boolean showSelectCustomSourceFields)

Set the flag to indicate if the administrative console tab to select fields for this data source will be visible during attribute fulfillment.

Parameters:

showSelectCustomSourceFields - Flag to set the visibility of the tab to selects fields for this data source.

Since:

9.2