bug #38751 [Security] Move AbstractListener abstract methods to the new FirewallListenerInterface (chalasr)

This PR was merged into the 5.x branch.

Discussion
----------

[Security] Move AbstractListener abstract methods to the new FirewallListenerInterface

| Q             | A
| ------------- | ---
| Branch?       | 5.x
| Bug fix?      | no
| New feature?  | -
| Deprecations? | no
| Tickets       | -
| License       | MIT
| Doc PR        | -

We added a FirewallListenerInterface in 5.2, let's make it complete to allow for cleaner firewall listener implementations.

Commits
-------

5dd70bd62e [Security] Move AbstractListener abstract methods to the new FirewallListenerInterface

Author: nicolas-grekas

Authentication/AuthenticatorManagerInterface.php

@@ -13,7 +13,7 @@
 
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
-use Symfony\Component\Security\Http\Firewall\AbstractListener;
+use Symfony\Component\Security\Http\Firewall\FirewallListenerInterface;
 
 /**
  * @author Wouter de Jong <wouter@wouterj.nl>
@@ -26,7 +26,7 @@ interface AuthenticatorManagerInterface
     /**
      * Called to see if authentication should be attempted on this request.
      *
-     * @see AbstractListener::supports()
+     * @see FirewallListenerInterface::supports()
      */
     public function supports(Request $request): ?bool;
 

Firewall/AbstractListener.php

@@ -11,7 +11,6 @@
 
 namespace Symfony\Component\Security\Http\Firewall;
 
-use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Event\RequestEvent;
 
 /**
@@ -28,18 +27,6 @@ final public function __invoke(RequestEvent $event)
         }
     }
 
-    /**
-     * Tells whether the authenticate() method should be called or not depending on the incoming request.
-     *
-     * Returning null means authenticate() can be called lazily when accessing the token storage.
-     */
-    abstract public function supports(Request $request): ?bool;
-
-    /**
-     * Does whatever is required to authenticate the request, typically calling $event->setResponse() internally.
-     */
-    abstract public function authenticate(RequestEvent $event);
-
     public static function getPriority(): int
     {
         return 0; // Default

Firewall/FirewallListenerInterface.php

@@ -11,13 +11,30 @@
 
 namespace Symfony\Component\Security\Http\Firewall;
 
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\Event\RequestEvent;
+
 /**
- * Can be implemented by firewall listeners to define their priority in execution.
+ * Can be implemented by firewall listeners.
  *
  * @author Christian Scheb <me@christianscheb.de>
+ * @author Nicolas Grekas <p@tchwork.com>
+ * @author Robin Chalas <robin.chalas@gmail.com>
  */
 interface FirewallListenerInterface
 {
+    /**
+     * Tells whether the authenticate() method should be called or not depending on the incoming request.
+     *
+     * Returning null means authenticate() can be called lazily when accessing the token storage.
+     */
+    public function supports(Request $request): ?bool;
+
+    /**
+     * Does whatever is required to authenticate the request, typically calling $event->setResponse() internally.
+     */
+    public function authenticate(RequestEvent $event);
+
     /**
      * Defines the priority of the listener.
      * The higher the number, the earlier a listener is executed.