net.jawr.web.servlet.IllegalBundleRequestHandler 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.

The newest version!

/**
 * Copyright 2010 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.servlet;

import java.io.IOException;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * This interface defines the methods of the Handler for illegal requested bundles,
 * the bundle which are requested with a wrong hashcode.
 * 
 * @author Ibrahim Chaehoi
 */
public interface IllegalBundleRequestHandler {

	/**
	 * This method can update the response header and 
	 * returns true if the header has been written 
	 * and false if Jawr must write the response header.
	 * @param requestedPath the requested path
	 * @param request the request
	 * @param response the response
	 * @return true if the header has been written 
	 * and false if Jawr must write the response header.
	 * @throws IOException if an IOException occurs
	 */
	boolean writeResponseHeader(String requestedPath, HttpServletRequest request, HttpServletResponse response) throws IOException;
	
	/**
	 * This method should return true if Jawr should send back the content of the bundle.
	 * It is important to note that if this method return false
	 * @param requestedPath the requested path
	 * @param request the request
	 * @return true if if Jawr should send back the content of the bundle
	 */
	boolean canWriteContent(String requestedPath, HttpServletRequest request);
	
}