com.pingidentity.pa.sdk.plugins

Interface ConfigurablePlugin<T extends PluginConfiguration>

Type Parameters:

T - A PluginConfiguration implementation.

All Known Subinterfaces:

AsyncIdentityMappingPlugin<T>, AsyncLoadBalancingPlugin<H,C>, AsyncRuleInterceptor<T>, AsyncSiteAuthenticatorInterceptor<T>, EntityScopedHandlerPlugin<H,C>, IdentityMappingPlugin<T>, LoadBalancingPlugin<H,C>, RuleInterceptor<T>, SiteAuthenticatorInterceptor<T>

All Known Implementing Classes:

AsyncIdentityMappingPluginBase, AsyncLoadBalancingPluginBase, AsyncRuleInterceptorBase, AsyncSiteAuthenticatorInterceptorBase, HeaderIdentityMappingPlugin, IdentityMappingPluginBase, LoadBalancingPluginBase, RuleInterceptorBase, SiteAuthenticatorInterceptorBase

public interface ConfigurablePlugin<T extends PluginConfiguration>

Interface to allow plugins to receive configuration information from the UI/Administrative API.

Method Summary

Modifier and Type	Method and Description
void	configure(T configuration) This method is called to provide the configuration from the UI/Administrative API.
T	getConfiguration() Retrieves the configuration provided to this ConfigurablePlugin.

Method Detail

configure

void configure(T configuration)
        throws javax.validation.ValidationException

This method is called to provide the configuration from the UI/Administrative API.

Parameters:

configuration - a PluginConfiguration implementation, configured with information from the API.

Throws:

javax.validation.ValidationException - An Exception that can describe errors in the configuration.

getConfiguration

T getConfiguration()

Retrieves the configuration provided to this ConfigurablePlugin.

Returns:

The provided PluginConfiguration implementation.