• Home
• org.apereo.cas
• cas-server-support-interrupt-api
• 7.2.0-RC3
• source code
• InterruptTrackingEngine.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.apereo.cas.interrupt.InterruptTrackingEngine Maven / Gradle / Ivy

package org.apereo.cas.interrupt;

import org.springframework.webflow.execution.RequestContext;
import java.util.Optional;

/**
 * This is {@link InterruptTrackingEngine}.
 *
 * @author Misagh Moayyed
 * @since 7.0.0
 */
public interface InterruptTrackingEngine {
    /**
     * Default bean name.
     */
    String BEAN_NAME = "interruptTrackingEngine";

    /**
     * Attribute recorded in authentication to indicate interrupt is finalized.
     */
    String AUTHENTICATION_ATTRIBUTE_FINALIZED_INTERRUPT = "finalizedInterrupt";

    /**
     * Track interrupt.
     * 

     * An authentication attempt can only contain {@link #AUTHENTICATION_ATTRIBUTE_FINALIZED_INTERRUPT}
     * if the attribute was added to the authentication object prior to creating the SSO session.
     * If interrupt checking is set to execute after SSO sessions, then this attribute cannot be retrieved.
     *
     * @param requestContext the request context
     * @param response       the response
     * @throws Throwable the throwable
     */
    void trackInterrupt(RequestContext requestContext, InterruptResponse response) throws Throwable;

    /**
     * Remove interrupt.
     *
     * @param requestContext the request context
     */
    void removeInterrupt(RequestContext requestContext);

    /**
     * Gets current interrupt response.
     *
     * @param requestContext the request context
     * @return the current interrupt response
     */
    Optional forCurrentRequest(RequestContext requestContext);

    /**
     * Is authentication flow interrupted?
     * An authentication attempt can only contain {@link #AUTHENTICATION_ATTRIBUTE_FINALIZED_INTERRUPT}
     * if the attribute was added to the authentication object prior to creating the SSO session.
     * If interrupt checking is set to execute after SSO sessions, then this attribute cannot be collected.
     *
     * @param requestContext the request context
     * @return true or false
     */
    boolean isInterrupted(RequestContext requestContext);
}