org.springframework.web.accept

Class ContentNegotiationManagerFactoryBean

  • java.lang.Object
    • org.springframework.web.accept.ContentNegotiationManagerFactoryBean
    • Constructor Detail

      • ContentNegotiationManagerFactoryBean

        public ContentNegotiationManagerFactoryBean()
    • Method Detail

      • setStrategies

        public void setStrategies(@Nullable
                                  java.util.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
      • setFavorPathExtension

        public void setFavorPathExtension(boolean favorPathExtension)
        Whether the path extension in the URL path should be used to determine the requested media type.

        By default this 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(java.util.Properties mediaTypes)
        Add a mapping from a key, extracted from a path extension or a query parameter, to a MediaType. This is required in order for the parameter strategy to work. Any extensions explicitly registered here are also whitelisted for the purpose of Reflected File Download attack detection (see Spring Framework reference documentation for more details on RFD attack protection).

        The path extension strategy will also try to use ServletContext.getMimeType(java.lang.String) and MediaTypeFactory to resolve path extensions.

        Parameters:
        mediaTypes - media type mappings
        See Also:
        addMediaType(String, MediaType), addMediaTypes(Map)
      • setIgnoreUnknownPathExtensions

        public void setIgnoreUnknownPathExtensions(boolean ignore)
        Whether to ignore requests with path extension that cannot be resolved to any media type. Setting this to false will result in an HttpMediaTypeNotAcceptableException if there is no match.

        By default this is set to true.

      • setUseJaf

        @Deprecated
        public void setUseJaf(boolean useJaf)
        Deprecated. as of 5.0, in favor of setUseRegisteredExtensionsOnly(boolean), which has reverse behavior.
        Indicate whether to use the Java Activation Framework as a fallback option to map from file extensions to media types.
      • setUseRegisteredExtensionsOnly

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

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

      • 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(java.lang.String)
      • setParameterName

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

        The default parameter name is "format".

      • setIgnoreAcceptHeader

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

        By default this value is set to false.

      • 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
      • getObject

        @Nullable
        public 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 pattern.

        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.

        As of Spring 2.0, FactoryBeans are allowed to return null objects. The factory will consider this as normal value to be used; it will not throw a FactoryBeanNotInitializedException in this case anymore. FactoryBean implementations are encouraged to throw FactoryBeanNotInitializedException themselves now, as appropriate.

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

        public java.lang.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 are creating 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:
        ListableBeanFactory.getBeansOfType(java.lang.Class<T>)
      • isSingleton

        public boolean isSingleton()
        Description copied from interface: FactoryBean
        Is the object managed by this factory a singleton? That is, will FactoryBean.getObject() always return the same object (a reference that can be cached)?

        NOTE: If a FactoryBean indicates to hold a singleton object, the object returned from getObject() might get cached by the owning BeanFactory. Hence, do not return true unless the FactoryBean always exposes the same reference.

        The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory; usually, it has to be defined as singleton there.

        NOTE: This method returning false does not necessarily indicate that returned objects are independent instances. An implementation of the extended SmartFactoryBean interface may explicitly indicate independent instances through its SmartFactoryBean.isPrototype() method. Plain FactoryBean implementations which do not implement this extended interface are simply assumed to always return independent instances if the isSingleton() implementation returns false.

        The default implementation returns true, since a FactoryBean typically manages a singleton instance.

        Specified by:
        isSingleton in interface FactoryBean<ContentNegotiationManager>
        Returns:
        whether the exposed object is a singleton
        See Also:
        FactoryBean.getObject(), SmartFactoryBean.isPrototype()