/*
 * MIT License
 *
 * Copyright (c) 2020-present Cloudogu GmbH and Contributors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package sonia.scm.repository;

import java.util.Collection;

/**
 * Provider for available verbs and roles for repository permissions, such as "read", "modify", "pull", "push", etc.
 * This collection of verbs can be extended by plugins and be grouped to roles, such as "READ", "WRITE", etc.
 * The permissions are configured by "repository-permissions.xml" files from the core and from plugins.
 *
 * @since 2.12.0
 */
public interface PermissionProvider {

  /**
   * The collection of all registered verbs.
   */
  Collection<String> availableVerbs();

  /**
   * The collection of verbs that are marked as "read only". These verbs are safe for archived or otherwise read only
   * repositories.
   */
  Collection<String> readOnlyVerbs();

  /**
   * The collection of roles defined and extended by core and plugins.
   */
  Collection<RepositoryRole> availableRoles();
}
