org.sdase.commons.server.auth.key

Interface KeySource

All Known Implementing Classes:

JwksKeySource, OpenIdProviderDiscoveryKeySource, PemKeySource

public interface KeySource

The source for loading keys.

Method Summary

Modifier and Type	Method and Description
java.util.List<LoadedPublicKey>	loadKeysFromSource() Loads the keys provided by this source.
default java.util.Optional<java.util.List<LoadedPublicKey>>	reloadKeysFromSource() Loads the keys provided by this source again.

Method Detail

loadKeysFromSource

java.util.List<LoadedPublicKey> loadKeysFromSource()
                                            throws KeyLoadFailedException

Loads the keys provided by this source.

Returns:

All keys that this source provides.

Throws:

KeyLoadFailedException - if loading of keys failed. If a source intentionally does not provide keys, an empty list should be returned instead of throwing an exception.

reloadKeysFromSource

default java.util.Optional<java.util.List<LoadedPublicKey>> reloadKeysFromSource()

Loads the keys provided by this source again. Implementations may override the default method

Returns:

All keys that this source provides or

• an empty Optional if the source does not support reloading or
• an empty Optional if reloading failed

Implementations may not support reloading if the source knows that the keys will never change. Callers should keep the previously loaded keys, when receiving an empty Optional here.