Package net.shibboleth.idp.plugin.oidc.op.metadata.resolver

Class ServiceableProviderMetadataProvider

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

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

net.shibboleth.idp.plugin.oidc.op.metadata.resolver.ServiceableProviderMetadataProvider

All Implemented Interfaces:

AutoCloseable, Comparable<ServiceableProviderMetadataProvider>, ProviderMetadataResolver, RefreshableProviderMetadataResolver, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent, Resolver<OIDCProviderMetadata,ProfileRequestContext>, ServiceableComponent<ProviderMetadataResolver>, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class ServiceableProviderMetadataProvider
extends AbstractServiceableComponent<ProviderMetadataResolver>
implements RefreshableProviderMetadataResolver, Comparable<ServiceableProviderMetadataProvider>

A serviceable implementation of ProviderMetadataResolver. 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 ProviderMetadataResolver	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
ServiceableProviderMetadataProvider()	Constructor.

Method Summary

Modifier and Type	Method	Description
int	compareTo(ServiceableProviderMetadataProvider other)
protected void	doInitialize()
boolean	equals(Object other)	.
ProviderMetadataResolver	getComponent()
ProviderMetadataResolver	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 metadata was last updated.
int	hashCode()
void	refresh()	Refresh the data exposed by the resolver.
Iterable<OIDCProviderMetadata>	resolve(ProfileRequestContext profileRequestContext)
OIDCProviderMetadata	resolveSingle(ProfileRequestContext profileRequestContext)
void	setEmbeddedResolver(ProviderMetadataResolver theResolver)	Set the ProviderMetadataResolver to embed.
void	setId(String componentId)	Sets the ID of this component.
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.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

private final org.slf4j.Logger log

Class logger.

resolver

@NonnullAfterInit
private ProviderMetadataResolver resolver

The embedded resolver.

sortKey

@NonnullAfterInit
private Integer sortKey

The key by which we sort the provider.

Constructor Details

ServiceableProviderMetadataProvider

public ServiceableProviderMetadataProvider()

Constructor.

Method Details

setSortKey

public void setSortKey(int key)

Set the sort key.

Parameters:

key - what to set

setEmbeddedResolver

public void setEmbeddedResolver(@Nonnull
 ProviderMetadataResolver theResolver)

Set the ProviderMetadataResolver to embed.

Parameters:

theResolver - The ProviderMetadataResolver to embed.

getEmbeddedResolver

@Nonnull
public ProviderMetadataResolver getEmbeddedResolver()

Return what we are build around. Used for testing.

Returns:

the parameter we got as a constructor

resolve

@Nonnull
public Iterable<OIDCProviderMetadata> resolve(ProfileRequestContext profileRequestContext)
                                       throws ResolverException

Specified by:

resolve in interface Resolver<OIDCProviderMetadata,ProfileRequestContext>

Throws:

ResolverException

resolveSingle

@Nullable
public OIDCProviderMetadata resolveSingle(@Nullable
 ProfileRequestContext profileRequestContext)
                                   throws ResolverException

Specified by:

resolveSingle in interface Resolver<OIDCProviderMetadata,ProfileRequestContext>

Throws:

ResolverException

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractServiceableComponent<ProviderMetadataResolver>

Throws:

ComponentInitializationException

setId

public void setId(@Nonnull @NotEmpty
 String componentId)

Sets the ID of this component. The component must not yet be initialized.

Specified by:

setId in interface IdentifiableComponent

Overrides:

setId in class AbstractIdentifiableInitializableComponent

Parameters:

componentId - ID of the component

getComponent

@Nonnull
public ProviderMetadataResolver getComponent()

Specified by:

getComponent in interface ServiceableComponent<ProviderMetadataResolver>

Specified by:

getComponent in class AbstractServiceableComponent<ProviderMetadataResolver>

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 RefreshableProviderMetadataResolver

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 RefreshableProviderMetadataResolver

Returns:

time the last refresh cycle occurred

getLastUpdate

public Instant getLastUpdate()

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

Specified by:

getLastUpdate in interface RefreshableProviderMetadataResolver

Returns:

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

compareTo

public int compareTo(ServiceableProviderMetadataProvider other)

Specified by:

compareTo in interface Comparable<ServiceableProviderMetadataProvider>

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