ILDAPProviderFactory.php 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2016, Roger Szabo (roger.szabo@web.de)
  4. *
  5. * @author Robin Appelman <robin@icewind.nl>
  6. * @author Roeland Jago Douma <roeland@famdouma.nl>
  7. * @author Roger Szabo <roger.szabo@web.de>
  8. * @author root <root@localhost.localdomain>
  9. *
  10. * @license GNU AGPL version 3 or any later version
  11. *
  12. * This program is free software: you can redistribute it and/or modify
  13. * it under the terms of the GNU Affero General Public License as
  14. * published by the Free Software Foundation, either version 3 of the
  15. * License, or (at your option) any later version.
  16. *
  17. * This program is distributed in the hope that it will be useful,
  18. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  20. * GNU Affero General Public License for more details.
  21. *
  22. * You should have received a copy of the GNU Affero General Public License
  23. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  24. *
  25. */
  26. namespace OCP\LDAP;
  27. use OCP\IServerContainer;
  28. /**
  29. * Interface ILDAPProviderFactory
  30. *
  31. * This class is responsible for instantiating and returning an ILDAPProvider
  32. * instance.
  33. *
  34. * @since 11.0.0
  35. */
  36. interface ILDAPProviderFactory {
  37. /**
  38. * Constructor for the LDAP provider factory
  39. *
  40. * @param IServerContainer $serverContainer server container
  41. * @since 11.0.0
  42. */
  43. public function __construct(IServerContainer $serverContainer);
  44. /**
  45. * creates and returns an instance of the ILDAPProvider
  46. *
  47. * @return ILDAPProvider
  48. * @since 11.0.0
  49. */
  50. public function getLDAPProvider();
  51. /**
  52. * Check if an ldap provider is available
  53. *
  54. * @return bool
  55. * @since 21.0.0
  56. */
  57. public function isAvailable(): bool;
  58. }