Remove JAF references

This commit updates the main code base to conform to the dropped JAF
dependency in MediaTypeFactory. Specifically, it

 - Removes JAF detection (JAF_PRESENT constants)
 - Deprecated useJaf properties, with no direct replacement.
 - Updated docs to remove JAF references, in favor of MediaTypeFactory.

Issue: SPR-14908

Author: poutsma

spring-web/src/main/java/org/springframework/http/converter/ResourceHttpMessageConverter.java

@@ -27,16 +27,14 @@
 import org.springframework.http.HttpOutputMessage;
 import org.springframework.http.MediaType;
 import org.springframework.http.MediaTypeFactory;
-import org.springframework.util.ClassUtils;
 import org.springframework.util.StreamUtils;
 
 /**
  * Implementation of {@link HttpMessageConverter} that can read/write {@link Resource Resources}
  * and supports byte range requests.
  *
- * <p>By default, this converter can read all media types. The Java Activation Framework (JAF) -
- * if available - is used to determine the {@code Content-Type} of written resources.
- * If JAF is not available, {@code application/octet-stream} is used.
+ * <p>By default, this converter can read all media types. The {@link MediaTypeFactory} is used
+ * to determine the {@code Content-Type} of written resources.
  *
  * @author Arjen Poutsma
  * @author Juergen Hoeller
@@ -45,9 +43,6 @@
  */
 public class ResourceHttpMessageConverter extends AbstractHttpMessageConverter<Resource> {
 
-	private static final boolean jafPresent = ClassUtils.isPresent(
-			"javax.activation.FileTypeMap", ResourceHttpMessageConverter.class.getClassLoader());
-
 	private final boolean supportsReadStreaming;
 
 
@@ -107,12 +102,8 @@ public String getFilename() {
 
 	@Override
 	protected MediaType getDefaultContentType(Resource resource) {
-		if (jafPresent) {
-			return MediaTypeFactory.getMediaType(resource);
-		}
-		else {
-			return MediaType.APPLICATION_OCTET_STREAM;
-		}
+		MediaType mediaType = MediaTypeFactory.getMediaType(resource);
+		return mediaType != null ? mediaType : MediaType.APPLICATION_OCTET_STREAM;
 	}
 
 	@Override

spring-web/src/main/java/org/springframework/http/converter/ResourceRegionHttpMessageConverter.java

@@ -24,14 +24,14 @@
 import java.nio.charset.StandardCharsets;
 import java.util.Collection;
 
+import org.springframework.core.io.Resource;
 import org.springframework.core.io.support.ResourceRegion;
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpInputMessage;
 import org.springframework.http.HttpOutputMessage;
 import org.springframework.http.MediaType;
 import org.springframework.http.MediaTypeFactory;
 import org.springframework.util.Assert;
-import org.springframework.util.ClassUtils;
 import org.springframework.util.MimeTypeUtils;
 import org.springframework.util.StreamUtils;
 
@@ -44,9 +44,6 @@
  */
 public class ResourceRegionHttpMessageConverter extends AbstractGenericHttpMessageConverter<Object> {
 
-	private static final boolean jafPresent = ClassUtils.isPresent(
-			"javax.activation.FileTypeMap", ResourceHttpMessageConverter.class.getClassLoader());
-
 	public ResourceRegionHttpMessageConverter() {
 		super(MediaType.ALL);
 	}
@@ -80,18 +77,24 @@ protected ResourceRegion readInternal(Class<?> clazz, HttpInputMessage inputMess
 	@Override
 	@SuppressWarnings("unchecked")
 	protected MediaType getDefaultContentType(Object object) {
-		if (jafPresent) {
-			if(object instanceof ResourceRegion) {
-				return MediaTypeFactory.getMediaType(((ResourceRegion) object).getResource());
-			}
-			else {
-				Collection<ResourceRegion> regions = (Collection<ResourceRegion>) object;
-				if(regions.size() > 0) {
-					return MediaTypeFactory.getMediaType(regions.iterator().next().getResource());
-				}
+		Resource resource = null;
+		if (object instanceof ResourceRegion) {
+			resource = ((ResourceRegion) object).getResource();
+		}
+		else {
+			Collection<ResourceRegion> regions = (Collection<ResourceRegion>) object;
+			if (regions.size() > 0) {
+				resource = regions.iterator().next().getResource();
 			}
 		}
-		return MediaType.APPLICATION_OCTET_STREAM;
+		MediaType result = null;
+		if (resource != null) {
+			result = MediaTypeFactory.getMediaType(resource);
+		}
+		if (result == null) {
+			return MediaType.APPLICATION_OCTET_STREAM;
+		}
+		return result;
 	}
 
 	@Override

spring-web/src/main/java/org/springframework/web/accept/ContentNegotiationManager.java

@@ -143,10 +143,9 @@ public List<String> resolveFileExtensions(MediaType mediaType) {
 	 * <p>At startup this method returns extensions explicitly registered with
 	 * either {@link PathExtensionContentNegotiationStrategy} or
 	 * {@link ParameterContentNegotiationStrategy}. At runtime if there is a
-	 * "path extension" strategy and its
-	 * {@link PathExtensionContentNegotiationStrategy#setUseJaf(boolean)
-	 * useJaf} property is set to "true", the list of extensions may
-	 * increase as file extensions are resolved via JAF and cached.
+	 * "path extension" strategy, the list of extensions may
+	 * increase as file extensions are resolved via
+	 * {@link org.springframework.http.MediaTypeFactory} and cached.
 	 */
 	@Override
 	public List<String> getAllFileExtensions() {

spring-web/src/main/java/org/springframework/web/accept/ContentNegotiationManagerFactoryBean.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2017 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.
@@ -28,6 +28,7 @@
 import org.springframework.beans.factory.FactoryBean;
 import org.springframework.beans.factory.InitializingBean;
 import org.springframework.http.MediaType;
+import org.springframework.http.MediaTypeFactory;
 import org.springframework.util.Assert;
 import org.springframework.util.CollectionUtils;
 import org.springframework.web.context.ServletContextAware;
@@ -81,8 +82,7 @@
  * "application/json".
  *
  * <p>The path extension strategy will also use {@link ServletContext#getMimeType}
- * and the Java Activation framework (JAF), if available, to resolve a path
- * extension to a MediaType. You may {@link #setUseJaf suppress} the use of JAF.
+ * and {@link MediaTypeFactory} to resolve a path extension to a MediaType.
  *
  * @author Rossen Stoyanchev
  * @since 3.2
@@ -100,8 +100,6 @@ public class ContentNegotiationManagerFactoryBean
 
 	private boolean ignoreUnknownPathExtensions = true;
 
-	private Boolean useJaf;
-
 	private String parameterName = "format";
 
 	private ContentNegotiationStrategy defaultNegotiationStrategy;
@@ -130,8 +128,8 @@ public void setFavorPathExtension(boolean favorPathExtension) {
 	 * (see Spring Framework reference documentation for more details on RFD
 	 * attack protection).
 	 * <p>The path extension strategy will also try to use
-	 * {@link ServletContext#getMimeType} and JAF (if present) to resolve path
-	 * extensions. To change this behavior see the {@link #useJaf} property.
+	 * {@link ServletContext#getMimeType} and
+	 * {@link org.springframework.http.MediaTypeFactory} to resolve path extensions.
 	 * @param mediaTypes media type mappings
 	 * @see #addMediaType(String, MediaType)
 	 * @see #addMediaTypes(Map)
@@ -177,18 +175,10 @@ public void setIgnoreUnknownPathExtensions(boolean ignore) {
 	}
 
 	/**
-	 * When {@link #setFavorPathExtension favorPathExtension} is set, this
-	 * property determines whether to allow use of JAF (Java Activation Framework)
-	 * to resolve a path extension to a specific MediaType.
-	 * <p>By default this is not set in which case
-	 * {@code PathExtensionContentNegotiationStrategy} will use JAF if available.
+	 * @deprecated as 5.0, in favor of {@link MediaTypeFactory}, which has no JAF dependency.
 	 */
+	@Deprecated
 	public void setUseJaf(boolean useJaf) {
-		this.useJaf = useJaf;
-	}
-
-	private boolean isUseJafTurnedOff() {
-		return (this.useJaf != null && !this.useJaf);
 	}
 
 	/**
@@ -254,17 +244,14 @@ public void afterPropertiesSet() {
 
 		if (this.favorPathExtension) {
 			PathExtensionContentNegotiationStrategy strategy;
-			if (this.servletContext != null && !isUseJafTurnedOff()) {
+			if (this.servletContext != null) {
 				strategy = new ServletPathExtensionContentNegotiationStrategy(
 						this.servletContext, this.mediaTypes);
 			}
 			else {
 				strategy = new PathExtensionContentNegotiationStrategy(this.mediaTypes);
 			}
 			strategy.setIgnoreUnknownExtensions(this.ignoreUnknownPathExtensions);
-			if (this.useJaf != null) {
-				strategy.setUseJaf(this.useJaf);
-			}
 			strategies.add(strategy);
 		}
 

spring-web/src/main/java/org/springframework/web/accept/PathExtensionContentNegotiationStrategy.java

@@ -27,7 +27,6 @@
 import org.springframework.http.MediaType;
 import org.springframework.http.MediaTypeFactory;
 import org.springframework.util.Assert;
-import org.springframework.util.ClassUtils;
 import org.springframework.util.StringUtils;
 import org.springframework.web.HttpMediaTypeNotAcceptableException;
 import org.springframework.web.context.request.NativeWebRequest;
@@ -39,26 +38,18 @@
  * request path to a key to be used to look up a media type.
  *
  * <p>If the file extension is not found in the explicit registrations provided
- * to the constructor, the Java Activation Framework (JAF) is used as a fallback
+ * to the constructor, the {@link MediaTypeFactory} is used as a fallback
  * mechanism.
  *
- * <p>The presence of the JAF is detected and enabled automatically but the
- * {@link #setUseJaf(boolean)} property may be set to false.
- *
  * @author Rossen Stoyanchev
  * @since 3.2
  */
 public class PathExtensionContentNegotiationStrategy extends AbstractMappingContentNegotiationStrategy {
 
-	private static final boolean JAF_PRESENT = ClassUtils.isPresent("javax.activation.FileTypeMap",
-			PathExtensionContentNegotiationStrategy.class.getClassLoader());
-
 	private static final Log logger = LogFactory.getLog(PathExtensionContentNegotiationStrategy.class);
 
 	private UrlPathHelper urlPathHelper = new UrlPathHelper();
 
-	private boolean useJaf = true;
-
 	private boolean ignoreUnknownExtensions = true;
 
 
@@ -89,11 +80,10 @@ public void setUrlPathHelper(UrlPathHelper urlPathHelper) {
 	}
 
 	/**
-	 * Whether to use the Java Activation Framework to look up file extensions.
-	 * <p>By default this is set to "true" but depends on JAF being present.
+	 * @deprecated as 5.0, in favor of {@link MediaTypeFactory}, which has no JAF dependency.
 	 */
+	@Deprecated
 	public void setUseJaf(boolean useJaf) {
-		this.useJaf = useJaf;
 	}
 
 	/**
@@ -122,11 +112,9 @@ protected String getMediaTypeKey(NativeWebRequest webRequest) {
 	protected MediaType handleNoMatch(NativeWebRequest webRequest, String extension)
 			throws HttpMediaTypeNotAcceptableException {
 
-		if (this.useJaf && JAF_PRESENT) {
-			MediaType mediaType = MediaTypeFactory.getMediaType("file." + extension);
-			if (mediaType != null && !MediaType.APPLICATION_OCTET_STREAM.equals(mediaType)) {
-				return mediaType;
-			}
+		MediaType mediaType = MediaTypeFactory.getMediaType("file." + extension);
+		if (mediaType != null) {
+			return mediaType;
 		}
 		if (this.ignoreUnknownExtensions) {
 			return null;
@@ -138,7 +126,7 @@ protected MediaType handleNoMatch(NativeWebRequest webRequest, String extension)
 	 * A public method exposing the knowledge of the path extension strategy to
 	 * resolve file extensions to a {@link MediaType} in this case for a given
 	 * {@link Resource}. The method first looks up any explicitly registered
-	 * file extensions first and then falls back on JAF if available.
+	 * file extensions first and then falls back on {@link MediaTypeFactory} if available.
 	 * @param resource the resource to look up
 	 * @return the MediaType for the extension, or {@code null} if none found
 	 * @since 4.3
@@ -151,12 +139,9 @@ public MediaType getMediaTypeForResource(Resource resource) {
 		if (extension != null) {
 			mediaType = lookupMediaType(extension);
 		}
-		if (mediaType == null && JAF_PRESENT) {
+		if (mediaType == null) {
 			mediaType = MediaTypeFactory.getMediaType(filename);
 		}
-		if (MediaType.APPLICATION_OCTET_STREAM.equals(mediaType)) {
-			mediaType = null;
-		}
 		return mediaType;
 	}
 

spring-web/src/main/java/org/springframework/web/accept/ServletPathExtensionContentNegotiationStrategy.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2017 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.
@@ -52,7 +52,8 @@ public ServletPathExtensionContentNegotiationStrategy(
 	/**
 	 * Create an instance without any mappings to start with. Mappings may be
 	 * added later when extensions are resolved through
-	 * {@link ServletContext#getMimeType(String)} or via JAF.
+	 * {@link ServletContext#getMimeType(String)} or via
+	 * {@link org.springframework.http.MediaTypeFactory}.
 	 */
 	public ServletPathExtensionContentNegotiationStrategy(ServletContext context) {
 		this(context, null);
@@ -61,7 +62,8 @@ public ServletPathExtensionContentNegotiationStrategy(ServletContext context) {
 
 	/**
 	 * Resolve file extension via {@link ServletContext#getMimeType(String)}
-	 * and also delegate to base class for a potential JAF lookup.
+	 * and also delegate to base class for a potential
+	 * {@link org.springframework.http.MediaTypeFactory} lookup.
 	 */
 	@Override
 	protected MediaType handleNoMatch(NativeWebRequest webRequest, String extension)

spring-webflux/src/main/java/org/springframework/web/reactive/accept/PathExtensionContentTypeResolver.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2017 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.
@@ -33,17 +33,14 @@
  * the request path and uses that as the media type lookup key.
  *
  * <p>If the file extension is not found in the explicit registrations provided
- * to the constructor, the Java Activation Framework (JAF) is used as a fallback
- * mechanism. The presence of the JAF is detected and enabled automatically but
- * the {@link #setUseJaf(boolean)} property may be set to false.
+ * to the constructor, the {@link MediaTypeFactory} is used as a fallback
+ * mechanism.
  *
  * @author Rossen Stoyanchev
  * @since 5.0
  */
 public class PathExtensionContentTypeResolver extends AbstractMappingContentTypeResolver {
 
-	private boolean useJaf = true;
-
 	private boolean ignoreUnknownExtensions = true;
 
 
@@ -63,14 +60,6 @@ public PathExtensionContentTypeResolver() {
 	}
 
 
-	/**
-	 * Whether to use the Java Activation Framework to look up file extensions.
-	 * <p>By default this is set to "true" but depends on JAF being present.
-	 */
-	public void setUseJaf(boolean useJaf) {
-		this.useJaf = useJaf;
-	}
-
 	/**
 	 * Whether to ignore requests with unknown file extension. Setting this to
 	 * {@code false} results in {@code HttpMediaTypeNotAcceptableException}.
@@ -90,11 +79,9 @@ protected String extractKey(ServerWebExchange exchange) {
 
 	@Override
 	protected MediaType handleNoMatch(String key) throws NotAcceptableStatusException {
-		if (this.useJaf) {
-			MediaType mediaType = MediaTypeFactory.getMediaType("file." + key);
-			if (mediaType != null && !MediaType.APPLICATION_OCTET_STREAM.equals(mediaType)) {
-				return mediaType;
-			}
+		MediaType mediaType = MediaTypeFactory.getMediaType("file." + key);
+		if (mediaType != null) {
+			return mediaType;
 		}
 		if (!this.ignoreUnknownExtensions) {
 			throw new NotAcceptableStatusException(getAllMediaTypes());
@@ -105,7 +92,7 @@ protected MediaType handleNoMatch(String key) throws NotAcceptableStatusExceptio
 	/**
 	 * A public method exposing the knowledge of the path extension resolver to
 	 * determine the media type for a given {@link Resource}. First it checks
-	 * the explicitly registered mappings and then falls back on JAF.
+	 * the explicitly registered mappings and then falls back on {@link MediaTypeFactory}.
 	 * @param resource the resource
 	 * @return the MediaType for the extension, or {@code null} if none determined
 	 */
@@ -120,9 +107,6 @@ public MediaType resolveMediaTypeForResource(Resource resource) {
 		if (mediaType == null) {
 			mediaType = MediaTypeFactory.getMediaType(filename);
 		}
-		if (MediaType.APPLICATION_OCTET_STREAM.equals(mediaType)) {
-			mediaType = null;
-		}
 		return mediaType;
 	}