org.mmbase.servlet

Class HandleServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.mmbase.servlet.MMBaseServlet

org.mmbase.servlet.BridgeServlet

org.mmbase.servlet.HandleServlet

All Implemented Interfaces:

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

Direct Known Subclasses:

AttachmentServlet, ImageServlet

public class HandleServlet
extends BridgeServlet

Base servlet for nodes with a 'handle' field. It serves as a basic implementation for more specialized servlets. The mime-type is always application/x-binary, forcing the browser to download.

Since:

MMBase-1.6

Version:

$Id$

Author:

Michiel Meeuwissen

See Also:

ImageServlet, AttachmentServlet, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.mmbase.servlet.BridgeServlet

BridgeServlet.QueryParts

Field Summary

Fields

Modifier and Type	Field and Description
protected static Pattern	legalizeFileName

Fields inherited from class org.mmbase.servlet.BridgeServlet

FILE_PATTERN, MESSAGE_ATTRIBUTE

Fields inherited from class org.mmbase.servlet.MMBaseServlet

mmbase, retryAfter

Constructor Summary

Constructors

Constructor and Description
HandleServlet()

Method Summary

Modifier and Type	Method and Description
void	doGet(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Serves a node with a byte[] handle field as an attachment.
protected Map<String,Integer>	getAssociations() On default, servlets are not associated with any function.
protected Cloud	getClassCloud() Obtains a cloud using 'class' security.
protected String	getContentDisposition(BridgeServlet.QueryParts query, Node node, String def)
protected String	getFileName(Node node, Node titleNode, String def)
protected String	getMimeType(Node node) Forces download in browsers.
protected long	getSize(NodeManager manager, Node node)
void	init() Takes care of the 'expire' init-parameter.
static void	main(String[] argv)
protected void	sendBytes(javax.servlet.http.HttpServletResponse res, byte[] bytes) Deprecated.
protected void	sendBytes(javax.servlet.http.HttpServletResponse res, InputStream bytes)
protected boolean	setCacheControl(javax.servlet.http.HttpServletResponse res, Node node) Sets cache-controlling headers.
protected boolean	setContent(BridgeServlet.QueryParts query, Node node, String mimeType) Sets the content disposition header.
protected boolean	setExpires(javax.servlet.http.HttpServletResponse res, Node node) Sets the exires header.

Methods inherited from class org.mmbase.servlet.BridgeServlet

desperatelyGetNode, findCloud, getAnonymousCloud, getCloud, getCloudName, getLastModified, getNode, getServedNode, readQuery, readQuery, readQueryFromRequestURI, readServletPath

Methods inherited from class org.mmbase.servlet.MMBaseServlet

associateMapping, checkInited, decRefCount, destroy, getBasePath, getMMBase, getRequestURL, getServletByAssociation, getServletByMapping, getServletInfo, getServletMappings, getServletMappingsByAssociation, incRefCount, service, setInitException, setMMBase

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPost, doPut, doTrace, service

Methods inherited from class javax.servlet.GenericServlet

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

Methods inherited from class java.lang.Object

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

Field Detail

legalizeFileName

protected static final Pattern legalizeFileName

Constructor Detail

HandleServlet

public HandleServlet()

Method Detail

getAssociations

protected Map<String,Integer> getAssociations()

Description copied from class: MMBaseServlet

On default, servlets are not associated with any function. This function is called in the init method.

Overrides:

getAssociations in class MMBaseServlet

Returns:

A map of Strings (function) -> Integer (priority). Never null.

init

public void init()
          throws javax.servlet.ServletException

Takes care of the 'expire' init-parameter. Inits lastmodifiedField. The init of an MMBaseServlet checks if MMBase is running. It not then it is started.

Overrides:

init in class BridgeServlet

Throws:

javax.servlet.ServletException

getClassCloud

protected Cloud getClassCloud()

Description copied from class: BridgeServlet

Obtains a cloud using 'class' security. If e.g. you authorize org.mmbase.servlet.ImageServlet by class-security for read all rights, it will be used.

Overrides:

getClassCloud in class BridgeServlet

getMimeType

protected String getMimeType(Node node)

Forces download in browsers. This is overriden in several extensions.

getFileName

protected String getFileName(Node node,
                             Node titleNode,
                             String def)

Since:

MMBase-1.8

getContentDisposition

protected String getContentDisposition(BridgeServlet.QueryParts query,
                                       Node node,
                                       String def)

Since:

MMBase-1.9

setContent

protected boolean setContent(BridgeServlet.QueryParts query,
                             Node node,
                             String mimeType)
                      throws IOException

Sets the content disposition header.

Returns:

true on success

Throws:

IOException

setExpires

protected boolean setExpires(javax.servlet.http.HttpServletResponse res,
                             Node node)

Sets the exires header.

Returns:

true on sucess

setCacheControl

protected boolean setCacheControl(javax.servlet.http.HttpServletResponse res,
                                  Node node)

Sets cache-controlling headers. Only nodes which are to be served to 'anonymous' might be (front proxy) cached. To other nodes there might be read restrictions, so they should not be stored in front-proxy caches.

Returns:

true if cacheing is disabled.

Since:

MMBase-1.7

getSize

protected long getSize(NodeManager manager,
                       Node node)

doGet

public void doGet(javax.servlet.http.HttpServletRequest req,
                  javax.servlet.http.HttpServletResponse res)
           throws javax.servlet.ServletException,
                  IOException

Serves a node with a byte[] handle field as an attachment.

Overrides:

doGet in class MMBaseServlet

Throws:

javax.servlet.ServletException

IOException

sendBytes

protected final void sendBytes(javax.servlet.http.HttpServletResponse res,
                               byte[] bytes)
                        throws IOException

Deprecated.

Utility function to send bytes at the end of doGet implementation.

Throws:

IOException

sendBytes

protected final void sendBytes(javax.servlet.http.HttpServletResponse res,
                               InputStream bytes)
                        throws IOException

Throws:

IOException

main

public static void main(String[] argv)