Package net.shibboleth.oidc.metadata

Class ProviderMetadataProviderContainer

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.oidc.metadata.ProviderMetadataProviderContainer

All Implemented Interfaces:

AutoCloseable, Comparable<ProviderMetadataProviderContainer>, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent, ServiceableComponent<ProviderMetadataResolver>, Aware, ApplicationContextAware

public class ProviderMetadataProviderContainer
extends AbstractServiceableComponent<ProviderMetadataResolver>
implements Comparable<ProviderMetadataProviderContainer>

This class is a sortable container of ProviderMetadataResolvers, wrapped into a serviceable component.

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
ProviderMetadataProviderContainer()

Method Summary

Modifier and Type	Method	Description
int	compareTo(ProviderMetadataProviderContainer other)
protected void	doInitialize()
boolean	equals(Object other)	.
ProviderMetadataResolver	getComponent()
ProviderMetadataResolver	getEmbeddedResolver()	Return what we are build around.
int	hashCode()
void	setEmbeddedResolver(ProviderMetadataResolver theResolver)	Set the ProviderMetadataResolver 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 ProviderMetadataResolver resolver

The embedded resolver.

sortKey

@NonnullAfterInit
private Integer sortKey

The key by which we sort the provider.

Constructor Details

ProviderMetadataProviderContainer

public ProviderMetadataProviderContainer()

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

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractServiceableComponent<ProviderMetadataResolver>

Throws:

ComponentInitializationException

getComponent

@Nonnull
public ProviderMetadataResolver getComponent()

Specified by:

getComponent in interface ServiceableComponent<ProviderMetadataResolver>

Specified by:

getComponent in class AbstractServiceableComponent<ProviderMetadataResolver>

compareTo

public int compareTo(ProviderMetadataProviderContainer other)

Specified by:

compareTo in interface Comparable<ProviderMetadataProviderContainer>

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