com.pingidentity.pa.sdk.plugins

Interface EntityScopedHandlerPlugin<H,C extends PluginConfiguration>

Type Parameters:

H - A generic handler implementation. Derived interfaces should further bound this parameter.

C - A PluginConfiguration implementation.

All Superinterfaces:

ConfigurablePlugin<C>

All Known Subinterfaces:

AsyncLoadBalancingPlugin<H,C>, LoadBalancingPlugin<H,C>

All Known Implementing Classes:

AsyncLoadBalancingPluginBase, LoadBalancingPluginBase

public interface EntityScopedHandlerPlugin<H,C extends PluginConfiguration>
extends ConfigurablePlugin<C>

A ConfigurablePlugin that provides methods to create a runtime handler scoped to a specific configuration entity such as a Site.

Method Summary

Modifier and Type	Method and Description
H	getHandler() Creates a new handler instance.
H	getHandler(H existingHandler) Gets the handler instance given the existing handler.

Methods inherited from interface com.pingidentity.pa.sdk.plugins.ConfigurablePlugin

configure, getConfiguration

Method Detail

getHandler

H getHandler(H existingHandler)

Gets the handler instance given the existing handler. It is up to the implementation to determine when the existing handler can be modified in place or when a new instance needs to be created.

Parameters:

existingHandler - the existing handler that already is associated with the affiliated entity

Returns:

the handler instance, updated with new configuration, if necessary

getHandler

H getHandler()

Creates a new handler instance.

Returns:

the handler instance, updated with new configuration, if necessary