org.springframework.web.reactive.result.view

Class AbstractUrlBasedView

java.lang.Object

org.springframework.web.reactive.result.view.AbstractView

org.springframework.web.reactive.result.view.AbstractUrlBasedView

All Implemented Interfaces:

Aware, InitializingBean, ApplicationContextAware, View

Direct Known Subclasses:

FreeMarkerView, RedirectView, ScriptTemplateView

public abstract class AbstractUrlBasedView
extends AbstractView
implements InitializingBean

Abstract base class for URL-based views. Provides a consistent way of holding the URL that a View wraps, in the form of a "url" bean property.

Since:

5.0

Author:

Rossen Stoyanchev

Field Summary

Fields inherited from class org.springframework.web.reactive.result.view.AbstractView

logger, REQUEST_DATA_VALUE_PROCESSOR_BEAN_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractUrlBasedView() Constructor for use as a bean.
protected	AbstractUrlBasedView(java.lang.String url) Create a new AbstractUrlBasedView with the given URL.

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet() Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, ApplicationContextAware etc.
abstract boolean	checkResourceExists(java.util.Locale locale) Check whether the resource for the configured URL actually exists.
java.lang.String	getUrl() Return the URL of the resource that this view wraps.
void	setUrl(java.lang.String url) Set the URL of the resource that this view wraps.
java.lang.String	toString()

Methods inherited from class org.springframework.web.reactive.result.view.AbstractView

createRequestContext, getApplicationContext, getDefaultCharset, getModelAttributes, getRequestContextAttribute, getRequestDataValueProcessor, getSupportedMediaTypes, obtainApplicationContext, render, renderInternal, resolveAsyncAttributes, setApplicationContext, setDefaultCharset, setRequestContextAttribute, setSupportedMediaTypes

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.web.reactive.result.view.View

isRedirectView

Constructor Detail

AbstractUrlBasedView

protected AbstractUrlBasedView()

Constructor for use as a bean.

AbstractUrlBasedView

protected AbstractUrlBasedView(java.lang.String url)

Create a new AbstractUrlBasedView with the given URL.

Method Detail

setUrl

public void setUrl(@Nullable
                   java.lang.String url)

Set the URL of the resource that this view wraps. The URL must be appropriate for the concrete View implementation.

getUrl

@Nullable
public java.lang.String getUrl()

Return the URL of the resource that this view wraps.

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.Exception

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

Throws:

java.lang.Exception - in the event of misconfiguration (such as failure to set an essential property) or if initialization fails for any other reason

checkResourceExists

public abstract boolean checkResourceExists(java.util.Locale locale)
                                     throws java.lang.Exception

Check whether the resource for the configured URL actually exists.

Parameters:

locale - the desired Locale that we're looking for

Returns:

false if the resource exists false if we know that it does not exist

Throws:

java.lang.Exception - if the resource exists but is invalid (e.g. could not be parsed)

toString

public java.lang.String toString()

Overrides:

toString in class AbstractView