com.ziesemer.utils.web.zipServlet

Class ZipServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.ziesemer.utils.web.zipServlet.ZipServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

Direct Known Subclasses:

ZipServlet

public class ZipServlet
extends javax.servlet.http.HttpServlet

HttpServlet to serve content from within a specified Zip (or Jar) file.

Follows the standards described in RFC 2616 as applicable. In particular, this implementation supports last modified checking and partial content requests.

Considered items better solved elsewhere:

• Filters to restrict access to/from specified paths/files. Chain with a Filter instead.
• gzip/deflate compression. Again, chain with a Filter instead, e.g. CompressFilter.
  • While it would be ideal to read and send the compressed bytes directly to the client from the Zip file as-is when possible (without uncompression or recompression), the java.util.zip APIs don't currently provide for this possibility.

Accepted ServletConfig parameters:

• zipFile (Required): Local path of zip file to serve. (Is effectively passed to ZipFile.ZipFile(String).)
• zipPrefix (Optional): Redefines the "root directory" in the zip file to serve from.
• comboEnabled (Optional): Enables or disables the functionality available by YUI's Combo Handling.
  • Value must be a valid argument to Boolean.parseBoolean(String).
  • Defaults to Boolean.TRUE.
• comboPath (Optional): Path on which combination requests will be answered.
  • Defaults to "combo".
  • An empty string is valid.
  • Any passed query parameters are treated as files to lookup in the zip file and send. If there are no query parameters, this functionality is ignored, and an attempt will be made to serve the file named by the value of comboPath from the zip file (like the basic functionality, as if the combination functionality was disabled).
• dateMode (Optional): Configures what date to use for the Last-Modified headers and conditional checks.
  • "zipEntry", default: Value of ZipEntry.getTime().
  • "zipFile": Value of the zip file's File.lastModified().
  • "servlet": Value of System.currentTimeMillis() upon GenericServlet.init().

Author:

Mark A. Ziesemer <www.ziesemer.com>

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static Pattern	COMBO_SPLIT_PATTERN
protected boolean	comboEnabled
protected String	comboPath
protected String	dateMode
protected long	initDate
protected static org.slf4j.Logger	LOGGER
protected static Pattern	RANGE_PATTERN
protected String	servletName
protected ZipFile	zipFile
protected String	zipPrefix

Constructor Summary

Constructors

Constructor and Description
ZipServlet()

Method Summary

