1<?php
2/**
3 * @copyright 2016 Christoph Wurst <christoph@winzerhof-wurst.at>
4 *
5 * @author Christoph Wurst <christoph@winzerhof-wurst.at>
6 * @author Morris Jobke <hey@morrisjobke.de>
7 *
8 * @license GNU AGPL version 3 or any later version
9 *
10 * This program is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU Affero General Public License as
12 * published by the Free Software Foundation, either version 3 of the
13 * License, or (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU Affero General Public License for more details.
19 *
20 * You should have received a copy of the GNU Affero General Public License
21 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 *
23 */
24namespace OCP\Authentication\LoginCredentials;
25
26use OCP\Authentication\Exceptions\PasswordUnavailableException;
27
28/**
29 * @since 12
30 */
31interface ICredentials {
32
33	/**
34	 * Get the user UID
35	 *
36	 * @since 12
37	 *
38	 * @return string
39	 */
40	public function getUID();
41
42	/**
43	 * Get the login name the users used to login
44	 *
45	 * @since 12
46	 *
47	 * @return string
48	 */
49	public function getLoginName();
50
51	/**
52	 * Get the password
53	 *
54	 * @since 12
55	 *
56	 * @return string
57	 * @throws PasswordUnavailableException
58	 */
59	public function getPassword();
60}
61