org.mortbay.servlet
Class PutFilter

java.lang.Object
  extended by org.mortbay.servlet.PutFilter
All Implemented Interfaces:
Filter

public class PutFilter
extends java.lang.Object
implements Filter

PutFilter A Filter that handles PUT, DELETE and MOVE methods. Files are hidden during PUT operations, so that 404's result. The following init paramters pay be used:


Field Summary
static java.lang.String __DELETE
           
static java.lang.String __MOVE
           
static java.lang.String __OPTIONS
           
static java.lang.String __PUT
           
protected  java.lang.String _baseURI
           
protected  ServletContext _context
           
protected  boolean _delAllowed
           
protected  java.util.concurrent.ConcurrentMap _hidden
           
 
Constructor Summary
PutFilter()
           
 
Method Summary
 void destroy()
          Called by the web container to indicate to a filter that it is being taken out of service.
 void doFilter(ServletRequest req, ServletResponse res, FilterChain chain)
          The doFilter method of the Filter is called by the container each time a request/response pair is passed through the chain due to a client request for a resource at the end of the chain.
 void handleDelete(HttpServletRequest request, HttpServletResponse response, java.lang.String pathInContext, java.io.File file)
           
 void handleMove(HttpServletRequest request, HttpServletResponse response, java.lang.String pathInContext, java.io.File file)
           
 void handleOptions(HttpServletRequest request, HttpServletResponse response)
           
 void handlePut(HttpServletRequest request, HttpServletResponse response, java.lang.String pathInContext, java.io.File file)
           
 void init(FilterConfig config)
          Called by the web container to indicate to a filter that it is being placed into service.
protected  boolean passConditionalHeaders(HttpServletRequest request, HttpServletResponse response, java.io.File file)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

__PUT

public static final java.lang.String __PUT
See Also:
Constant Field Values

__DELETE

public static final java.lang.String __DELETE
See Also:
Constant Field Values

__MOVE

public static final java.lang.String __MOVE
See Also:
Constant Field Values

__OPTIONS

public static final java.lang.String __OPTIONS
See Also:
Constant Field Values

_hidden

protected java.util.concurrent.ConcurrentMap _hidden

_context

protected ServletContext _context

_baseURI

protected java.lang.String _baseURI

_delAllowed

protected boolean _delAllowed
Constructor Detail

PutFilter

public PutFilter()
Method Detail

init

public void init(FilterConfig config)
          throws ServletException
Description copied from interface: Filter
Called by the web container to indicate to a filter that it is being placed into service. The servlet container calls the init method exactly once after instantiating the filter. The init method must complete successfully before the filter is asked to do any filtering work.

The web container cannot place the filter into service if the init method either
1.Throws a ServletException
2.Does not return within a time period defined by the web container

Specified by:
init in interface Filter
Throws:
ServletException

doFilter

public void doFilter(ServletRequest req,
                     ServletResponse res,
                     FilterChain chain)
              throws java.io.IOException,
                     ServletException
Description copied from interface: Filter
The doFilter method of the Filter is called by the container each time a request/response pair is passed through the chain due to a client request for a resource at the end of the chain. The FilterChain passed in to this method allows the Filter to pass on the request and response to the next entity in the chain.

A typical implementation of this method would follow the following pattern:-
1. Examine the request
2. Optionally wrap the request object with a custom implementation to filter content or headers for input filtering
3. Optionally wrap the response object with a custom implementation to filter content or headers for output filtering
4. a) Either invoke the next entity in the chain using the FilterChain object (chain.doFilter()),
4. b) or not pass on the request/response pair to the next entity in the filter chain to block the request processing
5. Directly set headers on the response after invocation of the next entity in the filter chain.

Specified by:
doFilter in interface Filter
Throws:
java.io.IOException
ServletException

destroy

public void destroy()
Description copied from interface: Filter
Called by the web container to indicate to a filter that it is being taken out of service. This method is only called once all threads within the filter's doFilter method have exited or after a timeout period has passed. After the web container calls this method, it will not call the doFilter method again on this instance of the filter.

This method gives the filter an opportunity to clean up any resources that are being held (for example, memory, file handles, threads) and make sure that any persistent state is synchronized with the filter's current state in memory.

Specified by:
destroy in interface Filter

handlePut

public void handlePut(HttpServletRequest request,
                      HttpServletResponse response,
                      java.lang.String pathInContext,
                      java.io.File file)
               throws ServletException,
                      java.io.IOException
Throws:
ServletException
java.io.IOException

handleDelete

public void handleDelete(HttpServletRequest request,
                         HttpServletResponse response,
                         java.lang.String pathInContext,
                         java.io.File file)
                  throws ServletException,
                         java.io.IOException
Throws:
ServletException
java.io.IOException

handleMove

public void handleMove(HttpServletRequest request,
                       HttpServletResponse response,
                       java.lang.String pathInContext,
                       java.io.File file)
                throws ServletException,
                       java.io.IOException,
                       java.net.URISyntaxException
Throws:
ServletException
java.io.IOException
java.net.URISyntaxException

handleOptions

public void handleOptions(HttpServletRequest request,
                          HttpServletResponse response)
                   throws java.io.IOException
Throws:
java.io.IOException

passConditionalHeaders

protected boolean passConditionalHeaders(HttpServletRequest request,
                                         HttpServletResponse response,
                                         java.io.File file)
                                  throws java.io.IOException
Throws:
java.io.IOException


Copyright © 1995-2009 Mort Bay Consulting. All Rights Reserved.