net.unicon.cas.mfa.web.flow.event.MultiFactorAuthenticationSpringWebflowEventBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cas-mfa-java Show documentation

This module is intended to include all the Java you need to add to a CAS implementation to take advantage of the extended multifactor authentication features in this project.

There is a newer version: 2.0.0-RC3

Show newest version

package net.unicon.cas.mfa.web.flow.event;

import org.springframework.webflow.execution.Event;
import org.springframework.webflow.execution.RequestContext;

/**
 * Describes the necessary mechanics for building multifactor event ids
 * for spring webflow from one transition to another.
 * @author Misagh Moayyed
 */
public interface MultiFactorAuthenticationSpringWebflowEventBuilder {

    /**
     * The Constant MFA_EVENT_ID_PREFIX.
     */
    String MFA_EVENT_ID_PREFIX = "mfa-";

    /**
     * Builds the MFA event required for the next transition to occur.
     *
     * @param context the context
     * @return the event
     * @throws java.lang.IllegalStateException if no matching transitions exists
     * for this particular event. Implementations may want to check the request context
     * for the validity of the configured event before passing it on.
     */
    Event buildEvent(RequestContext context);
}