Package com.pingidentity.sdk

Interface ConfigurablePlugin

All Known Subinterfaces:
AdapterSelector, AuthenticationSelector, AuthorizationDetailProcessor, BearerAccessTokenManagementPlugin, CaptchaProvider, ClientSideAuthenticator, ConfigurableAuthnAdapter, ConfigurableDriver, CustomDataSourceDriver, DynamicClientRegistrationPlugin, IdentityStoreProvisioner, IdentityStoreProvisionerWithFiltering, IdentityStoreUserProvisioner, IdpAuthenticationAdapter, IdpAuthenticationAdapterV2, NotificationPublisherPlugin, OOBAuthPlugin, PasswordCredentialValidator, Plugin, SecretManager, SpAuthenticationAdapter, TokenGenerator, TokenProcessor<T>
public interface ConfigurablePlugin
Interface which provides a plugin the ability to be configured.
See Also:

  • Method Summary

    Modifier and Type
    Method
    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.

  • Method Details

    • 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.

      Each time the PingFederate server creates a new instance of your plugin 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 plugin implementation instance until after creation and configuration is completed.
      Parameters:
      configuration - the Configuration object constructed from the values entered by the user via the GUI.