org.springframework.web.accept

Class ContentNegotiationManagerFactoryBean

java.lang.Object

org.springframework.web.accept.ContentNegotiationManagerFactoryBean

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.FactoryBean<ContentNegotiationManager>, org.springframework.beans.factory.InitializingBean, ServletContextAware

public class ContentNegotiationManagerFactoryBean
extends Object
implements org.springframework.beans.factory.FactoryBean<ContentNegotiationManager>, ServletContextAware, org.springframework.beans.factory.InitializingBean

A factory providing convenient access to a ContentNegotiationManager configured with one or more ContentNegotiationStrategy instances.

By default strategies for checking the extension of the request path and the Accept header are registered. The path extension check will perform lookups through the ServletContext and the Java Activation Framework (if present) unless media types are configured.

Since:

3.2

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Constructor and Description
ContentNegotiationManagerFactoryBean()

Method Summary

Methods

Modifier and Type	Method and Description
void	addMediaType(String fileExtension, MediaType mediaType) Add a mapping from a file extension to a media type.
void	addMediaTypes(Map<String,MediaType> mediaTypes) Add mappings from file extensions to media types.
void	afterPropertiesSet()
ContentNegotiationManager	getObject()
Class<?>	getObjectType()
boolean	isSingleton()
void	setDefaultContentType(MediaType defaultContentType) Set the default content type.
void	setFavorParameter(boolean favorParameter) Indicate whether a request parameter should be used to determine the requested media type with the 2nd highest priority, i.e.
void	setFavorPathExtension(boolean favorPathExtension) Indicate whether the extension of the request path should be used to determine the requested media type with the highest priority.
void	setIgnoreAcceptHeader(boolean ignoreAcceptHeader) Indicate whether the HTTP Accept header should be ignored altogether.
void	setMediaTypes(Properties mediaTypes) Add mappings from file extensions to media types represented as strings.
void	setParameterName(String parameterName) Set the parameter name that can be used to determine the requested media type if the setFavorParameter(boolean) property is true.
void	setServletContext(ServletContext servletContext) Set the ServletContext that this object runs in.
void	setUseJaf(boolean useJaf) Indicate whether to use the Java Activation Framework as a fallback option to map from file extensions to media types.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ContentNegotiationManagerFactoryBean

public ContentNegotiationManagerFactoryBean()

Method Detail

setFavorPathExtension

public void setFavorPathExtension(boolean favorPathExtension)

Indicate whether the extension of the request path should be used to determine the requested media type with the highest priority.

By default this value is set to true in which case a request for /hotels.pdf will be interpreted as a request for "application/pdf" regardless of the Accept header.

setMediaTypes

public void setMediaTypes(Properties mediaTypes)

Add mappings from file extensions to media types represented as strings.

When this mapping is not set or when an extension is not found, the Java Action Framework, if available, may be used if enabled via setFavorPathExtension(boolean).

See Also:

addMediaType(String, MediaType), addMediaTypes(Map)

addMediaType

public void addMediaType(String fileExtension,
                MediaType mediaType)

Add a mapping from a file extension to a media type.

If no mapping is added or when an extension is not found, the Java Action Framework, if available, may be used if enabled via setFavorPathExtension(boolean).

addMediaTypes

public void addMediaTypes(Map<String,MediaType> mediaTypes)

Add mappings from file extensions to media types.

If no mappings are added or when an extension is not found, the Java Action Framework, if available, may be used if enabled via setFavorPathExtension(boolean).

setUseJaf

public void setUseJaf(boolean useJaf)

Indicate whether to use the Java Activation Framework as a fallback option to map from file extensions to media types. This is used only when setFavorPathExtension(boolean) is set to true.

The default value is true.

See Also:

setParameterName(java.lang.String), setMediaTypes(java.util.Properties)

setFavorParameter

public void setFavorParameter(boolean favorParameter)

Indicate whether a request parameter should be used to determine the requested media type with the 2nd highest priority, i.e. after path extensions but before the Accept header.

The default value is false. If set to to true, a request for /hotels?format=pdf will be interpreted as a request for "application/pdf" regardless of the Accept header.

To use this option effectively you must also configure the MediaType type mappings via setMediaTypes(Properties).

See Also:

setParameterName(java.lang.String)

setParameterName

public void setParameterName(String parameterName)

Set the parameter name that can be used to determine the requested media type if the setFavorParameter(boolean) property is true.

The default parameter name is "format".

setIgnoreAcceptHeader

public void setIgnoreAcceptHeader(boolean ignoreAcceptHeader)

Indicate whether the HTTP Accept header should be ignored altogether. If set the Accept header is checked at the 3rd highest priority, i.e. after the request path extension and possibly a request parameter if configured.

By default this value is set to false.

setDefaultContentType

public void setDefaultContentType(MediaType defaultContentType)

Set the default content type.

This content type will be used when neither the request path extension, nor a request parameter, nor the Accept header could help determine the requested content type.

setServletContext

public void setServletContext(ServletContext servletContext)

Description copied from interface: ServletContextAware

Set the ServletContext that this object runs in.

Invoked after population of normal bean properties but before an init callback like InitializingBean's afterPropertiesSet or a custom init-method. Invoked after ApplicationContextAware's setApplicationContext.

Specified by:

setServletContext in interface ServletContextAware

Parameters:

servletContext - ServletContext object to be used by this object

See Also:

InitializingBean.afterPropertiesSet(), ApplicationContextAware.setApplicationContext(org.springframework.context.ApplicationContext)

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

getObject

public ContentNegotiationManager getObject()

Specified by:

getObject in interface org.springframework.beans.factory.FactoryBean<ContentNegotiationManager>

getObjectType

public Class<?> getObjectType()

Specified by:

getObjectType in interface org.springframework.beans.factory.FactoryBean<ContentNegotiationManager>

isSingleton

public boolean isSingleton()

Specified by:

isSingleton in interface org.springframework.beans.factory.FactoryBean<ContentNegotiationManager>