CasLogoutHandler.java

package org.pac4j.cas.logout;

import org.pac4j.core.context.WebContext;

/**
 * This interface defines how to handle CAS logout request on client side.
 * 
 * @author Jerome Leleu
 * @since 1.9.2
 */
public interface CasLogoutHandler<C extends WebContext> {

    /**
     * Associates a ticket with the current web session.
     *
     * @param context the web context
     * @param ticket the ticket
     */
    void recordSession(C context, String ticket);

    /**
     * Destroys the current web session for the given ticket for a front channel logout.
     *
     * @param context the web context
     * @param ticket the ticket
     */
    void destroySessionFront(C context, String ticket);

    /**
     * Destroys the current web session for the given ticket for a back channel logout.
     * 
     * @param context the web context
     * @param ticket the ticket
     */
    void destroySessionBack(C context, String ticket);

    /**
     * Renew the web session.
     *
     * @param oldSessionId the old session identifier
     * @param context the web context
     */
    void renewSession(String oldSessionId, C context);
}