com.sun.faces.context.ExternalContextImpl Maven / Gradle / Ivy
Show all versions of jsf-impl Show documentation
/*
* $Id: ExternalContextImpl.java,v 1.64.4.2 2008/03/10 16:36:37 rlubke Exp $
*/
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. 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://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/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 glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [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 com.sun.faces.context;
import javax.faces.FacesException;
import javax.faces.context.ExternalContext;
import javax.faces.context.FacesContext;
import javax.servlet.RequestDispatcher;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
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 java.io.IOException;
import java.io.InputStream;
import java.io.UnsupportedEncodingException;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.AbstractCollection;
import java.util.AbstractMap;
import java.util.AbstractSet;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.NoSuchElementException;
import java.util.Set;
import com.sun.faces.config.WebConfiguration;
import com.sun.faces.config.WebConfiguration.BooleanWebContextInitParameter;
import com.sun.faces.util.MessageUtils;
import com.sun.faces.util.TypedCollections;
import com.sun.faces.util.Util;
import com.sun.faces.util.RequestStateManager;
/**
* This implementation of {@link ExternalContext} is specific to the
* servlet implementation.
*
* @author Brendan Murray
* @version $Id: ExternalContextImpl.java,v 1.64.4.2 2008/03/10 16:36:37 rlubke Exp $
*/
public class ExternalContextImpl extends ExternalContext {
private ServletContext servletContext = null;
private ServletRequest request = null;
private ServletResponse response = null;
private Map applicationMap = null;
private Map sessionMap = null;
private Map requestMap = null;
private Map requestParameterMap = null;
private Map requestParameterValuesMap = null;
private Map requestHeaderMap = null;
private Map requestHeaderValuesMap = null;
private Map cookieMap = null;
private Map initParameterMap = null;
static final Class theUnmodifiableMapClass =
Collections.unmodifiableMap(new HashMap()).getClass();
public ExternalContextImpl(ServletContext sc, ServletRequest request,
ServletResponse response) {
// Validate the incoming parameters
try {
Util.parameterNonNull(sc);
Util.parameterNonNull(request);
Util.parameterNonNull(response);
} catch (Exception e) {
throw new FacesException(
MessageUtils.getExceptionMessageString(
MessageUtils.FACES_CONTEXT_CONSTRUCTION_ERROR_MESSAGE_ID));
}
// Save references to our context, request, and response
this.servletContext = sc;
this.request = request;
this.response = response;
WebConfiguration config = WebConfiguration.getInstance(sc);
if (config
.isOptionEnabled(BooleanWebContextInitParameter.SendPoweredByHeader)) {
((HttpServletResponse) response)
.addHeader("X-Powered-By", "JSF/1.2");
}
}
public Object getSession(boolean create) {
return (((HttpServletRequest) request).getSession(create));
}
public Object getContext() {
return this.servletContext;
}
public Object getRequest() {
return this.request;
}
public void setRequest(Object request) {
if (request instanceof ServletRequest) {
this.request = (ServletRequest) request;
requestHeaderMap = null;
requestHeaderValuesMap = null;
requestHeaderValuesMap = null;
requestMap = null;
requestParameterMap = null;
requestParameterValuesMap = null;
}
}
public void setRequestCharacterEncoding(String encoding) throws UnsupportedEncodingException {
request.setCharacterEncoding(encoding);
}
public Object getResponse() {
return this.response;
}
public void setResponse(Object response) {
if (response instanceof ServletResponse) {
this.response = (ServletResponse) response;
}
}
public void setResponseCharacterEncoding(String encoding) {
response.setCharacterEncoding(encoding);
}
@SuppressWarnings("unchecked")
public Map getApplicationMap() {
if (applicationMap == null) {
applicationMap = new ApplicationMap(servletContext);
}
return applicationMap;
}
@SuppressWarnings("unchecked")
public Map getSessionMap() {
if (sessionMap == null) {
sessionMap = new SessionMap((HttpServletRequest) request);
}
return sessionMap;
}
@SuppressWarnings("unchecked")
public Map getRequestMap() {
if (requestMap == null) {
requestMap = new RequestMap(this.request);
}
return requestMap;
}
public Map getRequestHeaderMap() {
if (null == requestHeaderMap) {
requestHeaderMap =
Collections.unmodifiableMap(
new RequestHeaderMap((HttpServletRequest) request));
}
return requestHeaderMap;
}
public Map getRequestHeaderValuesMap() {
if (null == requestHeaderValuesMap) {
requestHeaderValuesMap =
Collections.unmodifiableMap(
new RequestHeaderValuesMap((HttpServletRequest) request));
}
return requestHeaderValuesMap;
}
public Map getRequestCookieMap() {
if (null == cookieMap) {
cookieMap =
Collections.unmodifiableMap(
new RequestCookieMap((HttpServletRequest) request));
}
return cookieMap;
}
public Map getInitParameterMap() {
if (null == initParameterMap) {
initParameterMap =
Collections.unmodifiableMap(
new InitParameterMap(servletContext));
}
return initParameterMap;
}
public Map getRequestParameterMap() {
if (null == requestParameterMap) {
requestParameterMap =
Collections.unmodifiableMap(
new RequestParameterMap(request));
}
return requestParameterMap;
}
public Map getRequestParameterValuesMap() {
if (null == requestParameterValuesMap) {
requestParameterValuesMap =
Collections.unmodifiableMap(
new RequestParameterValuesMap(request));
}
return requestParameterValuesMap;
}
public Iterator getRequestParameterNames() {
final Enumeration namEnum = request.getParameterNames();
return new Iterator() {
public boolean hasNext() {
return namEnum.hasMoreElements();
}
public String next() {
return (String) namEnum.nextElement();
}
public void remove() {
throw new UnsupportedOperationException();
}
};
}
public Locale getRequestLocale() {
return request.getLocale();
}
public Iterator getRequestLocales() {
return (new LocalesIterator(request.getLocales()));
}
public String getRequestPathInfo() {
return (((HttpServletRequest) request).getPathInfo());
}
public Cookie[] getRequestCookies() {
return (((HttpServletRequest) request).getCookies());
}
public String getRequestContextPath() {
return (((HttpServletRequest) request).getContextPath());
}
public String getRequestServletPath() {
return (((HttpServletRequest) request).getServletPath());
}
public String getRequestCharacterEncoding() {
return (request.getCharacterEncoding());
}
public String getRequestContentType() {
return (request.getContentType());
}
public String getResponseCharacterEncoding() {
return (response.getCharacterEncoding());
}
public String getResponseContentType() {
return (response.getContentType());
}
/**
* Manage attributes associated with the ServletContext
* instance associated with the current request.
*/
public String getInitParameter(String name) {
return servletContext.getInitParameter(name);
}
public Set getResourcePaths(String path) {
return TypedCollections.dynamicallyCastSet(servletContext.getResourcePaths(path), String.class);
}
public InputStream getResourceAsStream(String path) {
return servletContext.getResourceAsStream(path);
}
public URL getResource(String path) {
URL url;
try {
url = servletContext.getResource(path);
} catch (MalformedURLException e) {
return null;
}
return url;
}
/**
* Force any URL that causes an action to work within a portal/portlet.
* This causes the URL to have the required redirection for the specific
* portal to be included
*
* @param sb The input URL to be reformatted
*/
public String encodeActionURL(String sb) {
return ((HttpServletResponse) response).encodeURL(sb);
}
/**
* Force any URL that references a resource to work within a
* portal/portlet. This causes the URL to have the required
* redirection for the specific portal to be included. In reality,
* it simply returns an absolute URL.
*
* @param sb The input URL to be reformatted
*/
public String encodeResourceURL(String sb) {
return ((HttpServletResponse) response).encodeURL(sb);
}
public String encodeNamespace(String aValue) {
return aValue; // Do nothing for servlets
}
public String encodeURL(String url) {
return ((HttpServletResponse) response).encodeURL(url);
}
public void dispatch(String requestURI) throws IOException, FacesException {
RequestDispatcher requestDispatcher = request.getRequestDispatcher(
requestURI);
if (requestDispatcher == null) {
((HttpServletResponse) response).
sendError(HttpServletResponse.SC_NOT_FOUND);
return;
}
try {
requestDispatcher.forward(this.request, this.response);
} catch (IOException ioe) {
// e.printStackTrace();
throw ioe;
} catch (ServletException se) {
throw new FacesException(se);
}
}
public void redirect(String requestURI) throws IOException {
((HttpServletResponse) response).sendRedirect(requestURI);
FacesContext.getCurrentInstance().responseComplete();
}
public void log(String message) {
servletContext.log(message);
}
public void log(String message, Throwable throwable) {
servletContext.log(message, throwable);
}
public String getAuthType() {
return ((HttpServletRequest) request).getAuthType();
}
public String getRemoteUser() {
return ((HttpServletRequest) request).getRemoteUser();
}
public java.security.Principal getUserPrincipal() {
return ((HttpServletRequest) request).getUserPrincipal();
}
public boolean isUserInRole(String role) {
return ((HttpServletRequest) request).isUserInRole(role);
}
private static class LocalesIterator implements Iterator {
public LocalesIterator(Enumeration locales) {
this.locales = locales;
}
private Enumeration locales;
public boolean hasNext() {
return locales.hasMoreElements();
}
public Locale next() {
return (Locale) locales.nextElement();
}
public void remove() {
throw new UnsupportedOperationException();
}
}
}
abstract class BaseContextMap extends AbstractMap {
private Set> entrySet;
private Set keySet;
private Collection values;
// Supported by maps if overridden
@Override
public void clear() {
throw new UnsupportedOperationException();
}
// Supported by maps if overridden
@Override
public void putAll(Map t) {
throw new UnsupportedOperationException();
}
@Override
public Set> entrySet() {
if (entrySet == null) {
entrySet = new EntrySet();
}
return entrySet;
}
@Override
public Set keySet() {
if (keySet == null) {
keySet = new KeySet();
}
return keySet;
}
@Override
public Collection values() {
if (values == null) {
values = new ValueCollection();
}
return values;
}
// Supported by maps if overridden
@Override
public V remove(Object key) {
throw new UnsupportedOperationException();
}
protected boolean removeKey(Object key) {
return (this.remove(key) != null);
}
protected boolean removeValue(Object value) {
boolean valueRemoved = false;
if (value == null) {
return false;
}
if (containsValue(value)) {
for (Iterator i = entrySet().iterator(); i.hasNext(); ) {
Map.Entry e = (Map.Entry) i.next();
if (value.equals(e.getValue())) {
valueRemoved = (remove(e.getKey()) != null);
}
}
}
return valueRemoved;
}
protected abstract Iterator> getEntryIterator();
protected abstract Iterator getKeyIterator();
protected abstract Iterator getValueIterator();
abstract class BaseSet extends AbstractSet {
@Override
public int size() {
int size = 0;
for (Iterator i = iterator(); i.hasNext(); size++) {
i.next();
}
return size;
}
}
class EntrySet extends BaseSet> {
@Override
public Iterator> iterator() {
return getEntryIterator();
}
@Override
public boolean remove(Object o) {
return o instanceof Map.Entry
&& removeKey(((Map.Entry) o).getKey());
}
}
class KeySet extends BaseSet {
@Override
public Iterator iterator() {
return getKeyIterator();
}
@Override
public boolean contains(Object o) {
return BaseContextMap.this.containsKey(o);
}
@Override
public boolean remove(Object o) {
return o instanceof String && removeKey(o);
}
}
class ValueCollection extends AbstractCollection {
@Override
public int size() {
int size = 0;
for (Iterator i = iterator(); i.hasNext(); size++) {
i.next();
}
return size;
}
@Override
public Iterator iterator() {
return getValueIterator();
}
@Override
public boolean remove(Object o) {
return removeValue(o);
}
}
abstract class BaseIterator implements Iterator {
protected Enumeration e;
protected String currentKey;
protected boolean removeCalled = false;
BaseIterator(Enumeration e) {
this.e = e;
}
public boolean hasNext() {
return e.hasMoreElements();
}
public String nextKey() {
removeCalled = false;
currentKey = (String) e.nextElement();
return currentKey;
}
}
class EntryIterator extends BaseIterator> {
EntryIterator(Enumeration e) {
super(e);
}
public void remove() {
if (currentKey != null && !removeCalled) {
removeCalled = true;
removeKey(currentKey);
} else {
throw new IllegalStateException();
}
}
public Map.Entry next() {
nextKey();
return new Entry(currentKey, get(currentKey));
}
}
class KeyIterator extends BaseIterator {
KeyIterator(Enumeration e) {
super(e);
}
public void remove() {
if (currentKey != null && !removeCalled) {
removeCalled = true;
removeKey(currentKey);
} else {
throw new IllegalStateException();
}
}
public String next() {
return nextKey();
}
}
class ValueIterator extends BaseIterator {
ValueIterator(Enumeration e) {
super(e);
}
public void remove() {
if (currentKey != null && !removeCalled) {
removeCalled = true;
removeValue(get(currentKey));
} else {
throw new IllegalStateException();
}
}
public V next() {
nextKey();
return get(currentKey);
}
}
static class Entry implements Map.Entry {
// immutable Entry
private final String key;
private final V value;
Entry(String key, V value) {
this.key = key;
this.value = value;
}
public String getKey() {
return key;
}
public V getValue() {
return value;
}
// No support of setting the value
public V setValue(V value) {
throw new UnsupportedOperationException();
}
@Override
public int hashCode() {
return ((key == null ? 0 : key.hashCode()) ^
(value == null ? 0 : value.hashCode()));
}
@Override
public boolean equals(Object obj) {
if (obj == null || !(obj instanceof Map.Entry)) {
return false;
}
Map.Entry input = (Map.Entry) obj;
Object inputKey = input.getKey();
Object inputValue = input.getValue();
if (inputKey == key ||
(inputKey != null && inputKey.equals(key))) {
if (inputValue == value ||
(inputValue != null && inputValue.equals(value))) {
return true;
}
}
return false;
}
}
}
abstract class StringArrayValuesMap extends BaseContextMap {
@Override
public boolean equals(Object obj) {
if (obj == null ||
!(obj.getClass() == ExternalContextImpl.theUnmodifiableMapClass)) {
return false;
}
Map objMap = (Map) obj;
if (this.size() != objMap.size()) {
return false;
}
String[] thisKeys = keySet().toArray(new String[this.size()]);
Object[] objKeys = objMap.keySet().toArray();
Arrays.sort(thisKeys);
Arrays.sort(objKeys);
if (!(Arrays.equals(thisKeys, objKeys))) {
return false;
} else {
for (Object key : thisKeys) {
Object[] thisVal = this.get(key);
Object[] objVal = (Object[]) objMap.get(key);
if (!(Arrays.equals(thisVal, objVal))) {
return false;
}
}
}
return true;
}
protected int hashCode(Object someObject) {
int hashCode = 7 * someObject.hashCode();
for (Object o : entrySet()) {
Map.Entry entry = (Map.Entry) o;
hashCode += entry.getKey().hashCode();
hashCode +=
(Arrays.hashCode((Object[]) entry.getValue()));
}
return hashCode;
}
@Override
public boolean containsValue(Object value) {
if (value == null || !value.getClass().isArray()) {
return false;
}
Set entrySet = entrySet();
for (Object anEntrySet : entrySet) {
Map.Entry entry = (Map.Entry) anEntrySet;
// values will be arrays
if (Arrays.equals((Object[]) value, (Object[]) entry.getValue())) {
return true;
}
}
return false;
}
}
class ApplicationMap extends BaseContextMap {
private final ServletContext servletContext;
ApplicationMap(ServletContext servletContext) {
this.servletContext = servletContext;
}
@Override
public void clear() {
for (Enumeration e = servletContext.getAttributeNames();
e.hasMoreElements(); ) {
servletContext.removeAttribute((String) e.nextElement());
}
}
// Supported by maps if overridden
@Override
public void putAll(Map t) {
for (Iterator i = t.entrySet().iterator(); i.hasNext(); ) {
Map.Entry entry = (Map.Entry) i.next();
servletContext.setAttribute((String) entry.getKey(),
entry.getValue());
}
}
@Override
public Object get(Object key) {
Util.notNull("key", key);
return servletContext.getAttribute(key.toString());
}
@Override
public Object put(Object key, Object value) {
Util.notNull("key", key);
Object result = servletContext.getAttribute(key.toString());
servletContext.setAttribute(key.toString(), value);
return (result);
}
@Override
public Object remove(Object key) {
if (key == null) {
return null;
}
String keyString = key.toString();
Object result = servletContext.getAttribute(keyString);
servletContext.removeAttribute(keyString);
return (result);
}
@Override
public boolean containsKey(Object key) {
return (servletContext.getAttribute(key.toString()) != null);
}
@Override
public boolean equals(Object obj) {
return !(obj == null || !(obj instanceof ApplicationMap))
&& super.equals(obj);
}
@Override
public int hashCode() {
int hashCode = 7 * servletContext.hashCode();
for (Iterator i = entrySet().iterator(); i.hasNext(); ) {
hashCode += i.next().hashCode();
}
return hashCode;
}
// --------------------------------------------- Methods from BaseContextMap
@SuppressWarnings("unchecked")
protected Iterator> getEntryIterator() {
return new EntryIterator(servletContext.getAttributeNames());
}
@SuppressWarnings("unchecked")
protected Iterator getKeyIterator() {
return new KeyIterator(servletContext.getAttributeNames());
}
@SuppressWarnings("unchecked")
protected Iterator