web-dev-qa-db-fra.com

Ajout d'un en-tête HTTP à la demande dans un filtre de servlet

J'intègre un servlet existant qui extrait certaines propriétés de l'en-tête HTTP. Fondamentalement, j'implémente une interface qui n'a pas accès à la demande réelle, elle a juste accès à une carte de k-> v pour les en-têtes HTTP.

J'ai besoin de passer un paramètre de demande. Le plan consiste à utiliser un filtre de servlet pour passer du paramètre à la valeur d'en-tête, mais bien sûr, l'objet HttpServletRequest n'a pas de méthode addHeader ().

Des idées?

javaservletsjava-eeservlet-filters
37
Mason

Étendez HttpServletRequestWrapper , remplacez les getters d'en-tête pour retourner également les paramètres:

public class AddParamsToHeader extends HttpServletRequestWrapper {
    public AddParamsToHeader(HttpServletRequest request) {
        super(request);
    }

    public String getHeader(String name) {
        String header = super.getHeader(name);
        return (header != null) ? header : super.getParameter(name); // Note: you can't use getParameterValues() here.
    }

    public Enumeration getHeaderNames() {
        List<String> names = Collections.list(super.getHeaderNames());
        names.addAll(Collections.list(super.getParameterNames()));
        return Collections.enumeration(names);
    }
}

..et envelopper la demande d'origine avec:

chain.doFilter(new AddParamsToHeader((HttpServletRequest) request), response);

Cela dit, je trouve personnellement que c'est une mauvaise idée. Donnez-lui plutôt un accès direct aux paramètres ou passez-lui les paramètres.

39
BalusC

comme https://stackoverflow.com/users/89391/mik a souligné que ce serait un exemple complet de ServletFilter qui utilise le code qui fonctionne également pour Jersey pour ajouter l'en-tête remote_addr.

package com.bitplan.smartCRM.web;

import Java.io.IOException;
import Java.util.Collections;
import Java.util.Enumeration;
import Java.util.HashMap;
import Java.util.List;
import Java.util.Map;

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletRequestWrapper;

/**
 * 
 * @author wf
 * 
 */
public class RemoteAddrFilter implements Filter {

    @Override
    public void destroy() {

    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response,
            FilterChain chain) throws IOException, ServletException {
        HttpServletRequest req = (HttpServletRequest) request;
        HeaderMapRequestWrapper requestWrapper = new HeaderMapRequestWrapper(req);
        String remote_addr = request.getRemoteAddr();
        requestWrapper.addHeader("remote_addr", remote_addr);
        chain.doFilter(requestWrapper, response); // Goes to default servlet.
    }

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

    }

    // https://stackoverflow.com/questions/2811769/adding-an-http-header-to-the-request-in-a-servlet-filter
    // http://sandeepmore.com/blog/2010/06/12/modifying-http-headers-using-Java/
    // http://bijubnair.blogspot.de/2008/12/adding-header-information-to-existing.html
    /**
     * allow adding additional header entries to a request
     * 
     * @author wf
     * 
     */
    public class HeaderMapRequestWrapper extends HttpServletRequestWrapper {
        /**
         * construct a wrapper for this request
         * 
         * @param request
         */
        public HeaderMapRequestWrapper(HttpServletRequest request) {
            super(request);
        }

        private Map<String, String> headerMap = new HashMap<String, String>();

        /**
         * add a header with given name and value
         * 
         * @param name
         * @param value
         */
        public void addHeader(String name, String value) {
            headerMap.put(name, value);
        }

        @Override
        public String getHeader(String name) {
            String headerValue = super.getHeader(name);
            if (headerMap.containsKey(name)) {
                headerValue = headerMap.get(name);
            }
            return headerValue;
        }

        /**
         * get the Header names
         */
        @Override
        public Enumeration<String> getHeaderNames() {
            List<String> names = Collections.list(super.getHeaderNames());
            for (String name : headerMap.keySet()) {
                names.add(name);
            }
            return Collections.enumeration(names);
        }

        @Override
        public Enumeration<String> getHeaders(String name) {
            List<String> values = Collections.list(super.getHeaders(name));
            if (headerMap.containsKey(name)) {
                values.add(headerMap.get(name));
            }
            return Collections.enumeration(values);
        }

    }

}

extrait web.xml:

<!--  first filter adds remote addr header -->
<filter>
    <filter-name>remoteAddrfilter</filter-name>
    <filter-class>com.bitplan.smartCRM.web.RemoteAddrFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>remoteAddrfilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>
19
Wolfgang Fahl

Vous devrez utiliser un HttpServletRequestWrapper :

public void doFilter(final ServletRequest request, final ServletResponse response, final FilterChain chain) throws IOException, ServletException {
    final HttpServletRequest httpRequest = (HttpServletRequest) request;
    HttpServletRequestWrapper wrapper = new HttpServletRequestWrapper(httpRequest) {
        @Override
        public String getHeader(String name) {
            final String value = request.getParameter(name);
            if (value != null) {
                return value;
            }
            return super.getHeader(name);
        }
    };
    chain.doFilter(wrapper, response);
}

Selon ce que vous voulez faire, vous devrez peut-être implémenter d'autres méthodes de l'encapsuleur comme getHeaderNames par exemple. Sachez simplement que cela fait confiance au client et lui permet de manipuler n'importe quel en-tête HTTP. Vous pouvez le mettre en sandbox et autoriser uniquement certaines valeurs d'en-tête à être modifiées de cette façon.

15
laz