ICredentials.php 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  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. */
  24. namespace OCP\Authentication\LoginCredentials;
  25. use OCP\Authentication\Exceptions\PasswordUnavailableException;
  26. /**
  27. * @since 12
  28. */
  29. interface ICredentials {
  30. /**
  31. * Get the user UID
  32. *
  33. * @since 12
  34. *
  35. * @return string
  36. */
  37. public function getUID();
  38. /**
  39. * Get the login name the users used to login
  40. *
  41. * @since 12
  42. *
  43. * @return string
  44. */
  45. public function getLoginName();
  46. /**
  47. * Get the password
  48. *
  49. * @since 12
  50. *
  51. * @return string|null
  52. * @throws PasswordUnavailableException
  53. */
  54. public function getPassword();
  55. }