org.pac4j.oidc.util.ValueRetriever Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pac4j-oidc Show documentation

There is a newer version: 6.1.0

package org.pac4j.oidc.util;

import org.pac4j.core.context.CallContext;
import org.pac4j.oidc.client.OidcClient;

import java.util.Optional;

/**
 * ValueRetriever retrieves a given value from the {@link org.pac4j.core.context.WebContext}. It can
 * either read the value from the session store or use some method to regenerate
 * the value. This is used to validate values such as the {@link com.nimbusds.oauth2.sdk.id.State}, for
 * CSRF mitigation or the {@link com.nimbusds.oauth2.sdk.pkce.CodeVerifier} for PKCE.
 *
 * @author Martin Hansen
 * @author Emond Papegaaij
 * @since 4.0.3
 */
@FunctionalInterface
public interface ValueRetriever {

    /**
     * retrieve.
     *
     * @param ctx a {@link CallContext} object
     * @param key a {@link String} object
     * @param client a {@link OidcClient} object
     * @return a {@link Optional} object
     */
    Optional