Class AbstractUrlBasedView

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.context.support.WebApplicationObjectSupport

org.springframework.web.servlet.view.AbstractView

org.springframework.web.servlet.view.AbstractUrlBasedView

All Implemented Interfaces:

Aware, BeanNameAware, InitializingBean, ApplicationContextAware, ServletContextAware, View

Direct Known Subclasses:

AbstractPdfStamperView, AbstractTemplateView, InternalResourceView, RedirectView, ScriptTemplateView, XsltView

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:

13.12.2003

Author:

Juergen Hoeller

Field Summary

Fields inherited from class AbstractView

DEFAULT_CONTENT_TYPE

Fields inherited from class ApplicationObjectSupport

logger

Fields inherited from interface View

PATH_VARIABLES, RESPONSE_STATUS_ATTRIBUTE, SELECTED_CONTENT_TYPE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()	Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, ApplicationContextAware etc.
boolean	checkResource(Locale locale)	Check whether the underlying resource that the configured URL points to actually exists.
@Nullable String	getUrl()	Return the URL of the resource that this view wraps.
protected boolean	isUrlRequired()	Return whether the 'url' property is required.
void	setUrl(@Nullable String url)	Set the URL of the resource that this view wraps.
String	toString()

Methods inherited from class AbstractView

addStaticAttribute, createMergedOutputModel, createRequestContext, createTemporaryOutputStream, exposeModelAsRequestAttributes, formatViewName, generatesDownloadContent, getAttributesMap, getBeanName, getContentType, getRequestContextAttribute, getRequestToExpose, getStaticAttributes, isExposePathVariables, prepareResponse, render, renderMergedOutputModel, setAttributes, setAttributesCSV, setAttributesMap, setBeanName, setContentType, setExposeContextBeansAsAttributes, setExposedContextBeanNames, setExposePathVariables, setRequestContextAttribute, setResponseContentType, writeToResponse

Methods inherited from class WebApplicationObjectSupport

getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

Methods inherited from class ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, initApplicationContext, obtainApplicationContext, requiredContextClass, setApplicationContext

Methods inherited from class Object

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

Constructor Details

AbstractUrlBasedView

protected AbstractUrlBasedView()

Constructor for use as a bean.

AbstractUrlBasedView

protected AbstractUrlBasedView(String url)

Create a new AbstractUrlBasedView with the given URL.

Parameters:

url - the URL to forward to

Method Details

setUrl

public void setUrl(@Nullable String url)

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

getUrl

public @Nullable String getUrl()

Return the URL of the resource that this view wraps.

afterPropertiesSet

public void afterPropertiesSet()
                        throws 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:

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

isUrlRequired

protected boolean isUrlRequired()

Return whether the 'url' property is required.

The default implementation returns true. This can be overridden in subclasses.

checkResource

public boolean checkResource(Locale locale)
                      throws Exception

Check whether the underlying resource that the configured URL points to actually exists.

Parameters:

locale - the desired Locale that we're looking for

Returns:

true if the resource exists (or is assumed to exist); false if we know that it does not exist

Throws:

Exception - if the resource exists but is invalid (for example, could not be parsed)

toString

public String toString()

Overrides:

toString in class AbstractView