Java tutorial
/* * WARNING: THIS FILE WAS COPIED FROM SPRINGFRAMEWORK 3.1.2 DISTRIBUTION * AND ADAPTED FOR GRAILS-JAXRX PLUGIN. * * Copyright 2002-2011 the original author or authors. * * Licensed 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.grails.jaxrs.springframework.mock.web; import java.io.File; import java.io.IOException; import java.io.InputStream; import java.net.MalformedURLException; import java.net.URL; import java.util.Collections; import java.util.Enumeration; import java.util.EventListener; import java.util.HashMap; import java.util.HashSet; import java.util.LinkedHashMap; import java.util.LinkedHashSet; import java.util.Map; import java.util.Set; import java.util.Vector; import javax.activation.FileTypeMap; import javax.servlet.Filter; import javax.servlet.FilterRegistration; import javax.servlet.FilterRegistration.Dynamic; import javax.servlet.RequestDispatcher; import javax.servlet.Servlet; import javax.servlet.ServletContext; import javax.servlet.ServletException; import javax.servlet.ServletRegistration; import javax.servlet.SessionCookieConfig; import javax.servlet.SessionTrackingMode; import javax.servlet.descriptor.JspConfigDescriptor; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.springframework.core.io.DefaultResourceLoader; import org.springframework.core.io.Resource; import org.springframework.core.io.ResourceLoader; import org.springframework.util.Assert; import org.springframework.util.ClassUtils; import org.springframework.util.ObjectUtils; import org.springframework.web.util.WebUtils; /** * Mock implementation of the {@link javax.servlet.ServletContext} interface. * * <p>Compatible with Servlet 2.5 and partially with Servlet 3.0. Can be configured to * expose a specific version through {@link #setMajorVersion}/{@link #setMinorVersion}; * default is 2.5. Note that Servlet 3.0 support is limited: servlet, filter and listener * registration methods are not supported; neither is cookie or JSP configuration. * We generally do not recommend to unit-test your ServletContainerInitializers and * WebApplicationInitializers which is where those registration methods would be used. * * <p>Used for testing the Spring web framework; only rarely necessary for testing * application controllers. As long as application components don't explicitly * access the ServletContext, ClassPathXmlApplicationContext or * FileSystemXmlApplicationContext can be used to load the context files for testing, * even for DispatcherServlet context definitions. * * <p>For setting up a full WebApplicationContext in a test environment, you can * use XmlWebApplicationContext (or GenericWebApplicationContext), passing in an * appropriate MockServletContext instance. You might want to configure your * MockServletContext with a FileSystemResourceLoader in that case, to make your * resource paths interpreted as relative file system locations. * * <p>A common setup is to point your JVM working directory to the root of your * web application directory, in combination with filesystem-based resource loading. * This allows to load the context files as used in the web application, with * relative paths getting interpreted correctly. Such a setup will work with both * FileSystemXmlApplicationContext (which will load straight from the file system) * and XmlWebApplicationContext with an underlying MockServletContext (as long as * the MockServletContext has been configured with a FileSystemResourceLoader). * * @author Rod Johnson * @author Juergen Hoeller * @since 1.0.2 * @see #MockServletContext(org.springframework.core.io.ResourceLoader) * @see org.springframework.web.context.support.XmlWebApplicationContext * @see org.springframework.web.context.support.GenericWebApplicationContext * @see org.springframework.context.support.ClassPathXmlApplicationContext * @see org.springframework.context.support.FileSystemXmlApplicationContext */ public class MockServletContext implements ServletContext { private static final String TEMP_DIR_SYSTEM_PROPERTY = "java.io.tmpdir"; private final Log logger = LogFactory.getLog(getClass()); private final ResourceLoader resourceLoader; private final String resourceBasePath; private String contextPath = ""; private int majorVersion = 2; private int minorVersion = 5; private int effectiveMajorVersion = 2; private int effectiveMinorVersion = 5; private final Map<String, ServletContext> contexts = new HashMap<String, ServletContext>(); private final Map<String, String> initParameters = new LinkedHashMap<String, String>(); private final Map<String, Object> attributes = new LinkedHashMap<String, Object>(); private String servletContextName = "MockServletContext"; private final Set<String> declaredRoles = new HashSet<String>(); /** * Create a new MockServletContext, using no base path and a * DefaultResourceLoader (i.e. the classpath root as WAR root). * @see org.springframework.core.io.DefaultResourceLoader */ public MockServletContext() { this("", null); } /** * Create a new MockServletContext, using a DefaultResourceLoader. * @param resourceBasePath the WAR root directory (should not end with a slash) * @see org.springframework.core.io.DefaultResourceLoader */ public MockServletContext(String resourceBasePath) { this(resourceBasePath, null); } /** * Create a new MockServletContext, using the specified ResourceLoader * and no base path. * @param resourceLoader the ResourceLoader to use (or null for the default) */ public MockServletContext(ResourceLoader resourceLoader) { this("", resourceLoader); } /** * Create a new MockServletContext. * @param resourceBasePath the WAR root directory (should not end with a slash) * @param resourceLoader the ResourceLoader to use (or null for the default) */ public MockServletContext(String resourceBasePath, ResourceLoader resourceLoader) { this.resourceLoader = (resourceLoader != null ? resourceLoader : new DefaultResourceLoader()); this.resourceBasePath = (resourceBasePath != null ? resourceBasePath : ""); // Use JVM temp dir as ServletContext temp dir. String tempDir = System.getProperty(TEMP_DIR_SYSTEM_PROPERTY); if (tempDir != null) { this.attributes.put(WebUtils.TEMP_DIR_CONTEXT_ATTRIBUTE, new File(tempDir)); } } /** * Build a full resource location for the given path, * prepending the resource base path of this MockServletContext. * @param path the path as specified * @return the full resource path */ protected String getResourceLocation(String path) { if (!path.startsWith("/")) { path = "/" + path; } return this.resourceBasePath + path; } public void setContextPath(String contextPath) { this.contextPath = (contextPath != null ? contextPath : ""); } /* This is a Servlet API 2.5 method. */ public String getContextPath() { return this.contextPath; } public void registerContext(String contextPath, ServletContext context) { this.contexts.put(contextPath, context); } public ServletContext getContext(String contextPath) { if (this.contextPath.equals(contextPath)) { return this; } return this.contexts.get(contextPath); } public void setMajorVersion(int majorVersion) { this.majorVersion = majorVersion; } public int getMajorVersion() { return this.majorVersion; } public void setMinorVersion(int minorVersion) { this.minorVersion = minorVersion; } public int getMinorVersion() { return this.minorVersion; } public void setEffectiveMajorVersion(int effectiveMajorVersion) { this.effectiveMajorVersion = effectiveMajorVersion; } public int getEffectiveMajorVersion() { return this.effectiveMajorVersion; } public void setEffectiveMinorVersion(int effectiveMinorVersion) { this.effectiveMinorVersion = effectiveMinorVersion; } public int getEffectiveMinorVersion() { return this.effectiveMinorVersion; } public String getMimeType(String filePath) { return MimeTypeResolver.getMimeType(filePath); } public Set<String> getResourcePaths(String path) { String actualPath = (path.endsWith("/") ? path : path + "/"); Resource resource = this.resourceLoader.getResource(getResourceLocation(actualPath)); try { File file = resource.getFile(); String[] fileList = file.list(); if (ObjectUtils.isEmpty(fileList)) { return null; } Set<String> resourcePaths = new LinkedHashSet<String>(fileList.length); for (String fileEntry : fileList) { String resultPath = actualPath + fileEntry; if (resource.createRelative(fileEntry).getFile().isDirectory()) { resultPath += "/"; } resourcePaths.add(resultPath); } return resourcePaths; } catch (IOException ex) { logger.warn("Couldn't get resource paths for " + resource, ex); return null; } } public URL getResource(String path) throws MalformedURLException { Resource resource = this.resourceLoader.getResource(getResourceLocation(path)); if (!resource.exists()) { return null; } try { return resource.getURL(); } catch (MalformedURLException ex) { throw ex; } catch (IOException ex) { logger.warn("Couldn't get URL for " + resource, ex); return null; } } public InputStream getResourceAsStream(String path) { Resource resource = this.resourceLoader.getResource(getResourceLocation(path)); if (!resource.exists()) { return null; } try { return resource.getInputStream(); } catch (IOException ex) { logger.warn("Couldn't open InputStream for " + resource, ex); return null; } } public RequestDispatcher getRequestDispatcher(String path) { if (!path.startsWith("/")) { throw new IllegalArgumentException( "RequestDispatcher path at ServletContext level must start with '/'"); } return new MockRequestDispatcher(path); } public RequestDispatcher getNamedDispatcher(String path) { return null; } public Servlet getServlet(String name) { return null; } public Enumeration<Servlet> getServlets() { return Collections.enumeration(new HashSet<Servlet>()); } public Enumeration<String> getServletNames() { return Collections.enumeration(new HashSet<String>()); } public void log(String message) { logger.info(message); } public void log(Exception ex, String message) { logger.info(message, ex); } public void log(String message, Throwable ex) { logger.info(message, ex); } public String getRealPath(String path) { Resource resource = this.resourceLoader.getResource(getResourceLocation(path)); try { return resource.getFile().getAbsolutePath(); } catch (IOException ex) { logger.warn("Couldn't determine real path of resource " + resource, ex); return null; } } public String getServerInfo() { return "MockServletContext"; } public String getInitParameter(String name) { Assert.notNull(name, "Parameter name must not be null"); return this.initParameters.get(name); } public Enumeration<String> getInitParameterNames() { return Collections.enumeration(this.initParameters.keySet()); } public boolean setInitParameter(String name, String value) { Assert.notNull(name, "Parameter name must not be null"); if (this.initParameters.containsKey(name)) { return false; } this.initParameters.put(name, value); return true; } public void addInitParameter(String name, String value) { Assert.notNull(name, "Parameter name must not be null"); this.initParameters.put(name, value); } public Object getAttribute(String name) { Assert.notNull(name, "Attribute name must not be null"); return this.attributes.get(name); } public Enumeration<String> getAttributeNames() { return new Vector<String>(this.attributes.keySet()).elements(); } public void setAttribute(String name, Object value) { Assert.notNull(name, "Attribute name must not be null"); if (value != null) { this.attributes.put(name, value); } else { this.attributes.remove(name); } } public void removeAttribute(String name) { Assert.notNull(name, "Attribute name must not be null"); this.attributes.remove(name); } public void setServletContextName(String servletContextName) { this.servletContextName = servletContextName; } public String getServletContextName() { return this.servletContextName; } public ClassLoader getClassLoader() { return ClassUtils.getDefaultClassLoader(); } public void declareRoles(String... roleNames) { Assert.notNull(roleNames, "Role names array must not be null"); for (String roleName : roleNames) { Assert.hasLength(roleName, "Role name must not be empty"); this.declaredRoles.add(roleName); } } public Set<String> getDeclaredRoles() { return Collections.unmodifiableSet(this.declaredRoles); } /** * Inner factory class used to just introduce a Java Activation Framework * dependency when actually asked to resolve a MIME type. */ private static class MimeTypeResolver { public static String getMimeType(String filePath) { return FileTypeMap.getDefaultFileTypeMap().getContentType(filePath); } } @Override public Dynamic addFilter(String arg0, String arg1) { throw new RuntimeException("servlet 3.0 api method not implemented yet"); } @Override public Dynamic addFilter(String arg0, Filter arg1) { throw new RuntimeException("servlet 3.0 api method not implemented yet"); } @Override public Dynamic addFilter(String arg0, Class<? extends Filter> arg1) { throw new RuntimeException("servlet 3.0 api method not implemented yet"); } @Override public void addListener(Class<? extends EventListener> arg0) { throw new RuntimeException("servlet 3.0 api method not implemented yet"); } @Override public void addListener(String arg0) { throw new RuntimeException("servlet 3.0 api method not implemented yet"); } @Override public <T extends EventListener> void addListener(T arg0) { throw new RuntimeException("servlet 3.0 api method not implemented yet"); } @Override public javax.servlet.ServletRegistration.Dynamic addServlet(String arg0, String arg1) { throw new RuntimeException("servlet 3.0 api method not implemented yet"); } @Override public javax.servlet.ServletRegistration.Dynamic addServlet(String arg0, Servlet arg1) { throw new RuntimeException("servlet 3.0 api method not implemented yet"); } @Override public javax.servlet.ServletRegistration.Dynamic addServlet(String arg0, Class<? extends Servlet> arg1) { throw new RuntimeException("servlet 3.0 api method not implemented yet"); } @Override public <T extends Filter> T createFilter(Class<T> arg0) throws ServletException { throw new RuntimeException("servlet 3.0 api method not implemented yet"); } @Override public <T extends EventListener> T createListener(Class<T> arg0) throws ServletException { throw new RuntimeException("servlet 3.0 api method not implemented yet"); } @Override public <T extends Servlet> T createServlet(Class<T> arg0) throws ServletException { throw new RuntimeException("servlet 3.0 api method not implemented yet"); } @Override public Set<SessionTrackingMode> getDefaultSessionTrackingModes() { throw new RuntimeException("servlet 3.0 api method not implemented yet"); } @Override public Set<SessionTrackingMode> getEffectiveSessionTrackingModes() { throw new RuntimeException("servlet 3.0 api method not implemented yet"); } @Override public FilterRegistration getFilterRegistration(String arg0) { throw new RuntimeException("servlet 3.0 api method not implemented yet"); } @Override public Map<String, ? extends FilterRegistration> getFilterRegistrations() { throw new RuntimeException("servlet 3.0 api method not implemented yet"); } @Override public JspConfigDescriptor getJspConfigDescriptor() { throw new RuntimeException("servlet 3.0 api method not implemented yet"); } @Override public ServletRegistration getServletRegistration(String arg0) { throw new RuntimeException("servlet 3.0 api method not implemented yet"); } @Override public Map<String, ? extends ServletRegistration> getServletRegistrations() { throw new RuntimeException("servlet 3.0 api method not implemented yet"); } @Override public SessionCookieConfig getSessionCookieConfig() { throw new RuntimeException("servlet 3.0 api method not implemented yet"); } @Override public void setSessionTrackingModes(Set<SessionTrackingMode> arg0) throws IllegalStateException, IllegalArgumentException { throw new RuntimeException("servlet 3.0 api method not implemented yet"); } }