com.pingidentity.pa.sdk.identitymapping

Interface AsyncIdentityMappingPlugin<T extends PluginConfiguration>

Type Parameters:

T - the type of PluginConfiguration class for this AsyncIdentityMappingPlugin

All Superinterfaces:

ConfigurablePlugin<T>, DescribesUIConfigurable

All Known Implementing Classes:

AsyncIdentityMappingPluginBase

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

A AsyncIdentityMappingPlugin is the runtime instantiation of an Identity Mapping defined in the Administrative API that supports asynchronous computation.

Using AsyncIdentityMappingPlugin over IdentityMappingPlugin

AsyncIdentityMappingPlugin should only be used when the logic of the Identity Mapping requires using a HttpClient. If a HttpClient is not required, IdentityMappingPlugin should be implemented instead.

See Also:

IdentityMappingPlugin

Method Summary

Modifier and Type	Method and Description
CompletionStage<Void>	mapAnonymousIdentity(Request request, Exchange exchange) Maps the anonymous identity.
CompletionStage<Void>	mapIdentity(Identity identity, Request request, Exchange exchange) Maps the identity by inspecting the identity associated with the request and making modifications to the request and/or 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

mapIdentity

CompletionStage<Void> mapIdentity(Identity identity,
                                  Request request,
                                  Exchange exchange)

Maps the identity by inspecting the identity associated with the request and making modifications to the request and/or exchange.

If the subject is configured in the IdentityMapping, Identity.setMappedSubject(java.lang.String) should be called, setting the subject value.

NOTE: Modifications to the exchange via Exchange.setRequest(Request), and Exchange.setResponse(Response) will be ignored

Parameters:

identity - the Identity for the current transaction

request - the Request

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)
         

mapAnonymousIdentity

CompletionStage<Void> mapAnonymousIdentity(Request request,
                                           Exchange exchange)

Maps the anonymous identity. An anonymous identity occurs when the corresponding Resource is configured as anonymous and the incoming request does not contain any identity information (such as the PingAccess cookie or OAuth token).

If the identity is mapped to request headers, this method should clobbers headers that would be set when an identity was present in the request.

NOTE: Modifications to the exchange via Exchange.setRequest(Request), and Exchange.setResponse(Response) will be ignored

Parameters:

request - the Request

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)