org.keycloak.models

Interface PushedAuthzRequestStoreProvider

All Superinterfaces:

Provider

All Known Implementing Classes:

InfinispanPushedAuthzRequestStoreProvider

public interface PushedAuthzRequestStoreProvider
extends Provider

Provides single-use cache for Pushed Authorization Request. The data of this request may be used only once.

Method Summary

Modifier and Type	Method and Description
void	put(UUID key, int lifespanSeconds, Map<String,String> codeData) Stores the given data and guarantees that data should be available in the store for at least the time specified by parameter.
Map<String,String>	remove(UUID key) This method returns data just if removal was successful.

Methods inherited from interface org.keycloak.provider.Provider

close

Method Detail

put

void put(UUID key,
         int lifespanSeconds,
         Map<String,String> codeData)

Stores the given data and guarantees that data should be available in the store for at least the time specified by parameter.

Parameters:

key - unique identifier

lifespanSeconds - time to live

codeData - the data to store

remove

Map<String,String> remove(UUID key)

This method returns data just if removal was successful. Implementation should guarantee that "remove" is single-use. So if 2 threads (even on different cluster nodes or on different cross-dc nodes) calls "remove(123)" concurrently, then just one of them is allowed to succeed and return data back. It can't happen that both will succeed.

Parameters:

key - unique identifier

Returns:

context data related Pushed Authorization Request. It returns null if there is no context data available.