LuteceFilterChain.java

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

import java.io.IOException;

import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;

/**
 * Lutece filter chain This is a fake filter chain used by LuteceMainFilter to simulate a chain for plugins filters
 */
public class LuteceFilterChain implements FilterChain
{
    private boolean _bFollowChain;
    private ServletRequest _request;
    private ServletResponse _response;

    /**
     * Initialize the follow chain flag (does the filter called "chain.doFilter")
     * 
     * @param bFollowChain
     *            The follow chain flag
     */
    public void setFollowChain( boolean bFollowChain )
    {
        _bFollowChain = bFollowChain;
    }

    /**
     * Returns the follow chain flag
     * 
     * @return The follow chain flag
     */
    public boolean shouldFollowChain( )
    {
        return _bFollowChain;
    }

    /**
     * Returns the request used by {@link #doFilter(ServletRequest, ServletResponse)}
     * 
     * @return the request
     * @since 2.5
     */
    public ServletRequest getRequest( )
    {
        return _request;
    }

    /**
     * Sets the request used by {@link #doFilter(ServletRequest, ServletResponse)}
     * 
     * @param request
     *            the request
     * @since 2.5
     */
    public void setRequest( ServletRequest request )
    {
        _request = request;
    }

    /**
     * Returns the response used by {@link #doFilter(ServletRequest, ServletResponse)}
     * 
     * @return the response
     * @since 2.5
     */
    public ServletResponse getResponse( )
    {
        return _response;
    }

    /**
     * Sets the response used by {@link #doFilter(ServletRequest, ServletResponse)}
     * 
     * @param response
     *            the response
     * @since 2.5
     */
    public void setResponse( ServletResponse response )
    {
        _response = response;
    }

    /**
     * {@inheritDoc }
     */
    public void doFilter( ServletRequest request, ServletResponse response ) throws IOException, ServletException
    {
        // Do nothing and set the follow chain flag to true
        setFollowChain( true );
        // Set request and response, eventually wrapped during filter process.
        setRequest( request );
        setResponse( response );
    }
}