Merge pull request zendframework/zendframework#5901 from danizord/fea…

…ture/authentication-service-interface

Add AuthenticationServiceInterface

src/AuthenticationService.php

@@ -9,7 +9,7 @@
 
 namespace Zend\Authentication;
 
-class AuthenticationService
+class AuthenticationService implements AuthenticationServiceInterface
 {
     /**
      * Persistent storage handler

src/AuthenticationServiceInterface.php

@@ -0,0 +1,44 @@
+<?php
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
+ * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace Zend\Authentication;
+
+/**
+ * Provides an API for authentication and identity management
+ */
+interface AuthenticationServiceInterface
+{
+    /**
+     * Authenticates and provides an authentication result
+     *
+     * @return Result
+     */
+    public function authenticate();
+
+    /**
+     * Returns true if and only if an identity is available
+     *
+     * @return bool
+     */
+    public function hasIdentity();
+
+    /**
+     * Returns the authenticated identity or null if no identity is available
+     *
+     * @return mixed|null
+     */
+    public function getIdentity();
+
+    /**
+     * Clears the identity
+     *
+     * @return void
+     */
+    public function clearIdentity();
+}