Coverage Report - com.mattunderscore.filter.GenericHTTPFilter
 
Classes in this File Line Coverage Branch Coverage Complexity
GenericHTTPFilter
100%
10/10
100%
4/4
3
 
 1  
 /* Copyright © 2012 Matthew Champion
 2  
 All rights reserved.
 3  
 
 4  
 Redistribution and use in source and binary forms, with or without
 5  
 modification, are permitted provided that the following conditions are met:
 6  
  * Redistributions of source code must retain the above copyright
 7  
       notice, this list of conditions and the following disclaimer.
 8  
  * Redistributions in binary form must reproduce the above copyright
 9  
       notice, this list of conditions and the following disclaimer in the
 10  
       documentation and/or other materials provided with the distribution.
 11  
  * Neither the name of mattunderscore.com nor the
 12  
       names of its contributors may be used to endorse or promote products
 13  
       derived from this software without specific prior written permission.
 14  
 
 15  
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 16  
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 17  
 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 18  
 DISCLAIMED. IN NO EVENT SHALL MATTHEW CHAMPION BE LIABLE FOR ANY
 19  
 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 20  
 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 21  
 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 22  
 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 23  
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 24  
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
 25  
 
 26  
 package com.mattunderscore.filter;
 27  
 
 28  
 import java.io.IOException;
 29  
 import javax.servlet.FilterChain;
 30  
 import javax.servlet.ServletException;
 31  
 import javax.servlet.ServletRequest;
 32  
 import javax.servlet.ServletResponse;
 33  
 import javax.servlet.http.HttpServletResponse;
 34  
 import javax.servlet.http.HttpServletRequest;
 35  
 
 36  
 /**
 37  
  * A HTTP filter that provides boiler plate for casting {@link ServletRequest} to
 38  
  * {@link HttpServletRequest} etc. If the request or response cannot be cast to the correct
 39  
  * classes a servlet exception will be thrown. Provides a
 40  
  * {@link #doHTTPFilter(HttpServletRequest,HttpServletResponse,FilterChain)} method that
 41  
  * is intended to be implemented to provide the behaviour of the filter.
 42  
  * 
 43  
  * @author Matt Champion
 44  
  * @since 0.0.13
 45  
  */
 46  8
 public abstract class GenericHTTPFilter extends GenericFilter
 47  
 {
 48  
 
 49  
     @Override
 50  
     public final void doFilter(final ServletRequest request, final ServletResponse response,
 51  
             final FilterChain chain) throws IOException, ServletException
 52  
     {
 53  8
         if (response instanceof HttpServletResponse)
 54  
         {
 55  4
             if (request instanceof HttpServletRequest)
 56  
             {
 57  2
                 final HttpServletResponse resp = (HttpServletResponse) response;
 58  2
                 final HttpServletRequest req = (HttpServletRequest) request;
 59  2
                 doHTTPFilter(req, resp, chain);
 60  2
             }
 61  
             else
 62  
             {
 63  2
                 throw new ServletException("HTTP Filter was passed a "
 64  
                         + "non-HttpServletRequest object");
 65  
             }
 66  
         }
 67  
         else
 68  
         {
 69  4
             throw new ServletException("HTTP Filter was passed a non-HttpServletResponse object");
 70  
         }
 71  2
     }
 72  
 
 73  
     /**
 74  
      * A method that executes the filter behaviour for HTTP requests and responses.
 75  
      * 
 76  
      * @param request
 77  
      *            The HTTP request
 78  
      * @param response
 79  
      *            The HTTP response
 80  
      * @param chain
 81  
      *            The filter chain
 82  
      * @throws IOException
 83  
      * @throws ServletException
 84  
      * @since 0.0.13
 85  
      */
 86  
     public abstract void doHTTPFilter(HttpServletRequest request, HttpServletResponse response,
 87  
             FilterChain chain) throws IOException, ServletException;
 88  
 }