org.glassfish.soteria.servlet.HttpServletRequestDelegator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jakarta.security.enterprise Show documentation
Compatible Implementation for Jakarta Security API
There is a newer version: 3.0.3
Show newest version
/*
 * Copyright (c) 2015, 2020 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package org.glassfish.soteria.servlet;

import static java.lang.Integer.parseInt;
import static java.util.Collections.enumeration;
import static java.util.Locale.US;
import static java.util.TimeZone.getTimeZone;
import static org.glassfish.soteria.Utils.isEmpty;

import java.text.DateFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.TimeZone;

import jakarta.servlet.http.Cookie;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletRequestWrapper;


/**
 * This class wraps a given HttpServletRequest instance and delegates "most" methods that request
 * "base data" to an also given RequestData instance.
 * 
 * @author Arjan Tijms
 *
 */
public class HttpServletRequestDelegator extends HttpServletRequestWrapper {
    
    private static final TimeZone GMT = getTimeZone("GMT");
    private static final String[] datePatterns = {
        "EE, dd MMM yyyy HH:mm:ss zz",
        "EEEE, dd-MMM-yy HH:mm:ss zz",
        "EE MMM  d HH:mm:ss yyyy"
    };
    
    private final RequestData requestData;
    private List dateFormats;
    
    public HttpServletRequestDelegator(HttpServletRequest request, RequestData requestData) {
        super(request);
        this.requestData = requestData;
        
    }

    @Override
    public Cookie[] getCookies() {
        return requestData.getCookies();
    }
    
    
    // ### Headers
    
    @Override
    public Enumeration getHeaderNames() {
        return enumeration(requestData.getHeaders().keySet());
    }
    
    @Override
    public String getHeader(String name) {
        
        // Return the first matching header that has the same (case insensitive) name
        for (Map.Entry> header : requestData.getHeaders().entrySet()) {
            if (header.getKey().equalsIgnoreCase(name) && !header.getValue().isEmpty()) {
                return header.getValue().get(0);
            }
        }
        
        return null;
    }
    
    @Override
    public Enumeration getHeaders(String name) {
        
        // Collect headers irrespective of the case that was used for the actual header
        // when submitted and the case of the name asked here.
        List headers = new ArrayList<>();
        for (Map.Entry> header : requestData.getHeaders().entrySet()) {
            if (header.getKey().equalsIgnoreCase(name)) {
                headers.addAll(header.getValue());
            }
        }
        
        return enumeration(headers);
    }
    
    @Override
    public int getIntHeader(String name) {
        String header = getHeader(name);
        
        if (header == null) {
            // Spec defines we should return -1 is header doesn't exist
            return -1;
        }
        
        // If header ain't an integer, spec says a NumberFormatException should be thrown,
        // which is what Integer.parseInt will do.
        return parseInt(header);
    }
    
    @Override
    public long getDateHeader(String name) {
        String header = getHeader(name);
        
        if (header == null) {
            // Spec defines we should return -1 if header doesn't exist
            return -1;
        }
        
        if (dateFormats == null) {
            dateFormats = new ArrayList<>(datePatterns.length);
            for (String datePattern : datePatterns) {
                dateFormats.add(createDateFormat(datePattern));
            }
        }
        
        for (DateFormat dateFormat : dateFormats) {
            try {
                return dateFormat.parse(header).getTime();
            } catch (ParseException e) {
                // noop
            }
        }
        
        // If no conversion is possible, spec says an IllegalArgumentException should be thrown
        throw new IllegalArgumentException("Can't convert " + header + " to a date");
    }
    
    
    
    // ### Parameters
    
    @Override
    public Map getParameterMap() {
        return requestData.getParameters();
    }
    
    @Override
    public String getParameter(String name) {
        
        String[] values = requestData.getParameters().get(name);
        if (isEmpty(values)) {
            return null;
        }
        
        return values[0];
    }
    
    @Override
    public Enumeration getParameterNames() {
        return enumeration(getParameterMap().keySet());
    }
    
    @Override
    public String[] getParameterValues(String name) {
        return getParameterMap().get(name);
    }
    
    
    // ### Locales
    
    @Override
    public Enumeration getLocales() {
        return enumeration(requestData.getLocales());
    }
    
    @Override
    public Locale getLocale() {
        
        if (requestData.getLocales().isEmpty()) {
            // Is this possible? Doesn't the original HttpServletRequest#getLocales
            // already returns the default here?
            return Locale.getDefault();
        }
        
        return requestData.getLocales().get(0);
    }
    
    @Override
    public String getMethod() {
        return requestData.getMethod();
    }
    
    
    private DateFormat createDateFormat(String pattern) {
        DateFormat dateFormat = new SimpleDateFormat(pattern, US);
        dateFormat.setTimeZone(GMT);
        return dateFormat;
    }

}