<?php
// {{{ICINGA_LICENSE_HEADER}}}
/**
 * This file is part of Icinga Web 2.
 *
 * Icinga Web 2 - Head for multiple monitoring backends.
 * Copyright (C) 2013 Icinga Development Team
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 * @copyright  2013 Icinga Development Team <info@icinga.org>
 * @license    http://www.gnu.org/licenses/gpl-2.0.txt GPL, version 2
 * @author     Icinga Development Team <info@icinga.org>
 *
 */
// {{{ICINGA_LICENSE_HEADER}}}}

namespace Icinga\Authentication;

use \Zend_Config;
use \Icinga\User;
use Icinga\Authentication\Credential;

/**
 * Public api for an user backend object
 */
interface UserBackend
{
    /**
     * Test if the username exists
     *
     * @param   Credential $credentials
     *
     * @return  bool
     */
    public function hasUsername(Credential $credentials);

    /**
     * Authenticate
     *
     * @param   Credential $credentials
     *
     * @return  User
     */
    public function authenticate(Credential $credentials);

    /**
     * Name of the backend
     *
     * @return string
     */
    public function getName();

    /**
     * Get the number of users available through this backend
     *
     * @return int
     */
    public function getUserCount();

    /**
     * Establish the connection to this authentication backend
     *
     * @throws ConfigurationError   When the backend is not reachable with the given configuration.
     */
    public function connect();
}