com.pingidentity.pa.sdk.siteauthenticator

Interface SiteAuthenticatorInterceptor<T extends PluginConfiguration>

Type Parameters:

T - the PluginConfiguration class for this implementation of SiteAuthenticatorInterceptor

All Superinterfaces:

ConfigurablePlugin<T>, DescribesUIConfigurable

All Known Implementing Classes:

SiteAuthenticatorInterceptorBase

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

A SiteAuthenticatorInterceptor is the runtime instantiation of a Site Authenticator defined in the Administrative API. It can be used to modify a HTTP request to include authentication credentials that a Site can use to validate that the HTTP request came from PingAccess. The Site Authenticator can also intercept and handle authentication challenge responses from the Site, in the event that the authentication information included in the request was invalid.

Implementing a SiteAuthenticatorInterceptor

Plugin Annotation

A class that implements SiteAuthenticatorInterceptor must be annotated with the SiteAuthenticator annotation.

Provider-configuration file

The fully qualified class name for an implementation of SiteAuthenticatorInterceptor should be placed in a META-INF/services/com.pingidentity.pa.sdk.siteauthenticator.SiteAuthenticatorInterceptor resource file that is packaged in the jar containing the compiled class for the implementation. This signals to PingAccess that the class is a valid SiteAuthenticatorInterceptor implementation.

Responsibilities of a SiteAuthenticatorInterceptor

In addition to the responsibilities of a configurable plugin defined in the com.pingidentity.pa.sdk.plugins documentation, a SiteAuthenticatorInterceptor has the following additional responsibilities:

Handling Requests and Responses

The SiteAuthenticatorInterceptor operates on a HTTP transaction by interacting with the Exchange and its contained objects. Supporting classes can be found within com.pingidentity.pa.sdk.http.

The handleRequest(Exchange) method is invoked to allow the SiteAuthenticatorInterceptor to include authentication credentials that allows the Site to validate that the request came from PingAccess.

The handleResponse(Exchange) method is invoked to allow the SiteAuthenticatorInterceptor to handle any authentication challenge responses the Site produces when validating the authentication credentials set in handleRequest(Exchange).

See Also:

com.pingidentity.pa.sdk.plugins

Method Summary

Modifier and Type	Method and Description
void	handleRequest(Exchange exchange) Called to allow this SiteAuthenticatorInterceptor to modify the Request attached to the Exchange
void	handleResponse(Exchange exchange) Called to allow this SiteAuthenticatorInterceptor to modify 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

void handleRequest(Exchange exchange)
            throws AccessException

Called to allow this SiteAuthenticatorInterceptor to modify the Request attached to the Exchange

Parameters:

exchange - the Exchange for the current transaction

Throws:

AccessException - to indicate that a specific error response should be generated

handleResponse

void handleResponse(Exchange exchange)
             throws AccessException

Called to allow this SiteAuthenticatorInterceptor to modify the Response attached to the Exchange. This will be invoked after handleRequest(Exchange) for the same Exchange instance, when a Response is available on the Exchange.

Parameters:

exchange - the Exchange for the current transaction

Throws:

AccessException - to indicate that a specific error response should be generated