com.pingidentity.pa.sdk.policy

Class AsyncRuleInterceptorBase<T extends PluginConfiguration>

java.lang.Object

com.pingidentity.pa.sdk.policy.AsyncRuleInterceptorBase<T>

Type Parameters:

T - the type of PluginConfiguration for this AsyncRuleInterceptor

All Implemented Interfaces:

Interceptor, ConfigurablePlugin<T>, DescribesUIConfigurable, AsyncRuleInterceptor<T>

public abstract class AsyncRuleInterceptorBase<T extends PluginConfiguration>
extends Object
implements AsyncRuleInterceptor<T>

A base class simplifying the implementation of AsyncRuleInterceptor

Constructor Summary

Constructors

Constructor and Description
AsyncRuleInterceptorBase()

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.
HttpClient	getHttpClient()
TemplateRenderer	getTemplateRenderer()
CompletionStage<Void>	handleResponse(Exchange exchange) Invoked to allow a AsyncRuleInterceptor to handle the response attached to the Exchange.
void	setHttpClient(HttpClient httpClient) Sets the HttpClient for this AsyncRuleInterceptor.
void	setTemplateRenderer(TemplateRenderer templateRenderer)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.pingidentity.pa.sdk.policy.AsyncRuleInterceptor

getErrorHandlingCallback, handleRequest

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

getConfigurationFields

Constructor Detail

AsyncRuleInterceptorBase

public AsyncRuleInterceptorBase()

Method Detail

configure

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

Description copied from interface: ConfigurablePlugin

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

Specified by:

configure in interface ConfigurablePlugin<T extends PluginConfiguration>

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

public T getConfiguration()

Description copied from interface: ConfigurablePlugin

Retrieves the configuration provided to this ConfigurablePlugin.

Specified by:

getConfiguration in interface ConfigurablePlugin<T extends PluginConfiguration>

Returns:

The provided PluginConfiguration implementation.

handleResponse

public CompletionStage<Void> handleResponse(Exchange exchange)

Description copied from interface: AsyncRuleInterceptor

Invoked to allow a AsyncRuleInterceptor to handle the response attached to the Exchange.

Specified by:

handleResponse in interface AsyncRuleInterceptor<T extends PluginConfiguration>

Parameters:

exchange - the current Exchange being processed

Returns:

a CompletionStage representing the asynchronous completion of the method. If this method does not require use of a HttpClient, the logic of the method can be performed synchronously and then return a completed CompletionStage with code like:

             CompletableFuture.completedFuture(null)
         

getHttpClient

public HttpClient getHttpClient()

Returns:

the HttpClient for this AsyncRuleInterceptor

setHttpClient

@Inject
public void setHttpClient(HttpClient httpClient)

Sets the HttpClient for this AsyncRuleInterceptor. This method will be invoked appropriately by PingAccess due to the presence of the Inject annotation.

Parameters:

httpClient - the HttpClient

getTemplateRenderer

public TemplateRenderer getTemplateRenderer()

Returns:

the TemplateRenderer for this AsyncRuleInterceptor

setTemplateRenderer

@Inject
public void setTemplateRenderer(TemplateRenderer templateRenderer)