org.apereo.cas.web.flow.DelegatedClientAuthenticationWebflowManager Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of cas-server-support-pac4j-api Show documentation

cas-server-support-pac4j-api

There is a newer version: 7.1.0

Show newest version

package org.apereo.cas.web.flow;

import org.apereo.cas.authentication.principal.Service;
import org.apereo.cas.ticket.TransientSessionTicket;

import org.pac4j.core.client.Client;
import org.pac4j.core.context.WebContext;
import org.pac4j.jee.context.JEEContext;
import org.springframework.webflow.execution.RequestContext;

/**
 * This is {@link DelegatedClientAuthenticationWebflowManager}.
 *
 * @author Misagh Moayyed
 * @since 6.4.0
 */
public interface DelegatedClientAuthenticationWebflowManager {
    /**
     * Client identifier associated with this session/request.
     */
    String PARAMETER_CLIENT_ID = "delegatedclientid";

    /**
     * Default implementation bean name.
     */
    String DEFAULT_BEAN_NAME = "delegatedClientWebflowManager";

    /**
     * Store.
     *
     * @param requestContext the request context
     * @param webContext     the web context
     * @param client         the client
     * @return the transient session ticket
     * @throws Throwable the throwable
     */
    TransientSessionTicket store(RequestContext requestContext,
                                 JEEContext webContext, Client client) throws Throwable;

    /**
     * Retrieve.
     *
     * @param requestContext the request context
     * @param webContext     the web context
     * @param client         the client
     * @return the service
     * @throws Throwable the throwable
     */
    Service retrieve(RequestContext requestContext, WebContext webContext, Client client) throws Throwable;
}