Any custom plugin that requires UI settings is considered configurable and hence implements the ConfigurablePlugin interface. This ensures that PingFederate loads the plugin instance with the correct configuration settings.

All plugin types implement the ConfigurablePlugin interface and must define the following to enable configuration loading:

void configure(Configuration configuration)

During processing of a configurable plugin instance, PingFederate calls the ConfigurablePlugin.configure() method and passes in a Configuration object. The Configuration object provides the plugin adapter-instance configuration set by an administrator in the PingFederate UI.

The SpAuthnAdapterExample.java sample provided with the SDK shows how to use this method to initialize an adapter-instance from a saved configuration. Once your implementation loads the configuration values, the plugin instance can use them in other method calls.