Package net.shibboleth.oidc.metadata

Class RelyingPartyClientInformationProvider

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

net.shibboleth.shared.spring.service.AbstractServiceableComponent<ClientInformationResolver>

net.shibboleth.oidc.metadata.RelyingPartyClientInformationProvider

All Implemented Interfaces:

AutoCloseable, Comparable<RelyingPartyClientInformationProvider>, ClientInformationResolver, RefreshableClientInformationResolver, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent, Resolver<OIDCClientInformation,CriteriaSet>, ServiceableComponent<ClientInformationResolver>, Aware, ApplicationContextAware

public class RelyingPartyClientInformationProvider
extends AbstractServiceableComponent<ClientInformationResolver>
implements RefreshableClientInformationResolver, Comparable<RelyingPartyClientInformationProvider>

This class exists primarily to allow the parsing of relying-party.xml to create a serviceable implementation of ClientInformationResolver. Based on net.shibboleth.idp.saml.metadata.RelyingPartyMetadataProvider.

Field Summary

Fields

Modifier and Type	Field	Description
private final org.slf4j.Logger	log	Class logger.
private ClientInformationResolver	resolver	The embedded resolver.
private Integer	sortKey	The key by which we sort the provider.
private static int	sortKeyValue	If we autogenerate a sort key it comes from this count.

Constructor Summary

Constructors

Constructor	Description
RelyingPartyClientInformationProvider()	Constructor.

Method Summary

Modifier and Type	Method	Description
int	compareTo(RelyingPartyClientInformationProvider other)
protected void	doInitialize()
boolean	equals(Object other)	.
ClientInformationResolver	getComponent()
ClientInformationResolver	getEmbeddedResolver()	Return what we are build around.
Instant	getLastRefresh()	Gets the time the last refresh cycle occurred.
Instant	getLastUpdate()	Get the time that the currently available client information was last updated.
int	hashCode()
void	refresh()	Refresh the data exposed by the resolver.
Iterable<OIDCClientInformation>	resolve(CriteriaSet criteria)
OIDCClientInformation	resolveSingle(CriteriaSet criteria)
void	setEmbeddedResolver(ClientInformationResolver theResolver)	Set the ClientInformationResolver to embed.
void	setSortKey(int key)	Set the sort key.

Methods inherited from class net.shibboleth.shared.spring.service.AbstractServiceableComponent

close, doDestroy, getApplicationContext, pinComponent, setApplicationContext, unloadComponent, unpinComponent

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, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

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

getId

Field Details

sortKeyValue

private static int sortKeyValue

If we autogenerate a sort key it comes from this count.

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

resolver

@NonnullAfterInit
private ClientInformationResolver resolver

The embedded resolver.

sortKey

@NonnullAfterInit
private Integer sortKey

The key by which we sort the provider.

Constructor Details

RelyingPartyClientInformationProvider

public RelyingPartyClientInformationProvider()

Constructor.

Method Details

setSortKey

public void setSortKey(int key)

Set the sort key.

Parameters:

key - what to set

setEmbeddedResolver

public void setEmbeddedResolver(@Nonnull
 ClientInformationResolver theResolver)

Set the ClientInformationResolver to embed.

Parameters:

theResolver - The ClientInformationResolver to embed.

getEmbeddedResolver

@Nonnull
public ClientInformationResolver getEmbeddedResolver()

Return what we are build around. Used for testing.

Returns:

the parameter we got as a constructor

resolve

@Nonnull
public Iterable<OIDCClientInformation> resolve(@Nullable
 CriteriaSet criteria)
                                        throws ResolverException

Specified by:

resolve in interface Resolver<OIDCClientInformation,CriteriaSet>

Throws:

ResolverException

resolveSingle

@Nullable
public OIDCClientInformation resolveSingle(@Nullable
 CriteriaSet criteria)
                                    throws ResolverException

Specified by:

resolveSingle in interface Resolver<OIDCClientInformation,CriteriaSet>

Throws:

ResolverException

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractServiceableComponent<ClientInformationResolver>

Throws:

ComponentInitializationException

getComponent

@Nonnull
public ClientInformationResolver getComponent()

Specified by:

getComponent in interface ServiceableComponent<ClientInformationResolver>

Specified by:

getComponent in class AbstractServiceableComponent<ClientInformationResolver>

refresh

public void refresh()
             throws ResolverException

Refresh the data exposed by the resolver.

An implementation of this method should typically be either synchronized or make use other locking mechanisms to protect against concurrent access.

Specified by:

refresh in interface RefreshableClientInformationResolver

Throws:

ResolverException - if the refresh operation was unsuccessful

getLastRefresh

public Instant getLastRefresh()

Gets the time the last refresh cycle occurred.

Specified by:

getLastRefresh in interface RefreshableClientInformationResolver

Returns:

time the last refresh cycle occurred

getLastUpdate

public Instant getLastUpdate()

Get the time that the currently available client information was last updated. Note, this may be different than the time retrieved by RefreshableClientInformationResolver.getLastRefresh() is the client information was known not to have changed during the last refresh cycle.

Specified by:

getLastUpdate in interface RefreshableClientInformationResolver

Returns:

time when the currently client information was last updated, null if it has never successfully been read in

compareTo

public int compareTo(RelyingPartyClientInformationProvider other)

Specified by:

compareTo in interface Comparable<RelyingPartyClientInformationProvider>

equals

public boolean equals(Object other)

. We are within a spring context and so equality can be determined by ID, however we also test by sortKey just in case.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object