MockHttpServletRequest.java

/*
 * GovWay - A customizable API Gateway 
 * https://govway.org
 * 
 * Copyright (c) 2005-2025 Link.it srl (https://link.it). 
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 3, as published by
 * the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
package org.openspcoop2.protocol.modipa.utils;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.UnsupportedEncodingException;
import java.nio.charset.StandardCharsets;
import java.security.Principal;
import java.util.Collection;
import java.util.Collections;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.stream.Collectors;

import javax.servlet.AsyncContext;
import javax.servlet.DispatcherType;
import javax.servlet.RequestDispatcher;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.ServletInputStream;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import javax.servlet.http.HttpUpgradeHandler;
import javax.servlet.http.Part;

/**
 * Classe per simulare una richiesta servlet http in cui si possono sovrascrivere
 * vari elementi
 * 
 * @author Tommaso Burlon (tommaso.burlon@link.it)
 * @author $Author$
 * @version $Rev$, $Date$
 */
public class MockHttpServletRequest implements HttpServletRequest {

    private AsyncContext asyncContext = null;
    private Map<String, Object> attributes = null;
    private Map<String, List<String>> headers = null;
    private String characterEncoding = null;
    private DispatcherType dispatcherType = null;
    private HttpServletRequest req = null;
    private MockServletInputStream is = null;
    
    public MockHttpServletRequest() {
    }
    
    public MockHttpServletRequest(HttpServletRequest req) {
        this.req = req;
    }
    
    @Override
    public AsyncContext getAsyncContext() {
        if (this.asyncContext != null)
            return this.asyncContext;
        return this.req.getAsyncContext();
    }
    public void setAsyncContext(AsyncContext asyncContext) {
        this.asyncContext = asyncContext;
    }

    @Override
    public Object getAttribute(String arg0) {
        if (this.attributes != null)
            return this.attributes.get(arg0);
        return this.req.getAttribute(arg0);
    }
    @Override
    public Enumeration<String> getAttributeNames() {
        if (this.attributes != null)
            return Collections.enumeration(this.attributes.keySet());
        return this.req.getAttributeNames();
    }
    public void setAttributes(Map<String, Object> attributes) {
        this.attributes = attributes;
    }

    @Override
    public String getCharacterEncoding() {
        if (this.characterEncoding != null)
            return this.characterEncoding;
        return this.req.getCharacterEncoding();
    }
    public void setWrappedCharacterEncoding(String enc) {
        this.characterEncoding = enc;
    }

    @Override
    public int getContentLength() {
        return this.getIntHeader("Content-Length");
    }

    @Override
    public long getContentLengthLong() {
        return this.getIntHeader("Content-Length");
    }

    @Override
    public String getContentType() {
        return this.getHeader("Content-Type");
    }

    @Override
    public DispatcherType getDispatcherType() {
        if (this.dispatcherType != null)
            return this.dispatcherType;
        return this.req.getDispatcherType();
    }
    public void setDispatcherType(DispatcherType dispatcherType) {
        this.dispatcherType = dispatcherType;
    }

    @Override
    public ServletInputStream getInputStream() throws IOException {
        if (this.is != null)
            return this.is;
        return this.req.getInputStream();
    }

    @Override
    public String getLocalAddr() {
        return this.req.getLocalAddr();
    }

    @Override
    public String getLocalName() {
        return this.req.getLocalName();
    }

    @Override
    public int getLocalPort() {
        return this.req.getLocalPort();
    }

    @Override
    public Locale getLocale() {
        return this.req.getLocale();
    }

    @Override
    public Enumeration<Locale> getLocales() {
        return this.req.getLocales();
    }

    @Override
    public String getParameter(String arg0) {
        return this.req.getParameter(arg0);
    }

    @Override
    public Map<String, String[]> getParameterMap() {
        return this.req.getParameterMap();
    }

    @Override
    public Enumeration<String> getParameterNames() {
        return this.req.getParameterNames();
    }

    @Override
    public String[] getParameterValues(String arg0) {
        return this.req.getParameterValues(arg0);
    }

    @Override
    public String getProtocol() {
        return this.req.getProtocol();
    }

    @Override
    public BufferedReader getReader() throws IOException {
        if (this.is != null)
            return new BufferedReader(new InputStreamReader(this.is, StandardCharsets.UTF_8));
        return this.req.getReader();
    }

    /**
     * @deprecated
     */
    @SuppressWarnings("deprecation")
    @Deprecated(since="3.3")
    @Override
    public String getRealPath(String arg0) {
        return this.req.getRealPath(arg0);
    }

    @Override
    public String getRemoteAddr() {
        return this.req.getRemoteAddr();
    }

    @Override
    public String getRemoteHost() {
        return this.req.getRemoteHost();
    }

    @Override
    public int getRemotePort() {
        return this.req.getRemotePort();
    }

    @Override
    public RequestDispatcher getRequestDispatcher(String arg0) {
        return this.req.getRequestDispatcher(arg0);
    }

    @Override
    public String getScheme() {
        return this.req.getScheme();
    }

    @Override
    public String getServerName() {
        return this.req.getServerName();
    }

    @Override
    public int getServerPort() {
        return this.req.getServerPort();
    }

    @Override
    public ServletContext getServletContext() {
        return this.req.getServletContext();
    }

    @Override
    public boolean isAsyncStarted() {
        return this.req.isAsyncStarted();
    }

    @Override
    public boolean isAsyncSupported() {
        return this.req.isAsyncSupported();
    }

    @Override
    public boolean isSecure() {
        return this.req.isSecure();
    }

    @Override
    public void removeAttribute(String arg0) {
        this.req.removeAttribute(arg0);
    }

