WebResourceScriptCache.java

package org.apache.sling.webresource;

import java.io.IOException;
import java.io.InputStream;
import java.util.List;
import java.util.Map;

import javax.jcr.RepositoryException;
import javax.jcr.Session;

import org.apache.sling.api.resource.LoginException;
import org.apache.sling.webresource.exception.WebResourceCompileException;
import org.apache.sling.webresource.exception.WebResourceCompilerNotFoundException;

/**
 * 
 * Service that interfaces to the WebResouce compilers and JCR to produce
 * compiled Web Resources.
 * 
 * @author bpaulin
 * 
 */
public interface WebResourceScriptCache {

	/**
	 * 
	 * Returns a path to the Cache of compiled Web Resources. If it's out of
	 * date or does not yet exists the web resource is compiled and saved to
	 * path specified in complier service
	 * 
	 * @param session
	 *            JCRSession
	 * @param path
	 *            Path to Web Resource file
	 * @return
	 * @throws RepositoryException
	 * @throws IOException
	 */
	public String getCompiledScriptPath(Session session, String path)
			throws WebResourceCompileException,
			WebResourceCompilerNotFoundException;

	/**
	 * 
	 * Returns a map of compiled web resource types with paths to the compile
	 * scripts.
	 * 
	 * @param session
	 * @param webResourceGroupName
	 * @return
	 * @throws RepositoryException
	 */
	public Map<String, List<String>> getWebResourceCachedInventoryPaths(
			Session session, String webResourceGroupName)
			throws RepositoryException;

	/**
	 * 
	 * Get Paths to consolidated Web Resources
	 * 
	 * @param session
	 * @param webResourceGroupName
	 * @return
	 * @throws WebResourceCompileException
	 */
	public Map<String, List<String>> getCompiledWebResourceGroupPaths(
			Session session, String webResourceGroupName, boolean consolidate)
			throws WebResourceCompileException;
	
	public InputStream getGlobalWebResourceScripts() throws RepositoryException, LoginException;

}