001/*
002 *  Copyright 2020 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.core.resources;
017
018import org.apache.excalibur.source.Source;
019
020import org.ametys.runtime.plugin.component.Prioritizable;
021
022/**
023 * Provides a {@link ResourceHandler} able to process a {@link Source}.
024 */
025public interface ResourceHandlerProvider extends Prioritizable
026{
027    /** Minimum priority. */
028    public static final int MIN_PRIORITY = 0;
029    /** Maximum priority. */
030    public static final int MAX_PRIORITY = Integer.MAX_VALUE;
031
032    @Override
033    default int getPriority()
034    {
035        return MIN_PRIORITY;
036    }
037    
038    /**
039     * Returns the corresponding {@link ResourceHandler} or null if none.<br>
040     * Returned {@link ResourceHandler} should be thread safe.
041     * @param source the requested resource.
042     * @return a ResourceHandler able to process the resource.
043     * @throws Exception if an error occurs during ResourceHandler creation.
044     */
045    public ResourceHandler getResourceHandler(String source) throws Exception;
046}