Package net.shibboleth.idp.plugin.authn.duo.impl

Class DefaultDuoOIDCClientRegistry

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

net.shibboleth.idp.plugin.authn.duo.impl.DefaultDuoOIDCClientRegistry

All Implemented Interfaces:

DuoOIDCClientRegistry, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent

@ThreadSafe
public class DefaultDuoOIDCClientRegistry
extends AbstractIdentifiableInitializableComponent
implements DuoOIDCClientRegistry

The default Duo Client registry for mapping a DuoOIDCIntegration to either a new or existing DuoOIDCClient (assumed thread-safe) singleton instance.

Clients are created and registered one-to-one against a DuoOIDCIntegration. Once created, the same client instance is reused for the same given Duo integration for the lifetime of the IdP.

The DuoOIDCIntegration is the 'key' to the map holding the clients. It therefore should decide its own 'business key' using the Object.equals(Object) and Object.hashCode() method appropriately. For example, the DefaultDuoOIDCIntegration uses the clientID as its key. The key should be immutable.

Supports thread-safe lazy initialization of clients when they are first requested. A single, configurable, client factory is called to initialize new clients.

Initialization and fetching is thread safe thanks to the use of a ConcurrentMap and its ConcurrentMap.computeIfAbsent(Object, Function) operation. This guarantees that two clients should never be created for the same integration. The client is safely published by the map.

The registry itself is effectively immutable once published by spring.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	DefaultDuoOIDCClientRegistry.CreateNewClientMappingFunction	A function for creating a new Duo client from the configured client factory for the given Duo integration.

Field Summary

Fields

Modifier and Type	Field	Description
private DuoOIDCClientFactory	clientFactory	Factory to produce Duo clients.
private final ConcurrentMap<DuoOIDCIntegration,DuoOIDCClient>	clientRegistry	Registry of Duo client to Duo integration.
private final Function<DuoOIDCIntegration,DuoOIDCClient>	clientRegistryMappingFunction	Function for creating a DuoClient from a DuoIntegration.
private final org.slf4j.Logger	log	Class logger.

Constructor Summary

Constructors

Constructor	Description
DefaultDuoOIDCClientRegistry()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doInitialize()
private DuoOIDCClientFactory	getClientFactory()	Internally synchronized method for obtaining the 'current' client factory.
DuoOIDCClient	getClientOrCreate(DuoOIDCIntegration integration)	Retrieve an existing, or create a new, Duo client for the given Duo integration.
void	setClientFactory(DuoOIDCClientFactory factory)	Set the client factory to use.

Methods inherited from class net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

setId

Methods inherited from class net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

ensureId, getId, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException

Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

checkComponentActive, checkSetterPreconditions, destroy, doDestroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.shibboleth.shared.component.IdentifiedComponent

getId

Field Details

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

clientFactory

@NonnullAfterInit
private DuoOIDCClientFactory clientFactory

Factory to produce Duo clients.

clientRegistry

@Nonnull
@NonnullElements
private final ConcurrentMap<DuoOIDCIntegration,DuoOIDCClient> clientRegistry

Registry of Duo client to Duo integration.

clientRegistryMappingFunction

@Nonnull
private final Function<DuoOIDCIntegration,DuoOIDCClient> clientRegistryMappingFunction

Function for creating a DuoClient from a DuoIntegration.

Constructor Details

DefaultDuoOIDCClientRegistry

public DefaultDuoOIDCClientRegistry()

Constructor.

Method Details

setClientFactory

public void setClientFactory(@Nonnull
 DuoOIDCClientFactory factory)

Set the client factory to use.

Parameters:

factory - the factory.

getClientFactory

@NonnullAfterInit
private DuoOIDCClientFactory getClientFactory()

Internally synchronized method for obtaining the 'current' client factory.

Returns:

the client factory.

getClientOrCreate

@Nonnull
public DuoOIDCClient getClientOrCreate(@Nonnull
 DuoOIDCIntegration integration)
                                throws DuoRegistryException

Description copied from interface: DuoOIDCClientRegistry

Retrieve an existing, or create a new, Duo client for the given Duo integration. The client should be fully initialised and safely published on return.

implSpec: Only one client should exist per integration i.e. given the same integration, the same client instance should be returned.

implNote: Clients could either be pre-registered, or lazy-initialised when first needed.

Specified by:

getClientOrCreate in interface DuoOIDCClientRegistry

Parameters:

integration - the Duo integration to find a client for, never null.

Returns:

a DuoOIDCClient appropriate for this integration, never null.

Throws:

DuoRegistryException - if there is an issue locating or creating a Duo client.

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractIdentifiedInitializableComponent

Throws:

ComponentInitializationException