Class CachingRelyingPartyRegistrationRepository

java.lang.Object

org.springframework.security.saml2.provider.service.registration.CachingRelyingPartyRegistrationRepository

All Implemented Interfaces:

Iterable<RelyingPartyRegistration>, IterableRelyingPartyRegistrationRepository, RelyingPartyRegistrationRepository

public final class CachingRelyingPartyRegistrationRepository
extends Object
implements IterableRelyingPartyRegistrationRepository

An IterableRelyingPartyRegistrationRepository that lazily queries and caches metadata from a backing IterableRelyingPartyRegistrationRepository. Delegates caching policies to Spring Cache.

Since:

6.4

Constructor Summary

Constructors

Constructor	Description
CachingRelyingPartyRegistrationRepository(Callable<IterableRelyingPartyRegistrationRepository> loader)

Method Summary

Modifier and Type	Method	Description
@Nullable RelyingPartyRegistration	findByRegistrationId(String registrationId)	Returns the relying party registration identified by the provided registrationId, or null if not found.
@Nullable RelyingPartyRegistration	findUniqueByAssertingPartyEntityId(String entityId)	Returns the unique relying party registration associated with the asserting party's entityId or null if there is no unique match.
void	forEach(Consumer<? super RelyingPartyRegistration> action)
Iterator<RelyingPartyRegistration>	iterator()
void	setCache(org.springframework.cache.Cache cache)	Use this cache for the completed RelyingPartyRegistration instances.
Spliterator<RelyingPartyRegistration>	spliterator()

Methods inherited from class Object

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

Constructor Details

CachingRelyingPartyRegistrationRepository

public CachingRelyingPartyRegistrationRepository(Callable<IterableRelyingPartyRegistrationRepository> loader)

Method Details

iterator

public Iterator<RelyingPartyRegistration> iterator()

Specified by:

iterator in interface Iterable<RelyingPartyRegistration>

findByRegistrationId

public @Nullable RelyingPartyRegistration findByRegistrationId(String registrationId)

Returns the relying party registration identified by the provided registrationId, or null if not found.

Specified by:

findByRegistrationId in interface RelyingPartyRegistrationRepository

Parameters:

registrationId - the registration identifier

Returns:

the RelyingPartyRegistration if found, otherwise null

findUniqueByAssertingPartyEntityId

public @Nullable RelyingPartyRegistration findUniqueByAssertingPartyEntityId(String entityId)

Description copied from interface: RelyingPartyRegistrationRepository

Returns the unique relying party registration associated with the asserting party's entityId or null if there is no unique match.

Specified by:

findUniqueByAssertingPartyEntityId in interface RelyingPartyRegistrationRepository

Parameters:

entityId - the asserting party's entity id

Returns:

the unique RelyingPartyRegistration associated the given asserting party; null of there is no unique match asserting party

forEach

public void forEach(Consumer<? super RelyingPartyRegistration> action)

Specified by:

forEach in interface Iterable<RelyingPartyRegistration>

spliterator

public Spliterator<RelyingPartyRegistration> spliterator()

Specified by:

spliterator in interface Iterable<RelyingPartyRegistration>

setCache

public void setCache(org.springframework.cache.Cache cache)

Use this cache for the completed RelyingPartyRegistration instances.

Defaults to ConcurrentMapCache, meaning that the registrations are cached without expiry. To turn off the cache, use NoOpCache.

Parameters:

cache - the Cache to use