<?php

/*

 * This file is part of the Symfony framework.

 *

 * (c) Fabien Potencier <fabien@symfony.com>

 *

 * This source file is subject to the MIT license that is bundled

 * with this source code in the file LICENSE.

 */

namespace Symfony\Component\Security\Http\Authentication;

use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;

use Symfony\Component\HttpFoundation\Request;

/**

 * Interface for a custom authentication success handler

 *

 * If you want to customize the success handling process, instead of

 * overwriting the respective listener globally, you can set a custom success

 * handler which implements this interface.

 *

 * @author Johannes M. Schmitt <schmittjoh@gmail.com>

 */

interface AuthenticationSuccessHandlerInterface

{

    /**

     * This is called when an interactive authentication attempt succeeds. This

     * is called by authentication listeners inheriting from

     * AbstractAuthenticationListener.

     *

     * @param Request        $request

     * @param TokenInterface $token

     *

     * @return Response the response to return

     */

    function onAuthenticationSuccess(Request $request, TokenInterface $token);

}