com.pingidentity.pa.sdk.identitymapping.header

Class HeaderIdentityMappingPlugin<P extends PluginConfiguration>

java.lang.Object

com.pingidentity.pa.sdk.identitymapping.IdentityMappingPluginBase<P>

com.pingidentity.pa.sdk.identitymapping.header.HeaderIdentityMappingPlugin<P>

Type Parameters:

P - the PluginConfiguration class for this implementation of HeaderIdentityMappingPlugin

All Implemented Interfaces:

IdentityMappingPlugin<P>, ConfigurablePlugin<P>, DescribesUIConfigurable

public abstract class HeaderIdentityMappingPlugin<P extends PluginConfiguration>
extends IdentityMappingPluginBase<P>

An abstract base class that can be extended to handle simple identity mapping where attribute names are mapped to header names.

Classes that extend this class will properly handle clobbering of request headers for both authenticated and anonymous requests.

During configuration, createMappingPairConfiguration(PluginConfiguration) will be called, passing in the plugin configuration. Implementors of this class should return a set of AttributeHeaderPairs. If an AttributeHeaderPair is set as the subject, on incoming requests Identity.setMappedSubject(java.lang.String) will be called, setting the mapped subject on the Identity.

On an incoming request getPairValue(Identity, AttributeHeaderPair, Exchange) will be called for each configured AttributeHeaderPair and the user attribute value will be looked up and set as the header value. For multi-value attributes, a single comma separated header value will be set in the request. This method can be overridden if custom behavior is desired.

See Also:

AttributeHeaderPair

Constructor Summary

Constructors

Constructor and Description
HeaderIdentityMappingPlugin()

Method Summary

Modifier and Type	Method and Description
void	configure(P configuration) Implementation of ConfigurablePlugin.configure(com.pingidentity.pa.sdk.policy.PluginConfiguration) that saves the provided configuration data in a field.
void	mapAnonymousIdentity(Request request, Exchange exchange) Maps the anonymous identity.
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 class com.pingidentity.pa.sdk.identitymapping.IdentityMappingPluginBase

getConfiguration

Methods inherited from class java.lang.Object

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

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

getConfigurationFields

Constructor Detail

HeaderIdentityMappingPlugin

public HeaderIdentityMappingPlugin()

Method Detail

configure

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

Description copied from class: IdentityMappingPluginBase

Implementation of ConfigurablePlugin.configure(com.pingidentity.pa.sdk.policy.PluginConfiguration) that saves the provided configuration data in a field.

Specified by:

configure in interface ConfigurablePlugin<P extends PluginConfiguration>

Overrides:

configure in class IdentityMappingPluginBase<P extends PluginConfiguration>

Parameters:

configuration - An implementation of PluginConfiguration, configured with information from the UI.

Throws:

javax.validation.ValidationException - If the provided Validation is invalid.

mapIdentity

public void mapIdentity(Identity identity,
                        Request request,
                        Exchange exchange)

Description copied from interface: IdentityMappingPlugin

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 of the request (always set)

request - the request

exchange - the exchange

mapAnonymousIdentity

public void mapAnonymousIdentity(Request request,
                                 Exchange exchange)

Description copied from interface: IdentityMappingPlugin

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 exchange