Package org.springframework.web.accept

Class ContentNegotiationManagerFactoryBean

java.lang.Object
org.springframework.web.accept.ContentNegotiationManagerFactoryBean
All Implemented Interfaces:
FactoryBean<ContentNegotiationManager>, InitializingBean
public class ContentNegotiationManagerFactoryBean extends Object implements FactoryBean<ContentNegotiationManager>, InitializingBean
Factory to create a ContentNegotiationManager and configure it with ContentNegotiationStrategy instances.

This factory offers properties that in turn result in configuring the underlying strategies. The table below shows the property names, their default settings, as well as the strategies that they help to configure:

Property Setter Default Value Underlying Strategy Enabled Or Not
favorParameter false ParameterContentNegotiationStrategy Off
ignoreAcceptHeader false HeaderContentNegotiationStrategy Enabled
defaultContentType null FixedContentNegotiationStrategy Off
defaultContentTypeStrategy null ContentNegotiationStrategy Off

Alternatively you can avoid use of the above convenience builder methods and set the exact strategies to use via setStrategies(List).

Since:
3.2
Author:
Rossen Stoyanchev, Brian Clozel

  • Constructor Details

    • ContentNegotiationManagerFactoryBean

      public ContentNegotiationManagerFactoryBean()

  • Method Details

    • setStrategies

      public void setStrategies(@Nullable List<ContentNegotiationStrategy> strategies)
      Set the exact list of strategies to use.

      Note: use of this method is mutually exclusive with use of all other setters in this class which customize a default, fixed set of strategies. See class level doc for more details.

      Parameters:
      strategies - the strategies to use
      Since:
      5.0

    • setFavorParameter

      public void setFavorParameter(boolean favorParameter)
      Whether a request parameter ("format" by default) should be used to determine the requested media type. For this option to work you must register media type mappings.

      By default this is set to false.

      See Also:

    • setParameterName

      public void setParameterName(String parameterName)
      Set the query parameter name to use when setFavorParameter(boolean) is on.

      The default parameter name is "format".

    • setMediaTypes

      public void setMediaTypes(Properties mediaTypes)
      Add a mapping from a key to a MediaType where the key are normalized to lowercase and may have been extracted from a path extension, a filename extension, or passed as a query parameter.

      The parameter strategy requires such mappings in order to work.

      Note: Mappings registered here may be accessed via ContentNegotiationManager.getMediaTypeMappings() and may be used not only in the parameter and path extension strategies. For example, with the Spring MVC config, for example, @EnableWebMvc or <mvc:annotation-driven>, the media type mappings are also plugged in to:

      • Determine the media type of static resources served with ResourceHttpRequestHandler.
      • Determine the media type of views rendered with ContentNegotiatingViewResolver.
      • List safe extensions for RFD attack detection (check the Spring Framework reference docs for details).
      Parameters:
      mediaTypes - media type mappings
      See Also:

    • addMediaType

      public void addMediaType(String key, MediaType mediaType)
      An alternative to setMediaTypes(java.util.Properties) for programmatic registrations.

    • addMediaTypes

      public void addMediaTypes(@Nullable Map<String,MediaType> mediaTypes)
      An alternative to setMediaTypes(java.util.Properties) for programmatic registrations.

    • setUseRegisteredExtensionsOnly

      public void setUseRegisteredExtensionsOnly(boolean useRegisteredExtensionsOnly)
      When setFavorParameter(boolean) is set, this property determines whether to use only registered MediaType mappings or to allow dynamic resolution, for example, via MediaTypeFactory.

      By default, this is not set in which case dynamic resolution is on.

    • setIgnoreAcceptHeader

      public void setIgnoreAcceptHeader(boolean ignoreAcceptHeader)
      Whether to disable checking the 'Accept' request header.

      By default this value is set to false.

    • setDefaultContentType

      public void setDefaultContentType(MediaType contentType)
      Set the default content type to use when no content type is requested.

      By default this is not set.

      See Also:

    • setDefaultContentTypes

      public void setDefaultContentTypes(List<MediaType> contentTypes)
      Set the default content types to use when no content type is requested.

      By default this is not set.

      Since:
      5.0
      See Also:

    • setDefaultContentTypeStrategy

      public void setDefaultContentTypeStrategy(ContentNegotiationStrategy strategy)
      Set a custom ContentNegotiationStrategy to use to determine the content type to use when no content type is requested.

      By default this is not set.

      Since:
      4.1.2
      See Also:

    • afterPropertiesSet

      public void afterPropertiesSet()
      Description copied from interface: InitializingBean
      Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, ApplicationContextAware etc.

      This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.

      Specified by:
      afterPropertiesSet in interface InitializingBean

    • build

      public ContentNegotiationManager build()
      Create and initialize a ContentNegotiationManager instance.
      Since:
      5.0

    • getObject

      public @Nullable ContentNegotiationManager getObject()
      Description copied from interface: FactoryBean
      Return an instance (possibly shared or independent) of the object managed by this factory.

      As with a BeanFactory, this allows support for both the Singleton and Prototype design patterns.

      If this FactoryBean is not fully initialized yet at the time of the call (for example because it is involved in a circular reference), throw a corresponding FactoryBeanNotInitializedException.

      FactoryBeans are allowed to return null objects. The bean factory will consider this as a normal value to be used and will not throw a FactoryBeanNotInitializedException in this case. However, FactoryBean implementations are encouraged to throw FactoryBeanNotInitializedException themselves, as appropriate.

      Specified by:
      getObject in interface FactoryBean<ContentNegotiationManager>
      Returns:
      an instance of the bean (can be null)
      See Also:

    • getObjectType

      public Class<?> getObjectType()
      Description copied from interface: FactoryBean
      Return the type of object that this FactoryBean creates, or null if not known in advance.

      This allows one to check for specific types of beans without instantiating objects, for example on autowiring.

      In the case of implementations that create a singleton object, this method should try to avoid singleton creation as far as possible; it should rather estimate the type in advance. For prototypes, returning a meaningful type here is advisable too.

      This method can be called before this FactoryBean has been fully initialized. It must not rely on state created during initialization; of course, it can still use such state if available.

      NOTE: Autowiring will simply ignore FactoryBeans that return null here. Therefore, it is highly recommended to implement this method properly, using the current state of the FactoryBean.

      Specified by:
      getObjectType in interface FactoryBean<ContentNegotiationManager>
      Returns:
      the type of object that this FactoryBean creates, or null if not known at the time of the call
      See Also: