RedirectionResponseWrapper.java

  1. /*
  2.  * Copyright (c) 2002-2022, City of Paris
  3.  * All rights reserved.
  4.  *
  5.  * Redistribution and use in source and binary forms, with or without
  6.  * modification, are permitted provided that the following conditions
  7.  * are met:
  8.  *
  9.  *  1. Redistributions of source code must retain the above copyright notice
  10.  *     and the following disclaimer.
  11.  *
  12.  *  2. Redistributions in binary form must reproduce the above copyright notice
  13.  *     and the following disclaimer in the documentation and/or other materials
  14.  *     provided with the distribution.
  15.  *
  16.  *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
  17.  *     contributors may be used to endorse or promote products derived from
  18.  *     this software without specific prior written permission.
  19.  *
  20.  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  21.  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22.  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23.  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
  24.  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25.  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26.  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27.  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28.  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29.  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  30.  * POSSIBILITY OF SUCH DAMAGE.
  31.  *
  32.  * License 1.0
  33.  */
  34. package fr.paris.lutece.portal.service.page;

  35. import java.io.IOException;

  36. import javax.servlet.http.HttpServletResponse;
  37. import javax.servlet.http.HttpServletResponseWrapper;

  38. /**
  39.  * HttpServletResponseWrapper useful for redirections interception
  40.  *
  41.  * @see javax.servlet.http.HttpServletResponseWrapper
  42.  */
  43. public final class RedirectionResponseWrapper extends HttpServletResponseWrapper
  44. {
  45.     private String _redirectLocation;

  46.     /**
  47.      * Constructor for class RedirectionResponseWrapper
  48.      *
  49.      * @param response
  50.      *            The HTTP servlet response
  51.      */
  52.     public RedirectionResponseWrapper( HttpServletResponse response )
  53.     {
  54.         super( response );
  55.     }

  56.     /**
  57.      * @see javax.servlet.http.HttpServletResponseWrapper#sendRedirect(java.lang.String)
  58.      * @param location
  59.      *            The redirection location
  60.      * @throws IOException
  61.      *             the exception
  62.      */
  63.     @Override
  64.     public void sendRedirect( String location ) throws IOException
  65.     {
  66.         _redirectLocation = location;
  67.         super.sendRedirect( location );
  68.     }

  69.     /**
  70.      * Return redirection location intercepted
  71.      *
  72.      * @return redirection location intercepted
  73.      */
  74.     public String getRedirectLocation( )
  75.     {
  76.         return _redirectLocation;
  77.     }
  78. }