package org.infinispan.util;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.util.Collection;
/**
* <p>
* Holds the logic of looking up a file, in the following sequence:
* </p> <ol> <li> try to load it with the current thread's
* context ClassLoader</li> <li> if fails, the system ClassLoader</li> <li> if fails, try to load it as a file from the
* disk </li> </ol>
*
* <p>
* Use {@link FileLookupFactory} to obtain an instance of {@link FileLookup}. This will result in an extended version
* of {@link FileLookup} being used if in an OSGI environment.
* </p>
*
* @author Mircea.Markus@jboss.com
* @author Pete Muir
* @since 4.0
*/
public interface FileLookup {
/**
* Looks up the file, see : {@link DefaultFileLookup}.
*
* @param filename might be the name of the file (too look it up in the class path) or an url to a file.
* @return an input stream to the file or null if nothing found through all lookup steps.
*/
public InputStream lookupFile(String filename, ClassLoader cl);
/**
* Looks up the file, see : {@link DefaultFileLookup}.
*
* @param filename might be the name of the file (too look it up in the class path) or an url to a file.
* @return an input stream to the file or null if nothing found through all lookup steps.
* @throws FileNotFoundException if file cannot be found
*/
public InputStream lookupFileStrict(String filename, ClassLoader cl) throws FileNotFoundException;
public URL lookupFileLocation(String filename, ClassLoader cl);
public Collection<URL> lookupFileLocations(String filename, ClassLoader cl) throws IOException;
}