1
0

IHandler.php 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright 2020 Christoph Wurst <christoph@winzerhof-wurst.at>
  5. *
  6. * @author Christoph Wurst <christoph@winzerhof-wurst.at>
  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\Http\WellKnown;
  25. /**
  26. * Interface for an app handler that reacts to requests to Nextcloud's well
  27. * known URLs, e.g. to a WebFinger
  28. *
  29. * @ref https://tools.ietf.org/html/rfc5785
  30. *
  31. * @since 21.0.0
  32. */
  33. interface IHandler {
  34. /**
  35. * @param string $service the name of the well known service, e.g. 'webfinger'
  36. * @param IRequestContext $context
  37. * @param IResponse|null $previousResponse the response of the previous handler, if any
  38. *
  39. * @return IResponse|null a response object if the request could be handled, null otherwise
  40. *
  41. * @since 21.0.0
  42. */
  43. public function handle(string $service, IRequestContext $context, ?IResponse $previousResponse): ?IResponse;
  44. }