root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 8 Packages Projects Releases Wiki Activity

How to register MIME types in MockServletContext 

Prior to this commit, it was unclear that it was possible to register
custom MIME types when using MockServletContext.

This commit updates the Javadoc for MockServletContext.getMimeType()
with an example of how to achieve this using the MimetypesFileTypeMap
from the Java Activation Framework.

Issue: SPR-12126
This commit is contained in:
Sam Brannen 2014-08-27 00:23:01 +02:00
parent 2f2fe9bd05
commit d5c6bcb901
2 changed files with 28 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
spring-test/src/main/java/org/springframework/mock/web/MockServletContext.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2002-2013 the original author or authors.
* Copyright 2002-2014 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.
@ -45,6 +45,7 @@ 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;
@ -152,8 +153,8 @@ public class MockServletContext implements ServletContext {
/**
* Create a new MockServletContext, using no base path and a
* DefaultResourceLoader (i.e. the classpath root as WAR root).
* Create a new {@code MockServletContext}, using no base path and a
* {@link DefaultResourceLoader} (i.e. the classpath root as WAR root).
* @see org.springframework.core.io.DefaultResourceLoader
*/
public MockServletContext() {
@ -161,7 +162,7 @@ public class MockServletContext implements ServletContext {
}
/**
* Create a new MockServletContext, using a DefaultResourceLoader.
* Create a new {@code MockServletContext}, using a {@link DefaultResourceLoader}.
* @param resourceBasePath the root directory of the WAR (should not end with a slash)
* @see org.springframework.core.io.DefaultResourceLoader
*/
@ -170,7 +171,7 @@ public class MockServletContext implements ServletContext {
}
/**
* Create a new MockServletContext, using the specified ResourceLoader
* Create a new {@code MockServletContext}, using the specified {@link ResourceLoader}
* and no base path.
* @param resourceLoader the ResourceLoader to use (or null for the default)
*/
@ -179,8 +180,8 @@ public class MockServletContext implements ServletContext {
}
/**
* Create a new MockServletContext using the supplied resource base path and
* resource loader.
* Create a new {@code MockServletContext} using the supplied resource base
* path and resource loader.
* <p>Registers a {@link MockRequestDispatcher} for the Servlet named
* {@literal 'default'}.
* @param resourceBasePath the root directory of the WAR (should not end with a slash)
@ -201,8 +202,8 @@ public class MockServletContext implements ServletContext {
}
/**
* Build a full resource location for the given path,
* prepending the resource base path of this MockServletContext.
* Build a full resource location for the given path, prepending the resource
* base path of this {@code MockServletContext}.
* @param path the path as specified
* @return the full resource path
*/
@ -271,10 +272,23 @@ public class MockServletContext implements ServletContext {
}
/**
* This method uses the Java Activation framework, which returns "application/octet-stream"
* when the mime type is unknown (i.e. it never returns {@code null}). In order to maintain
* the {@link ServletContext#getMimeType(String)} contract, this method returns {@code null}
* if the mimeType is "application/octet-stream", as of Spring 3.2.2.
* This method uses the default
* {@link javax.activation.FileTypeMap#getDefaultFileTypeMap() FileTypeMap}
* from the Java Activation Framework to resolve MIME types.
* <p>The Java Activation Framework returns {@code "application/octet-stream"}
* if the MIME type is unknown (i.e., it never returns {@code null}). Thus, in
* order to honor the {@link ServletContext#getMimeType(String)} contract,
* this method returns {@code null} if the MIME type is
* {@code "application/octet-stream"}.
* <p>{@code MockServletContext} does not provide a direct mechanism for
* setting a custom MIME type; however, if the default {@code FileTypeMap}
* is an instance of {@code javax.activation.MimetypesFileTypeMap}, a custom
* MIME type named {@code text/enigma} can be registered for a custom
* {@code .puzzle} file extension in the following manner:
* <pre style="code">
* MimetypesFileTypeMap mimetypesFileTypeMap = (MimetypesFileTypeMap) FileTypeMap.getDefaultFileTypeMap();
* mimetypesFileTypeMap.addMimeTypes("text/enigma puzzle");
* </pre>
*/
@Override
public String getMimeType(String filePath) {

2
spring-test/src/test/java/org/springframework/mock/web/MockServletContextTests.java
View File

@ -86,7 +86,7 @@ public class MockServletContextTests {
*/
@Test
public void getMimeTypeWithCustomConfiguredType() {
FileTypeMap defaultFileTypeMap = MimetypesFileTypeMap.getDefaultFileTypeMap();
FileTypeMap defaultFileTypeMap = FileTypeMap.getDefaultFileTypeMap();
assertThat(defaultFileTypeMap, instanceOf(MimetypesFileTypeMap.class));
MimetypesFileTypeMap mimetypesFileTypeMap = (MimetypesFileTypeMap) defaultFileTypeMap;
mimetypesFileTypeMap.addMimeTypes("text/enigma enigma");