net.jawr.web.resource.ImageResourcesHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jawr-core Show documentation

Javascript/CSS bundling and compressing tool for java web apps. By using jawr resources are automatically bundled together and optionally minified and gzipped. Jawr provides tag libraries to reference a generated bundle either by id or by using the name of any of its members.

There is a newer version: 3.9

Show newest version

/**
 * Copyright 2009-2011 Ibrahim Chaehoi
 * 
 * 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.
 */
package net.jawr.web.resource;

import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

import net.jawr.web.config.JawrConfig;
import net.jawr.web.resource.handler.bundle.ResourceBundleHandler;
import net.jawr.web.resource.handler.reader.ResourceReaderHandler;

/**
 * This class defines the image resource handler.
 * 
 * @author Ibrahim Chaehoi
 *
 */
public class ImageResourcesHandler {

	/** The image map */
	private Map imageMap = new ConcurrentHashMap();
	
	/** The Jawr config */
	private JawrConfig jawrConfig;
	
	/** The resource handler */
	private ResourceReaderHandler rsHandler;
	
	/** The resource bundle handler */
	private ResourceBundleHandler rsBundleHandler;
	
	/**
	 * Constructor
	 * @param config
	 * @param rsHandler 
	 */
	public ImageResourcesHandler(JawrConfig config, ResourceReaderHandler rsHandler, ResourceBundleHandler rsBundleHandler){
		this.jawrConfig = config;
		this.rsHandler = rsHandler;
		this.rsBundleHandler = rsBundleHandler;
	}
	
	/**
	 * @return the jawrConfig
	 */
	public JawrConfig getConfig() {
		return jawrConfig;
	}

	/**
	 * @param jawrConfig the jawrConfig to set
	 */
	public void setJawrConfig(JawrConfig jawrConfig) {
		this.jawrConfig = jawrConfig;
	}
	
	/**
	 * Returns the resource handler
	 * @return the resource handler
	 */
	public ResourceReaderHandler getRsReaderHandler() {
		return rsHandler;
	}
	
	/**
	 * Returns the resource handler
	 * @return the resource handler
	 */
	public ResourceBundleHandler getRsBundleHandler() {
		return rsBundleHandler;
	}
	
	/**
	 * Sets the resource handler
	 * @param rsHandler the resource handler to set
	 */
	public void setRsReaderHandler(ResourceReaderHandler rsHandler) {
		this.rsHandler = rsHandler;
	}
	
	/**
	 * Returns the image map
	 * @return the image Map
	 */
	public Map getImageMap() {
		return imageMap;
	}

	/**
	 * Add an image mapping
	 * @param imgUrl the original url
	 * @param cacheUrl the cache url
	 */
	public void addMapping(String imgUrl, String cacheUrl){
		imageMap.put(imgUrl, cacheUrl);
	}
	
	/**
	 * Return the cache image URL
	 * @param imgUrl the image url
	 * @return the cache image URL
	 */
	public String getCacheUrl(String imgUrl){
		return imageMap.get(imgUrl);
	}
	
	/**
	 * Clears the image map 
	 */
	public void clear(){
	
		imageMap.clear();
	}

	/**
	 * Checks if the requested image is a valid one or not
	 * @param requestedPath the requested path
	 * @return true if the requested image is a valid one or not
	 */
	public boolean containsValidBundleHashcode(String requestedPath) {
		return imageMap.containsValue(requestedPath);
	}
	
}