Modifier and Type	Method and Description
protected void	check(ZipEntry entry, javax.servlet.http.HttpServletResponse response, String path, String file)
protected boolean	checkModifiedDates(long checkDate, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected byte[]	createResponseBuffer(javax.servlet.http.HttpServletResponse response)
protected void	denyDirectory(ZipEntry entry, javax.servlet.http.HttpServletResponse response, String path) ZipFile.getEntry(String) returns a ZipEntry for a directory, even if the passed name doesn't end with '/'.
void	destroy()
protected void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, boolean sendContent)
protected void	doHead(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected long	getCheckDate(long time)
protected void	getComboFiles(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, boolean sendContent)
protected void	getSingleFile(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, boolean sendContent)
void	init(javax.servlet.ServletConfig config)
protected void	initComboPath(javax.servlet.ServletConfig config)
protected void	initDateMode(javax.servlet.ServletConfig config)
protected void	initZipFile(javax.servlet.ServletConfig config)
protected void	initZipPrefix(javax.servlet.ServletConfig config)
protected void	setContentLength(javax.servlet.http.HttpServletResponse response, long length) Content-Length, http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13
protected boolean	setHeaders(com.ziesemer.utils.web.zipServlet.RequestContext rc, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	streamResource(com.ziesemer.utils.web.zipServlet.RequestContext rc, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	streamResource(ZipEntry entry, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	verifyExists(ZipEntry entry, javax.servlet.http.HttpServletResponse response, String path, String file)

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doOptions, doPost, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOGGER

protected static final org.slf4j.Logger LOGGER

RANGE_PATTERN

protected static final Pattern RANGE_PATTERN

COMBO_SPLIT_PATTERN

protected static final Pattern COMBO_SPLIT_PATTERN

zipFile

protected transient ZipFile zipFile

zipPrefix

protected String zipPrefix

comboEnabled

protected boolean comboEnabled

comboPath

protected String comboPath

dateMode

protected String dateMode

initDate

protected long initDate

servletName

protected String servletName

Constructor Detail

ZipServlet

public ZipServlet()

Method Detail

init

public void init(javax.servlet.ServletConfig config)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

initZipFile

protected void initZipFile(javax.servlet.ServletConfig config)
                    throws javax.servlet.ServletException

Throws:

javax.servlet.ServletException

initZipPrefix

protected void initZipPrefix(javax.servlet.ServletConfig config)
                      throws javax.servlet.ServletException

Throws:

javax.servlet.ServletException

initComboPath

protected void initComboPath(javax.servlet.ServletConfig config)
                      throws javax.servlet.ServletException

Throws:

javax.servlet.ServletException

initDateMode

protected void initDateMode(javax.servlet.ServletConfig config)
                     throws javax.servlet.ServletException

Throws:

javax.servlet.ServletException

doHead

protected void doHead(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws javax.servlet.ServletException,
                      IOException

Overrides:

doHead in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

doGet

protected void doGet(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws javax.servlet.ServletException,
                     IOException

Overrides:

doGet in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

doGet

protected void doGet(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response,
                     boolean sendContent)
              throws javax.servlet.ServletException,
                     IOException

Throws:

javax.servlet.ServletException

IOException

getSingleFile

protected void getSingleFile(javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response,
                             boolean sendContent)
                      throws javax.servlet.ServletException,
                             IOException

Throws:

javax.servlet.ServletException

IOException

getComboFiles

protected void getComboFiles(javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response,
                             boolean sendContent)
                      throws javax.servlet.ServletException,
                             IOException

Throws:

javax.servlet.ServletException

IOException

check

protected void check(ZipEntry entry,
                     javax.servlet.http.HttpServletResponse response,
                     String path,
                     String file)
              throws IOException

Throws:

IOException

verifyExists

protected void verifyExists(ZipEntry entry,
                            javax.servlet.http.HttpServletResponse response,
                            String path,
                            String file)
                     throws IOException

Throws:

IOException

denyDirectory

protected void denyDirectory(ZipEntry entry,
                             javax.servlet.http.HttpServletResponse response,
                             String path)
                      throws IOException

ZipFile.getEntry(String) returns a ZipEntry for a directory, even if the passed name doesn't end with '/'. However, this entry's ZipEntry.isDirectory() still returns false, so this needs to be checked for.

Throws:

IOException

setHeaders

protected boolean setHeaders(com.ziesemer.utils.web.zipServlet.RequestContext rc,
                             javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response)
                      throws javax.servlet.ServletException,
                             IOException

Throws:

javax.servlet.ServletException

IOException

getCheckDate

protected long getCheckDate(long time)

checkModifiedDates

protected boolean checkModifiedDates(long checkDate,
                                     javax.servlet.http.HttpServletRequest request,
                                     javax.servlet.http.HttpServletResponse response)

setContentLength

protected void setContentLength(javax.servlet.http.HttpServletResponse response,
                                long length)

Content-Length, http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13

streamResource

protected void streamResource(com.ziesemer.utils.web.zipServlet.RequestContext rc,
                              javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response)
                       throws IOException

Throws:

IOException

streamResource

protected void streamResource(ZipEntry entry,
                              javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response)
                       throws IOException

Throws:

IOException

createResponseBuffer

protected byte[] createResponseBuffer(javax.servlet.http.HttpServletResponse response)

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Servlet

Overrides:

destroy in class javax.servlet.GenericServlet