Classes List

Symfony\Component\Security\Http\EntryPoint\AuthenticationEntryPointInterface

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
<?php

/* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */


namespace Symfony\Component\Security\Http\EntryPoint;

use Symfony\Component\Security\Core\Exception\AuthenticationException;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;

/** * Implement this interface for any classes that will be called to "start" * the authentication process (see method for more details). * * @author Fabien Potencier <fabien@symfony.com> */
interface AuthenticationEntryPointInterface
{
    /** * Returns a response that directs the user to authenticate. * * This is called when an anonymous request accesses a resource that * requires authentication. The job of this method is to return some * response that "helps" the user start into the authentication process. * * Examples: * A) For a form login, you might redirect to the login page * return new RedirectResponse('/login'); * B) For an API token authentication system, you return a 401 response * return new Response('Auth header required', 401); * * @param Request $request The request that resulted in an AuthenticationException * @param AuthenticationException $authException The exception that started the authentication process * * @return Response */
    public function start(Request $requestAuthenticationException $authException = null);
}