public class InternalResourceView extends AbstractUrlBasedView
javax.servlet.RequestDispatcher
.
A URL for this view is supposed to specify a resource within the web
application, suitable for RequestDispatcher's forward
or
include
method.
If operating within an already included request or within a response that
has already been committed, this view will fall back to an include instead of
a forward. This can be enforced by calling response.flushBuffer()
(which will commit the response) before rendering the view.
Typical usage with InternalResourceViewResolver
looks as follows,
from the perspective of the DispatcherServlet context definition:
<bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver"> <property name="prefix" value="/WEB-INF/jsp/"/> <property name="suffix" value=".jsp"/> </bean>Every view name returned from a handler will be translated to a JSP resource (for example: "myView" -> "/WEB-INF/jsp/myView.jsp"), using this view class by default.
javax.servlet.RequestDispatcher#forward
,
javax.servlet.RequestDispatcher#include
,
javax.servlet.ServletResponse#flushBuffer
,
InternalResourceViewResolver
,
JstlView
Modifier and Type | Field and Description |
---|---|
private boolean |
alwaysInclude |
private boolean |
exposeContextBeansAsAttributes |
private java.util.Set<java.lang.String> |
exposedContextBeanNames |
private java.lang.Boolean |
exposeForwardAttributes |
private boolean |
preventDispatchLoop |
DEFAULT_CONTENT_TYPE
logger
PATH_VARIABLES, RESPONSE_STATUS_ATTRIBUTE, SELECTED_CONTENT_TYPE
Constructor and Description |
---|
InternalResourceView()
Constructor for use as a bean.
|
InternalResourceView(java.lang.String url)
Create a new InternalResourceView with the given URL.
|
InternalResourceView(java.lang.String url,
boolean alwaysInclude)
Create a new InternalResourceView with the given URL.
|
Modifier and Type | Method and Description |
---|---|
protected void |
exposeForwardRequestAttributes(HttpServletRequest request)
Expose the current request URI and paths as
HttpServletRequest
attributes under the keys defined in the Servlet 2.4 specification,
for Servlet 2.3 containers as well as misbehaving Servlet 2.4 containers
(such as OC4J). |
protected void |
exposeHelpers(HttpServletRequest request)
Expose helpers unique to each rendering operation.
|
protected RequestDispatcher |
getRequestDispatcher(HttpServletRequest request,
java.lang.String path)
Obtain the RequestDispatcher to use for the forward/include.
|
protected HttpServletRequest |
getRequestToExpose(HttpServletRequest originalRequest)
Get the request handle to expose to the RequestDispatcher, i.e.
|
protected void |
initServletContext(ServletContext sc)
Checks whether we need to explicitly expose the Servlet 2.4 request attributes
by default.
|
protected boolean |
isContextRequired()
An ApplicationContext is not strictly required for InternalResourceView.
|
protected java.lang.String |
prepareForRendering(HttpServletRequest request,
HttpServletResponse response)
Prepare for rendering, and determine the request dispatcher path
to forward to (or to include).
|
protected void |
renderMergedOutputModel(java.util.Map<java.lang.String,java.lang.Object> model,
HttpServletRequest request,
HttpServletResponse response)
Render the internal resource given the specified model.
|
void |
setAlwaysInclude(boolean alwaysInclude)
Specify whether to always include the view rather than forward to it.
|
void |
setExposeContextBeansAsAttributes(boolean exposeContextBeansAsAttributes)
Set whether to make all Spring beans in the application context accessible
as request attributes, through lazy checking once an attribute gets accessed.
|
void |
setExposedContextBeanNames(java.lang.String[] exposedContextBeanNames)
Specify the names of beans in the context which are supposed to be exposed.
|
void |
setExposeForwardAttributes(boolean exposeForwardAttributes)
Set whether to explictly expose the Servlet 2.4 forward request attributes
when forwarding to the underlying view resource.
|
void |
setPreventDispatchLoop(boolean preventDispatchLoop)
Set whether to explicitly prevent dispatching back to the
current handler path.
|
protected boolean |
useInclude(HttpServletRequest request,
HttpServletResponse response)
Determine whether to use RequestDispatcher's
include or
forward method. |
afterPropertiesSet, checkResource, getUrl, isUrlRequired, setUrl, toString
addStaticAttribute, createMergedOutputModel, createRequestContext, createTemporaryOutputStream, exposeModelAsRequestAttributes, generatesDownloadContent, getAttributesMap, getBeanName, getContentType, getRequestContextAttribute, getStaticAttributes, isExposePathVariables, prepareResponse, render, setAttributes, setAttributesCSV, setAttributesMap, setBeanName, setContentType, setExposePathVariables, setRequestContextAttribute, setResponseContentType, writeToResponse
getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, setServletContext
getApplicationContext, getMessageSourceAccessor, initApplicationContext, requiredContextClass, setApplicationContext
private boolean alwaysInclude
private volatile java.lang.Boolean exposeForwardAttributes
private boolean exposeContextBeansAsAttributes
private java.util.Set<java.lang.String> exposedContextBeanNames
private boolean preventDispatchLoop
public InternalResourceView()
public InternalResourceView(java.lang.String url)
url
- the URL to forward tosetAlwaysInclude(boolean)
public InternalResourceView(java.lang.String url, boolean alwaysInclude)
url
- the URL to forward toalwaysInclude
- whether to always include the view rather than forward to itpublic void setAlwaysInclude(boolean alwaysInclude)
Default is "false". Switch this flag on to enforce the use of a Servlet include, even if a forward would be possible.
javax.servlet.RequestDispatcher#forward
,
javax.servlet.RequestDispatcher#include
,
#useInclude(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
public void setExposeForwardAttributes(boolean exposeForwardAttributes)
Default is "true" on Servlet containers up until 2.4, and "false" for Servlet 2.5 and above. Note that Servlet containers at 2.4 level and above should expose those attributes automatically! This InternalResourceView feature exists for Servlet 2.3 containers and misbehaving 2.4 containers.
public void setExposeContextBeansAsAttributes(boolean exposeContextBeansAsAttributes)
This will make all such beans accessible in plain ${...}
expressions in a JSP 2.0 page, as well as in JSTL's c:out
value expressions.
Default is "false". Switch this flag on to transparently expose all Spring beans in the request attribute namespace.
NOTE: Context beans will override any custom request or session attributes of the same name that have been manually added. However, model attributes (as explicitly exposed to this view) of the same name will always override context beans.
public void setExposedContextBeanNames(java.lang.String[] exposedContextBeanNames)
If you'd like to expose all Spring beans in the application context, switch
the "exposeContextBeansAsAttributes"
flag on but do not list specific bean names for this property.
public void setPreventDispatchLoop(boolean preventDispatchLoop)
Default is "false". Switch this to "true" for convention-based views where a dispatch back to the current handler path is a definitive error.
protected boolean isContextRequired()
isContextRequired
in class WebApplicationObjectSupport
ApplicationObjectSupport.getApplicationContext()
,
ApplicationObjectSupport.getMessageSourceAccessor()
,
WebApplicationObjectSupport.getWebApplicationContext()
,
WebApplicationObjectSupport.getServletContext()
,
WebApplicationObjectSupport.getTempDir()
protected void initServletContext(ServletContext sc)
initServletContext
in class WebApplicationObjectSupport
sc
- the ServletContext that this application object runs in
(never null
)setExposeForwardAttributes(boolean)
,
#exposeForwardRequestAttributes(javax.servlet.http.HttpServletRequest)
protected void renderMergedOutputModel(java.util.Map<java.lang.String,java.lang.Object> model, HttpServletRequest request, HttpServletResponse response) throws java.lang.Exception
renderMergedOutputModel
in class AbstractView
model
- combined output Map (never null
),
with dynamic values taking precedence over static attributesrequest
- current HTTP requestresponse
- current HTTP responsejava.lang.Exception
- if rendering failedprotected HttpServletRequest getRequestToExpose(HttpServletRequest originalRequest)
The default implementation wraps the original request for exposure of Spring beans as request attributes (if demanded).
originalRequest
- the original servlet request as provided by the enginesetExposeContextBeansAsAttributes(boolean)
,
ContextExposingHttpServletRequest
protected void exposeHelpers(HttpServletRequest request) throws java.lang.Exception
Called by renderMergedOutputModel(Map, HttpServletRequest, HttpServletResponse)
.
The default implementation is empty. This method can be overridden to add
custom helpers as request attributes.
request
- current HTTP requestjava.lang.Exception
- if there's a fatal error while we're adding attributesrenderMergedOutputModel(java.util.Map<java.lang.String, java.lang.Object>, HttpServletRequest, HttpServletResponse)
,
JstlView.exposeHelpers(HttpServletRequest)
protected java.lang.String prepareForRendering(HttpServletRequest request, HttpServletResponse response) throws java.lang.Exception
This implementation simply returns the configured URL. Subclasses can override this to determine a resource to render, typically interpreting the URL in a different manner.
request
- current HTTP requestresponse
- current HTTP responsejava.lang.Exception
- if preparations failedAbstractUrlBasedView.getUrl()
protected RequestDispatcher getRequestDispatcher(HttpServletRequest request, java.lang.String path)
The default implementation simply calls
HttpServletRequest#getRequestDispatcher(String)
.
Can be overridden in subclasses.
request
- current HTTP requestpath
- the target URL (as returned from prepareForRendering(HttpServletRequest, HttpServletResponse)
)protected boolean useInclude(HttpServletRequest request, HttpServletResponse response)
include
or
forward
method.
Performs a check whether an include URI attribute is found in the request, indicating an include request, and whether the response has already been committed. In both cases, an include will be performed, as a forward is not possible anymore.
request
- current HTTP requestresponse
- current HTTP responsetrue
for include, false
for forwardjavax.servlet.RequestDispatcher#forward
,
javax.servlet.RequestDispatcher#include
,
javax.servlet.ServletResponse#isCommitted
,
WebUtils.isIncludeRequest(ServletRequest)
protected void exposeForwardRequestAttributes(HttpServletRequest request)
HttpServletRequest
attributes under the keys defined in the Servlet 2.4 specification,
for Servlet 2.3 containers as well as misbehaving Servlet 2.4 containers
(such as OC4J).
Does not expose the attributes on Servlet 2.5 or above, mainly for GlassFish compatibility (GlassFish gets confused by pre-exposed attributes). In any case, Servlet 2.5 containers should finally properly support Servlet 2.4 features, shouldn't they...
request
- current HTTP requestWebUtils.exposeForwardRequestAttributes(HttpServletRequest)