Package net.shibboleth.oidc.metadata

Interface ClientInformationManager

All Known Implementing Classes:

StorageServiceClientInformationManager

public interface ClientInformationManager

A manager that is capable of managing ClientInformation instances.

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, for removal: This API element is subject to removal in a future version.
default void	storeClientInformation(OIDCClientInformation clientInformation, Instant expiration, boolean replace)	Store a ClientInformation object.

Method Details

storeClientInformation

@Deprecated(since="1.2.0",
            forRemoval=true)
void storeClientInformation(@Nonnull
 OIDCClientInformation clientInformation,
 @Nullable
 Instant expiration)
                     throws ClientInformationManagerException

Deprecated, for removal: This API element is subject to removal in a future version.

Store a ClientInformation object.

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

Parameters:

clientInformation - The client information to be stored

expiration - The expiration for record, or null

Throws:

ClientInformationManagerException - If the client information cannot be stored.

storeClientInformation

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

Store a ClientInformation object.

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.

destroyClientInformation

void destroyClientInformation(@Nonnull
 ClientID clientId)
                       throws ClientInformationManagerException

Invalidates or otherwise removes a ClientInformation from persistent storage.

Parameters:

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

Throws:

ClientInformationManagerException - If the client information cannot be destroyed.