ResourceLoader.java

package org.rapidoid.http.customize;

import org.rapidoid.annotation.Authors;
import org.rapidoid.annotation.Since;

/*
 * #%L
 * rapidoid-http-fast
 * %%
 * Copyright (C) 2014 - 2017 Nikolche Mihajlovski and contributors
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */

@Authors("Nikolche Mihajlovski")
@Since("5.2.0")
public interface ResourceLoader {

	/**
	 * Loads and retrieves a resource with the specified name, if such resource exists.
	 *
	 * @param resourceName the resource name e.g. "templates/index.html" or "abc.txt"
	 * @return the resource content (as bytes) if found, <code>null</code> otherwise
	 * @throws Exception unexpected exceptions could happen, so the caller is forced to handle them
	 */
	byte[] load(String resourceName) throws Exception;

}