    @Override
    public void setAttribute(String arg0, Object arg1) {
        this.req.setAttribute(arg0, arg1);

    }

    @Override
    public void setCharacterEncoding(String arg0) throws UnsupportedEncodingException {
        this.req.setCharacterEncoding(arg0);
    }

    @Override
    public AsyncContext startAsync() throws IllegalStateException {
        return this.req.startAsync();
    }

    @Override
    public AsyncContext startAsync(ServletRequest arg0, ServletResponse arg1) throws IllegalStateException {
        return this.req.startAsync(arg0, arg1);
    }

    @Override
    public boolean authenticate(HttpServletResponse arg0) throws IOException, ServletException {
        return this.req.authenticate(arg0);
    }

    @Override
    public String changeSessionId() {
        return this.req.changeSessionId();
    }

    @Override
    public String getAuthType() {
        return this.req.getAuthType();
    }

    @Override
    public String getContextPath() {
        return this.req.getContextPath();
    }

    @Override
    public Cookie[] getCookies() {
        return this.req.getCookies();
    }

    @Override
    public long getDateHeader(String arg0) {
        return Long.valueOf(this.getHeader(arg0));
    }

    private String preProcessHeaderName(String name) {
        if (name != null) {
            return name.toLowerCase();
        }
        return name;
    }
    
    @Override
    public String getHeader(String arg0) {
        arg0 = preProcessHeaderName(arg0);
        if (this.headers != null && this.headers.containsKey(arg0)) {
            List<String> v = this.headers.get(arg0);
            if(v!=null && !v.isEmpty()) {
                return String.join(",", this.headers.get(arg0));
            }
        }
        return this.req.getHeader(arg0);
    }

    @Override
    public Enumeration<String> getHeaderNames() {
        Set<String> names = new HashSet<>();
        if (this.headers != null)
            names.addAll(this.headers.keySet());
        if (this.req != null)
            this.req.getHeaderNames().asIterator().forEachRemaining(name ->
                names.add(preProcessHeaderName(name))
            );
        return Collections.enumeration(names);
    }

    @Override
    public Enumeration<String> getHeaders(String arg0) {
        arg0 = preProcessHeaderName(arg0);
        Set<String> values = new HashSet<>();
        if (this.headers != null)
            values.addAll(Objects.requireNonNullElse(this.headers.getOrDefault(arg0, List.of()), List.of()));
        if (this.req != null && values.isEmpty())
            this.req.getHeaders(arg0).asIterator().forEachRemaining(values::add);
        return Collections.enumeration(values.stream().filter(o -> o != null).collect(Collectors.toList()));
    }

    @Override
    public int getIntHeader(String arg0) {
        return Integer.valueOf(this.getHeader(arg0));
    }

    @Override
    public String getMethod() {
        return this.req.getMethod();
    }

    @Override
    public Part getPart(String arg0) throws IOException, ServletException {
        return this.req.getPart(arg0);
    }

    @Override
    public Collection<Part> getParts() throws IOException, ServletException {
        return this.req.getParts();
    }

    @Override
    public String getPathInfo() {
        return this.req.getPathInfo();
    }

    @Override
    public String getPathTranslated() {
        return this.req.getPathTranslated();
    }

    @Override
    public String getQueryString() {
        return this.req.getQueryString();
    }

    @Override
    public String getRemoteUser() {
        return this.req.getRemoteUser();
    }

    @Override
    public String getRequestURI() {
        return this.req.getRequestURI();
    }

    @Override
    public StringBuffer getRequestURL() {
        return this.req.getRequestURL();
    }

    @Override
    public String getRequestedSessionId() {
        return null;
    }

    @Override
    public String getServletPath() {
        return this.req.getServletPath();
    }

    @Override
    public HttpSession getSession() {
        return this.req.getSession();
    }

    @Override
    public HttpSession getSession(boolean arg0) {
        return this.req.getSession(arg0);
    }

    @Override
    public Principal getUserPrincipal() {
        return this.req.getUserPrincipal();
    }

    @Override
    public boolean isRequestedSessionIdFromCookie() {
        return this.req.isRequestedSessionIdFromCookie();
    }

    @Override
    public boolean isRequestedSessionIdFromURL() {
        return this.req.isRequestedSessionIdFromURL();
    }

    /**
     * @deprecated
     */
    @SuppressWarnings("deprecation")
    @Deprecated(since="3.3")
    @Override
    public boolean isRequestedSessionIdFromUrl() {
        return this.req.isRequestedSessionIdFromUrl();
    }

    @Override
    public boolean isRequestedSessionIdValid() {
        return this.req.isRequestedSessionIdValid();
    }

    @Override
    public boolean isUserInRole(String arg0) {
        return this.req.isUserInRole(arg0);
    }

    @Override
    public void login(String arg0, String arg1) throws ServletException {
        this.req.login(arg0, arg1);
    }

    @Override
    public void logout() throws ServletException {
        this.req.logout();
    }

    @Override
    public <T extends HttpUpgradeHandler> T upgrade(Class<T> arg0) throws IOException, ServletException {
        return this.req.upgrade(arg0);
    }

    public void setHeaders(Map<String, List<String>> headers) {
        this.headers = new HashMap<>();
        for (Map.Entry<String, List<String>> entry : headers.entrySet())
            this.headers.put(preProcessHeaderName(entry.getKey()), entry.getValue());
    }
    
    public void setHeader(String name, List<String> value) {
        name = preProcessHeaderName(name);
        if (this.headers == null)
            this.headers = new HashMap<>();
        this.headers.put(name, value);
    }
    
    public void setInputStream(MockServletInputStream is) {
        this.is = is;
    }

}