com.pingidentity.sources

Interface ConfigurableDriver

All Superinterfaces:

ConfigurablePlugin

All Known Subinterfaces:

CustomDataSourceDriver

public interface ConfigurableDriver
extends ConfigurablePlugin

Base interface that consolidates common methods across the sources package. This interface is very similar to ConfigurableAuthnAdapter but has been separated out to allow adapters and drivers to diverge.

Classes derived directly from this interface are not supported at this time. The only 'usable' implementation of this interface is CustomDataSourceDriver. Future versions of PingFederate may remove this limitation.

This interface defines methods to get the configurable UI screen getSourceDescriptor() and provide configuration information to a ConfigurableDriver instance via configure(Configuration).

See Also:

SourceDescriptor, Configuration

Method Summary

Modifier and Type	Method and Description
void	configure(Configuration configuration) This method is called by the PingFederate server to push configuration values entered by the administrator via the dynamically rendered GUI configuration screen in the PingFederate administration console.
SourceDescriptor	getSourceDescriptor() PingFederate will invoke this method on your driver to discover the metadata necessary to correctly configure it.

Method Detail

getSourceDescriptor

SourceDescriptor getSourceDescriptor()

PingFederate will invoke this method on your driver to discover the metadata necessary to correctly configure it. PingFederate will utilize this information to dynamically draw a screen that will allow a user to correctly configure your driver for use.

The metadata returned by this method should be static. Allowing the same driver to produce different configuration screens is not supported.

Returns:

a SourceDescriptor that contains the UI information necessary to display the configuration screen.

configure

void configure(Configuration configuration)

This method is called by the PingFederate server to push configuration values entered by the administrator via the dynamically rendered GUI configuration screen in the PingFederate administration console. Your implementation should use the Configuration parameter to configure its own internal state as needed. The tables and fields available in the Configuration object will correspond to the tables and fields defined in the AdapterConfigurationGuiDescriptor of the SourceDescriptor class returned by the getSourceDescriptor() method of this class.

Each time the PingFederate server creates a new instance of your adapter implementation this method will be invoked with the proper configuration. All concurrency issues are handled in the server so you don't need to worry about them here. The server doesn't allow access to your adapter implementation instance until after creation and configuration is completed.

Specified by:

configure in interface ConfigurablePlugin

Parameters:

configuration - the Configuration object constructed from the values entered by the user via the GUI.