Class AbstractView

java.lang.Object
org.springframework.web.reactive.result.view.AbstractView
All Implemented Interfaces:
Aware, BeanNameAware, ApplicationContextAware, View
Direct Known Subclasses:
AbstractUrlBasedView
public abstract class AbstractView extends Object implements View, BeanNameAware, ApplicationContextAware
Base class for View implementations.
Since:
5.0
Author:
Rossen Stoyanchev, Sam Brannen

  • Field Details

    • REQUEST_DATA_VALUE_PROCESSOR_BEAN_NAME

      public static final String REQUEST_DATA_VALUE_PROCESSOR_BEAN_NAME
      Well-known name for the RequestDataValueProcessor in the bean factory.
      See Also:

    • logger

      protected final org.apache.commons.logging.Log logger
      Logger that is available to subclasses.

  • Constructor Details

    • AbstractView

      public AbstractView()

    • AbstractView

      public AbstractView(ReactiveAdapterRegistry reactiveAdapterRegistry)

  • Method Details

    • setSupportedMediaTypes

      public void setSupportedMediaTypes(List<MediaType> supportedMediaTypes)
      Set the supported media types for this view.

      Default is "text/html;charset=UTF-8".

    • getSupportedMediaTypes

      public List<MediaType> getSupportedMediaTypes()
      Get the configured media types supported by this view.
      Specified by:
      getSupportedMediaTypes in interface View

    • setDefaultCharset

      public void setDefaultCharset(Charset defaultCharset)
      Set the default charset for this view, used when the content type does not contain one.

      Default is UTF 8.

    • getDefaultCharset

      public Charset getDefaultCharset()
      Get the default charset, used when the content type does not contain one.

    • setRequestContextAttribute

      public void setRequestContextAttribute(@Nullable String requestContextAttribute)
      Set the name of the RequestContext attribute for this view.

      Default is none (null).

    • getRequestContextAttribute

      public @Nullable String getRequestContextAttribute()
      Get the name of the RequestContext attribute for this view, if any.

    • setBeanName

      public void setBeanName(@Nullable String beanName)
      Set the view's name. Helpful for traceability.

      Framework code must call this when constructing views.

      Specified by:
      setBeanName in interface BeanNameAware
      Parameters:
      beanName - the name of the bean in the factory. Note that this name is the actual bean name used in the factory, which may differ from the originally specified name: in particular for inner bean names, the actual bean name might have been made unique through appending "#..." suffixes. Use the BeanFactoryUtils.originalBeanName(String) method to extract the original bean name (without suffix), if desired.

    • getBeanName

      public @Nullable String getBeanName()
      Get the view's name.

      Should never be null if the view was correctly configured.

    • setApplicationContext

      public void setApplicationContext(@Nullable ApplicationContext applicationContext)
      Description copied from interface: ApplicationContextAware
      Set the ApplicationContext that this object runs in. Normally this call will be used to initialize the object.

      Invoked after population of normal bean properties but before an init callback such as InitializingBean.afterPropertiesSet() or a custom init-method. Invoked after ResourceLoaderAware.setResourceLoader(ResourceLoader), ApplicationEventPublisherAware.setApplicationEventPublisher(ApplicationEventPublisher) and MessageSourceAware, if applicable.

      Specified by:
      setApplicationContext in interface ApplicationContextAware
      Parameters:
      applicationContext - the ApplicationContext object to be used by this object
      See Also:

    • getApplicationContext

      public @Nullable ApplicationContext getApplicationContext()

    • obtainApplicationContext

      protected final ApplicationContext obtainApplicationContext()
      Obtain the ApplicationContext for actual use.
      Returns:
      the ApplicationContext (never null)
      Throws:
      IllegalStateException - if the ApplicationContext cannot be obtained
      See Also:

    • render

      public reactor.core.publisher.Mono<Void> render(@Nullable Map<String,?> model, @Nullable MediaType contentType, ServerWebExchange exchange)
      Prepare the model to render.
      Specified by:
      render in interface View
      Parameters:
      model - a map with attribute names as keys and corresponding model objects as values (the map can also be null in case of an empty model)
      contentType - the content type selected to render with, which should match one of the supported media types
      exchange - the current exchange
      Returns:
      a Mono that represents when and if rendering succeeds

    • getModelAttributes

      protected reactor.core.publisher.Mono<Map<String,Object>> getModelAttributes(@Nullable Map<String,?> model, ServerWebExchange exchange)
      Prepare the model to use for rendering.

      The default implementation creates a combined output Map that includes model as well as static attributes with the former taking precedence.

    • resolveAsyncAttributes

      protected reactor.core.publisher.Mono<Void> resolveAsyncAttributes(Map<String,Object> model, ServerWebExchange exchange)
      Use the configured ReactiveAdapterRegistry to adapt asynchronous attributes to Mono<T> or Mono<List<T>> and then wait to resolve them into actual values. When the returned Mono<Void> completes, the asynchronous attributes in the model will have been replaced with their corresponding resolved values.
      Returns:
      result a Mono that completes when the model is ready
      Since:
      5.1.8

    • createRequestContext

      protected RequestContext createRequestContext(ServerWebExchange exchange, Map<String,Object> model)
      Create a RequestContext to expose under the specified attribute name.

      The default implementation creates a standard RequestContext instance for the given exchange and model.

      Can be overridden in subclasses to create custom instances.

      Parameters:
      exchange - the current exchange
      model - a combined output Map (never null), with dynamic values taking precedence over static attributes
      Returns:
      the RequestContext instance
      See Also:

    • getRequestDataValueProcessor

      protected @Nullable RequestDataValueProcessor getRequestDataValueProcessor()
      Get the RequestDataValueProcessor to use.

      The default implementation looks in the ApplicationContext for a RequestDataValueProcessor bean with the name REQUEST_DATA_VALUE_PROCESSOR_BEAN_NAME.

      Returns:
      the RequestDataValueProcessor, or null if there is none in the application context

    • renderInternal

      protected abstract reactor.core.publisher.Mono<Void> renderInternal(Map<String,Object> renderAttributes, @Nullable MediaType contentType, ServerWebExchange exchange)
      Subclasses must implement this method to actually render the view.
      Parameters:
      renderAttributes - combined output Map (never null), with dynamic values taking precedence over static attributes
      contentType - the content type selected to render with, which should match one of the supported media types
      exchange - current exchange
      Returns:
      a Mono that represents when and if rendering succeeds

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • formatViewName

      protected String formatViewName()