All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.catalina.core.ApplicationRequest Maven / Gradle / Ivy

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.catalina.core;


import java.util.Collections;
import java.util.Enumeration;
import java.util.HashMap;

import javax.servlet.RequestDispatcher;
import javax.servlet.ServletRequest;
import javax.servlet.ServletRequestWrapper;


/**
 * Wrapper around a javax.servlet.ServletRequest
 * that transforms an application request object (which might be the original
 * one passed to a servlet, or might be based on the 2.3
 * javax.servlet.ServletRequestWrapper class)
 * back into an internal org.apache.catalina.Request.
 * 

* WARNING: Due to Java's lack of support for multiple * inheritance, all of the logic in ApplicationRequest is * duplicated in ApplicationHttpRequest. Make sure that you * keep these two classes in synchronization when making changes! * * @author Craig R. McClanahan */ class ApplicationRequest extends ServletRequestWrapper { // ------------------------------------------------------- Static Variables /** * The set of attribute names that are special for request dispatchers. */ protected static final String specials[] = { RequestDispatcher.INCLUDE_REQUEST_URI, RequestDispatcher.INCLUDE_CONTEXT_PATH, RequestDispatcher.INCLUDE_SERVLET_PATH, RequestDispatcher.INCLUDE_PATH_INFO, RequestDispatcher.INCLUDE_QUERY_STRING, RequestDispatcher.INCLUDE_MAPPING, RequestDispatcher.FORWARD_REQUEST_URI, RequestDispatcher.FORWARD_CONTEXT_PATH, RequestDispatcher.FORWARD_SERVLET_PATH, RequestDispatcher.FORWARD_PATH_INFO, RequestDispatcher.FORWARD_QUERY_STRING, RequestDispatcher.FORWARD_MAPPING}; // ----------------------------------------------------------- Constructors /** * Construct a new wrapped request around the specified servlet request. * * @param request The servlet request being wrapped */ public ApplicationRequest(ServletRequest request) { super(request); setRequest(request); } // ----------------------------------------------------- Instance Variables /** * The request attributes for this request. This is initialized from the * wrapped request, but updates are allowed. */ protected final HashMap attributes = new HashMap<>(); // ------------------------------------------------- ServletRequest Methods /** * Override the getAttribute() method of the wrapped request. * * @param name Name of the attribute to retrieve */ @Override public Object getAttribute(String name) { synchronized (attributes) { return attributes.get(name); } } /** * Override the getAttributeNames() method of the wrapped * request. */ @Override public Enumeration getAttributeNames() { synchronized (attributes) { return Collections.enumeration(attributes.keySet()); } } /** * Override the removeAttribute() method of the * wrapped request. * * @param name Name of the attribute to remove */ @Override public void removeAttribute(String name) { synchronized (attributes) { attributes.remove(name); if (!isSpecial(name)) { getRequest().removeAttribute(name); } } } /** * Override the setAttribute() method of the * wrapped request. * * @param name Name of the attribute to set * @param value Value of the attribute to set */ @Override public void setAttribute(String name, Object value) { synchronized (attributes) { attributes.put(name, value); if (!isSpecial(name)) { getRequest().setAttribute(name, value); } } } // ------------------------------------------ ServletRequestWrapper Methods /** * Set the request that we are wrapping. * * @param request The new wrapped request */ @Override public void setRequest(ServletRequest request) { super.setRequest(request); // Initialize the attributes for this request synchronized (attributes) { attributes.clear(); Enumeration names = request.getAttributeNames(); while (names.hasMoreElements()) { String name = names.nextElement(); Object value = request.getAttribute(name); attributes.put(name, value); } } } // ------------------------------------------------------ Protected Methods /** * Is this attribute name one of the special ones that is added only for * included servlets? * * @param name Attribute name to be tested */ protected boolean isSpecial(String name) { for (String special : specials) { if (special.equals(name)) { return true; } } return false; } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy