com.sun.grizzly.http.servlet.ServletContextImpl Maven / Gradle / Ivy
/*
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 2007-2008 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.grizzly.http.servlet;
import com.sun.grizzly.util.http.Enumerator;
import com.sun.grizzly.util.http.MimeType;
import java.io.File;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Set;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.servlet.RequestDispatcher;
import javax.servlet.Servlet;
import javax.servlet.ServletContext;
/**
*
* @author Jeanfrancois Arcand
*/
public class ServletContextImpl implements ServletContext {
/**
* Empty collection to serve as the basis for empty enumerations.
* DO NOT ADD ANY ELEMENTS TO THIS COLLECTION!
*/
private static final ArrayList empty = new ArrayList();
/**
* The merged context initialization parameters for this Context.
*/
private HashMap parameters;
/**
* The context attributes for this context.
*/
private HashMap attributes = new HashMap();
private String servletPath = "";
private String contextPath = "";
private Logger logger = Logger.getLogger("Grizzly");
private String basePath = "";
/**
* {@inheritDoc}
*/
public String getContextPath() {
return contextPath;
}
/**
* Programmatically set the context path of the Servlet.
* @param contextPath
*/
protected void setContextPath(String contextPath){
this.contextPath = contextPath;
}
/**
* Return a ServletContext object that corresponds to a
* specified URI on the server. This method allows servlets to gain
* access to the context for various parts of the server, and as needed
* obtain RequestDispatcher objects or resources from the
* context. The given path must be absolute (beginning with a "/"),
* and is interpreted based on our virtual host's document root.
*
* @param uri Absolute URI of a resource on the server
*/
public ServletContext getContext(String uri) {
return this;
}
/**
* Return the major version of the Java Servlet API that we implement.
*/
public int getMajorVersion() {
return 2;
}
/**
* Return the minor version of the Java Servlet API that we implement.
*/
public int getMinorVersion() {
return 5;
}
/**
* Return the MIME type of the specified file, or null if
* the MIME type cannot be determined.
*
* @param file Filename for which to identify a MIME type
*/
public String getMimeType(String file) {
if (file == null)
return (null);
int period = file.lastIndexOf(".");
if (period < 0)
return (null);
String extension = file.substring(period + 1);
if (extension.length() < 1)
return (null);
return MimeType.get(extension);
}
/**
* Return a Set containing the resource paths of resources member of the
* specified collection. Each path will be a String starting with
* a "/" character. The returned set is immutable.
*
* @param path Collection path
* TODO: Not yet supported
*/
public Set getResourcePaths(String path) {
// Validate the path argument
if (path == null) {
return null;
}
if (!path.startsWith("/")) {
throw new IllegalArgumentException(path);
}
path = normalize(path);
if (path == null)
return (null);
File[] files = new File(contextPath, path).listFiles();
Set list = new HashSet();
for (File f : files){
list.add(f);
}
return list;
}
/**
* Return the URL to the resource that is mapped to a specified path.
* The path must begin with a "/" and is interpreted as relative to the
* current context root.
*
* @param path The path to the desired resource
*
* @exception MalformedURLException if the path is not given
* in the correct form
*/
public URL getResource(String path) throws MalformedURLException {
if (path == null || !path.startsWith("/")) {
throw new MalformedURLException(path);
}
path = normalize(path);
if (path == null)
return (null);
return Thread.currentThread().getContextClassLoader()
.getResource(path);
}
/**
* Return the requested resource as an {@link InputStream}. The
* path must be specified according to the rules described under
* getResource. If no such resource can be identified,
* return null.
*
* @param path The path to the desired resource.
*/
public InputStream getResourceAsStream(String path) {
path = normalize(path);
if (path == null)
return (null);
return Thread.currentThread().getContextClassLoader()
.getResourceAsStream(path);
}
/**
* {@inheritDoc}
*/
//TODO.
public RequestDispatcher getRequestDispatcher(String arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
/**
* {@inheritDoc}
*/
//TODO.
public RequestDispatcher getNamedDispatcher(String arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
/**
* @deprecated As of Java Servlet API 2.1, with no direct replacement.
*/
public Servlet getServlet(String name) {
return (null);
}
/**
* @deprecated As of Java Servlet API 2.1, with no direct replacement.
*/
public Enumeration getServlets() {
return (new Enumerator(empty));
}
/**
* @deprecated As of Java Servlet API 2.1, with no direct replacement.
*/
public Enumeration getServletNames() {
return (new Enumerator(empty));
}
/**
* {@inheritDoc}
*/
public void log(String string) {
logger.log(Level.INFO,string);
}
/**
* {@inheritDoc}
*/
@SuppressWarnings("deprecation")
public void log(Exception e, String msg) {
logger.log(Level.INFO,msg,e);
}
/**
* {@inheritDoc}
*/
public void log(String msg, Throwable t) {
logger.log(Level.INFO,msg,t);
}
/**
* Return the real path for a given virtual path, if possible; otherwise
* return null.
*
* @param path The path to the desired resource
*/
public String getRealPath(String path) {
if (path == null) {
return null;
}
File file = new File(basePath, path);
return (file.getAbsolutePath());
}
//TODO: Make it configurable via System.getProperty();
public String getServerInfo() {
return "Grizzly";
}
/**
* Return the value of the specified initialization parameter, or
* null if this parameter does not exist.
*
* @param name Name of the initialization parameter to retrieve
*/
public String getInitParameter(final String name) {
synchronized (parameters) {
return parameters.get(name);
}
}
/**
* Return the names of the context's initialization parameters, or an
* empty enumeration if the context has no initialization parameters.
*/
public Enumeration getInitParameterNames() {
synchronized (parameters) {
return (new Enumerator(parameters.keySet()));
}
}
protected void setInitParameter(HashMap parameters){
this.parameters = parameters;
}
/**
* Return the value of the specified context attribute, if any;
* otherwise return null.
*
* @param name Name of the context attribute to return
*/
public Object getAttribute(String name) {
synchronized (attributes) {
return (attributes.get(name));
}
}
/**
* Return an enumeration of the names of the context attributes
* associated with this context.
*/
public Enumeration getAttributeNames() {
synchronized (attributes) {
return new Enumerator(attributes.keySet(), true);
}
}
/**
* Bind the specified value with the specified context attribute name,
* replacing any existing value for that name.
*
* @param name Attribute name to be bound
* @param value New attribute value to be bound
*/
@SuppressWarnings("unchecked")
public void setAttribute(String name, Object value) {
// Name cannot be null
if (name == null)
throw new IllegalArgumentException
("Cannot be null");
// Null value is the same as removeAttribute()
if (value == null) {
removeAttribute(name);
return;
}
Object oldValue = null;
boolean replaced = false;
// Add or replace the specified attribute
synchronized (attributes) {
oldValue = attributes.get(name);
if (oldValue != null)
replaced = true;
attributes.put(name, value);
}
}
/**
* Remove the context attribute with the specified name, if any.
*
* @param name Name of the context attribute to be removed
*/
public void removeAttribute(String name) {
Object value = null;
boolean found = false;
// Remove the specified attribute
synchronized (attributes) {
found = attributes.containsKey(name);
if (found) {
value = attributes.get(name);
attributes.remove(name);
} else {
return;
}
}
}
/**
* {@inheritDoc}
*/
public String getServletContextName() {
return "";
}
/**
* Return a context-relative path, beginning with a "/", that represents
* the canonical version of the specified path after ".." and "." elements
* are resolved out. If the specified path attempts to go outside the
* boundaries of the current context (i.e. too many ".." path elements
* are present), return null instead.
*
* @param path Path to be normalized
*/
private String normalize(String path) {
if (path == null) {
return null;
}
String normalized = path;
// Normalize the slashes and add leading slash if necessary
if (normalized.indexOf('\\') >= 0)
normalized = normalized.replace('\\', '/');
// Resolve occurrences of "/../" in the normalized path
while (true) {
int index = normalized.indexOf("/../");
if (index < 0)
break;
if (index == 0)
return (null); // Trying to go outside our context
int index2 = normalized.lastIndexOf('/', index - 1);
normalized = normalized.substring(0, index2) +
normalized.substring(index + 3);
}
// Return the normalized path that we have completed
return (normalized);
}
/**
* Set the context-path. Default is "".
*/
protected String getServletPath() {
return servletPath;
}
/**
* Programmaticaly set the servlet path value. Default is an empty String.
* @param servletPath
*/
protected void setServletPath(String servletPath){
this.servletPath = servletPath;
}
/**
* Return the current based path.
* @return basePath
*/
protected String getBasePath() {
return basePath;
}
/**
* Set the basePath used by the {@link #getRealPath}.
* @param basePath
*/
protected void setBasePath(String basePath) {
this.basePath = basePath;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy