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

//~--- JDK imports ------------------------------------------------------------

import javax.servlet.ServletContext;
import java.net.URL;

/**
 * The WebResourceLoader is able to load web resources. The resources are loaded
 * from a plugin webapp directory or from the {@link ServletContext}, according
 * to its implementation. The {@link UberWebResourceLoader} is able to load
 * resources from the {@link ServletContext} and all plugin directories.
 *
 * @author Sebastian Sdorra
 * @since 2.0.0
 */
public interface WebResourceLoader
{

  /**
   * Returns a {@link URL} for the given path. The method will return null if no
   * resources could be found for the given path.
   *
   * Note: The path is a web path and uses "/" as path separator
   *
   * @param path resource path
   *
   * @return url object for the given path or null
   */
  URL getResource(String path);
}
