com.pingidentity.pa.sdk.siteauthenticator

Interface AsyncSiteAuthenticatorInterceptor<T extends PluginConfiguration>

Type Parameters:

T - the type of PluginConfiguration for this AsyncSiteAuthenticatorInterceptor

All Superinterfaces:

ConfigurablePlugin<T>, DescribesUIConfigurable

All Known Implementing Classes:

AsyncSiteAuthenticatorInterceptorBase

public interface AsyncSiteAuthenticatorInterceptor<T extends PluginConfiguration>
extends DescribesUIConfigurable, ConfigurablePlugin<T>

A AsyncSiteAuthenticatorInterceptor is the runtime instantiation of a Site Authenticator defined in the Administrative API that supports asynchronous computation. See the documentation of SiteAuthenticatorInterceptor for information on implementing a Site Authenticator.

Using AsyncSiteAuthenticatorInterceptor over SiteAuthenticatorInterceptor

AsyncSiteAuthenticatorInterceptor should only be used when the logic of the Site Authenticator requires using a HttpClient. If a HttpClient is not required, SiteAuthenticatorInterceptor should be implemented instead.

See Also:

SiteAuthenticatorInterceptor

Method Summary

Modifier and Type	Method and Description
CompletionStage<Void>	handleRequest(Exchange exchange) Invoked to allow a AsyncSiteAuthenticatorInterceptor to handle the request attached to the Exchange.
CompletionStage<Void>	handleResponse(Exchange exchange) Invoked to allow a AsyncSiteAuthenticatorInterceptor to handle the response attached to the Exchange.

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

getConfigurationFields

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

configure, getConfiguration

Method Detail

handleRequest

CompletionStage<Void> handleRequest(Exchange exchange)

Invoked to allow a AsyncSiteAuthenticatorInterceptor to handle the request attached to the Exchange.

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)
         

handleResponse

CompletionStage<Void> handleResponse(Exchange exchange)

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

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)