Package org.keycloak.rotation

Class CompositeKeyLocator

java.lang.Object

org.keycloak.rotation.CompositeKeyLocator

All Implemented Interfaces:

Iterable<Key>, KeyLocator

public class CompositeKeyLocator
extends Object
implements KeyLocator, Iterable<Key>

KeyLocator that represents a list of multiple KeyLocators. Key is searched from the first to the last KeyLocator in the order given by the list. If there are multiple KeyLocators providing key with the same key ID, the first matching key is returned.

Author:

hmlnarik

Nested Class Summary

Nested classes/interfaces inherited from interface org.keycloak.rotation.KeyLocator

KeyLocator.KeyHash

Constructor Summary

Constructors

Constructor	Description
CompositeKeyLocator()

Method Summary

Modifier and Type	Method	Description
void	add(KeyLocator keyLocator)	Registers a given KeyLocator as the last KeyLocator.
void	addFirst(KeyLocator keyLocator)	Registers a given KeyLocator as the first KeyLocator.
void	clear()	Clears the list of registered KeyLocators
Key	getKey(String kid)	Returns a key with a particular ID.
Key	getKey(Key key)	Method that checks if the key passed is inside the locator.
Iterator<Key>	iterator()
void	refreshKeyCache()	If this key locator caches keys in any way, forces this cache cleanup and refreshing the keys.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.keycloak.rotation.KeyLocator

getKey

Constructor Details

CompositeKeyLocator

public CompositeKeyLocator()

Method Details

getKey

public Key getKey(String kid)
           throws KeyManagementException

Description copied from interface: KeyLocator

Returns a key with a particular ID.

Specified by:

getKey in interface KeyLocator

Parameters:

kid - Key ID

Returns:

key, which should be used for verify signature on given "input"

Throws:

KeyManagementException

getKey

public Key getKey(Key key)
           throws KeyManagementException

Description copied from interface: KeyLocator

Method that checks if the key passed is inside the locator.

Specified by:

getKey in interface KeyLocator

Parameters:

key - The key to search

Returns:

The same key or null if it's not in the locator

Throws:

KeyManagementException

refreshKeyCache

public void refreshKeyCache()

Description copied from interface: KeyLocator

If this key locator caches keys in any way, forces this cache cleanup and refreshing the keys.

Specified by:

refreshKeyCache in interface KeyLocator

addFirst

public void addFirst(KeyLocator keyLocator)

Registers a given KeyLocator as the first KeyLocator.

add

public void add(KeyLocator keyLocator)

Registers a given KeyLocator as the last KeyLocator.

clear

public void clear()

Clears the list of registered KeyLocators

toString

public String toString()

Overrides:

toString in class Object

iterator

public Iterator<Key> iterator()

Specified by:

iterator in interface Iterable<Key>