Package net.shibboleth.oidc.metadata.impl

Class StorageServiceClientInformationManager

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

net.shibboleth.oidc.metadata.impl.BaseStorageServiceClientInformationComponent

net.shibboleth.oidc.metadata.impl.StorageServiceClientInformationManager

All Implemented Interfaces:

ClientInformationManager, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent

public class StorageServiceClientInformationManager
extends BaseStorageServiceClientInformationComponent
implements ClientInformationManager

A ClientInformationManager exploiting StorageService for storing the data.

Field Summary

Fields

Modifier and Type	Field	Description
private final org.slf4j.Logger	log	Class logger.

Fields inherited from class net.shibboleth.oidc.metadata.impl.BaseStorageServiceClientInformationComponent

CONTEXT_NAME

Constructor Summary

Constructors

Constructor	Description
StorageServiceClientInformationManager()

Method Summary

Modifier and Type	Method	Description
void	destroyClientInformation(ClientID clientId)	Invalidates or otherwise removes a ClientInformation from persistent storage.
void	storeClientInformation(OIDCClientInformation clientInformation, Instant expiration)	Deprecated.
void	storeClientInformation(OIDCClientInformation clientInformation, Instant expiration, boolean replace)	Store a ClientInformation object.

Methods inherited from class net.shibboleth.oidc.metadata.impl.BaseStorageServiceClientInformationComponent

doInitialize, getStorageService, setStorageService

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.

Constructor Details

StorageServiceClientInformationManager

public StorageServiceClientInformationManager()

Method Details

storeClientInformation

public void storeClientInformation(@Nonnull
 OIDCClientInformation clientInformation,
 @Nullable
 Instant expiration,
 boolean replace)
                            throws ClientInformationManagerException

Store a ClientInformation object.

Specified by:

storeClientInformation in interface ClientInformationManager

Parameters:

clientInformation - The client information to be stored

expiration - The expiration for record, or null

replace - whether to replace an existing entry

Throws:

ClientInformationManagerException - If the client information cannot be stored.

storeClientInformation

@Deprecated
public void storeClientInformation(@Nonnull
 OIDCClientInformation clientInformation,
 @Nullable
 Instant expiration)
                            throws ClientInformationManagerException

Deprecated.

Store a ClientInformation object.

This method is deprecated, and is equivalent to calling the replacement method with replace set to false.

Specified by:

storeClientInformation in interface ClientInformationManager

Parameters:

clientInformation - The client information to be stored

expiration - The expiration for record, or null

Throws:

ClientInformationManagerException - If the client information cannot be stored.

destroyClientInformation

public void destroyClientInformation(@Nullable
 ClientID clientId)

Invalidates or otherwise removes a ClientInformation from persistent storage.

Specified by:

destroyClientInformation in interface ClientInformationManager

Parameters:

clientId - the unique ID of the client information to destroy.