Package com.pingidentity.sources

Class SourceDescriptor

java.lang.Object

com.pingidentity.sdk.PluginDescriptor

com.pingidentity.sources.SourceDescriptor

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CustomDataSourceDriverDescriptor

public class SourceDescriptor
extends PluginDescriptor
implements Serializable

This class returns metadata describing a ConfigurableDriver to the PingFederate server. The metadata is used by PingFederate to generate a dynamic UI that allows the user to interact with the driver.

See Also:

• ConfigurableDriver.getSourceDescriptor()
• Serialized Form

Field Summary

Fields inherited from class com.pingidentity.sdk.PluginDescriptor

UNDEFINED

Constructor Summary

Constructors

Constructor	Description
SourceDescriptor(ConfigurableDriver driver, String type)	Creates a new SourceDescriptor with no custom GUI configuration screen.
SourceDescriptor(ConfigurableDriver driver, String type, AdapterConfigurationGuiDescriptor adapterConfigurationGuiDesc)	Creates a new SourceDescriptor with a custom GUI configuration screen.

Method Summary

Modifier and Type	Method	Description
AdapterConfigurationGuiDescriptor	getConfigurationGuiDescriptor()	Gets the AdapterConfigurationGuiDescriptor for the driver that this object describes.
String	getDriverClassName()	Gets the class name of driver associated with this SourceDescriptor.
boolean	hasActions()	Checks if the AdapterConfigurationGuiDescriptor has actions.

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 Details

SourceDescriptor

public SourceDescriptor(ConfigurableDriver driver,
 String type)

Creates a new SourceDescriptor with no custom GUI configuration screen.

Parameters:

driver - Driver implementation this descriptor describes.

type - the type of the adapter is the 'friendly' name that will show up in the PF GUI - usually in the context of selecting from a number of available adapters. A relatively descriptive and unique name should be used.

SourceDescriptor

public SourceDescriptor(ConfigurableDriver driver,
 String type,
 AdapterConfigurationGuiDescriptor adapterConfigurationGuiDesc)

Creates a new SourceDescriptor with a custom GUI configuration screen.

Parameters:

driver - the driver implementation this descriptor describes.

type - the type of the driver is the 'friendly' name that will show up in the PF GUI - usually in the context of selecting from a number of available drivers. A relatively descriptive and unique name should be used.

adapterConfigurationGuiDesc - a descriptor object that tells PingFederate how to render the configuration screen(s) for the driver this object describes as well as how to validate the input from the front end.

Method Details

getDriverClassName

public String getDriverClassName()

Gets the class name of driver associated with this SourceDescriptor.

Returns:

the classname as a String.

getConfigurationGuiDescriptor

public AdapterConfigurationGuiDescriptor getConfigurationGuiDescriptor()

Gets the AdapterConfigurationGuiDescriptor for the driver that this object describes.

Returns:

the GUI descriptor of the driver that this object describes.

hasActions

public boolean hasActions()

Checks if the AdapterConfigurationGuiDescriptor has actions.

Returns:

true if the driver has actions