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 javax.security.enterprise Show documentation
Reference Implementation for Java EE Security API
The newest version!
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2015-2017 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://oss.oracle.com/licenses/CDDL+GPL-1.1
 * or LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

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 javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import javax.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;
    }

}