/**
 * Copyright (c) 2014, the Railo Company Ltd.
 * Copyright (c) 2015, Lucee Assosication Switzerland
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either 
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public 
 * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
 * 
 */
package lucee.commons.io.res;

import java.io.IOException;
import java.io.Serializable;
import java.util.Map;

/**
 * Interface for resource provider, loaded by "Resources",
 * classes that implement a provider that produce resources, that match given
 * path.
 * 
 */
public interface ResourceProvider extends Serializable {

	/**
	 * this class is called by the "Resources" at startup
	 * 
	 * @param scheme of the provider (can be "null")
	 * @param arguments initals argument (can be "null")
	 */
	public ResourceProvider init(String scheme, Map<String, String> arguments);

	/**
	 * return a resource that match given path
	 * 
	 * @param path
	 * @return matching resource to path
	 */
	public Resource getResource(String path);

	/**
	 * returns the scheme of the resource
	 * 
	 * @return scheme
	 */
	public String getScheme();

	/**
	 * returns the arguments defined for this resource
	 * 
	 * @return scheme
	 */
	public Map<String, String> getArguments();

	public void setResources(Resources resources);

	public void unlock(Resource res);

	public void lock(Resource res) throws IOException;

	public void read(Resource res) throws IOException;

	/**
	 * returns if the resources of the provider are case-sensitive or not
	 * 
	 * @return is resource case-sensitive or not
	 */
	public boolean isCaseSensitive();

	/**
	 * returns if the resource support mode for his resources
	 * 
	 * @return is mode supported or not
	 */
	public boolean isModeSupported();

	/**
	 * returns if the resource support attributes for his resources
	 * 
	 * @return is attributes supported or not
	 */
	public boolean isAttributesSupported();
}