IOCMDiscoveryService.php 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2023 Maxence Lange <maxence@artificial-owl.com>
  5. *
  6. * @author Maxence Lange <maxence@artificial-owl.com>
  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\OCM;
  25. use OCP\OCM\Exceptions\OCMProviderException;
  26. /**
  27. * Discover remote OCM services
  28. *
  29. * @since 28.0.0
  30. */
  31. interface IOCMDiscoveryService {
  32. /**
  33. * Discover remote OCM services
  34. *
  35. * @param string $remote address of the remote provider
  36. * @param bool $skipCache ignore cache, refresh data
  37. *
  38. * @return IOCMProvider
  39. * @throws OCMProviderException if no valid discovery data can be returned
  40. * @since 28.0.0
  41. */
  42. public function discover(string $remote, bool $skipCache = false): IOCMProvider;
  43. }