/*
 * 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 sonia.scm.plugin.ExtensionPoint;

/**
 * ExtensionPoint to modify the path matching behaviour for a certain type of repositories.
 * 
 * @author Sebastian Sdorra
 * @since 1.54
 */
@ExtensionPoint
public interface RepositoryPathMatcher {
  
  /**
   * Returns {@code true} if the path matches the repository.
   * 
   * @param repository repository
   * @param path requested path without context and without type information extracted from uri
   * 
   * @return {@code true} if the path matches
   */
  boolean isPathMatching(Repository repository, String path);
  
  /**
   * Returns the type of repository for which the matcher is responsible.
   * 
   * @return type of repository
   */
  String getType();
}
