Java Doc for InternalResourceView.java in  » J2EE » spring-framework-2.0.6 » org » springframework » web » servlet » view » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » J2EE » spring framework 2.0.6 » org.springframework.web.servlet.view 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.springframework.web.servlet.view.AbstractView
   org.springframework.web.servlet.view.AbstractUrlBasedView
      org.springframework.web.servlet.view.InternalResourceView

All known Subclasses:   org.springframework.web.servlet.view.tiles.TilesView,  org.springframework.web.servlet.view.JstlView,
InternalResourceView
public class InternalResourceView extends AbstractUrlBasedView (Code)
Wrapper for a JSP or other resource within the same web application. Exposes model objects as request attributes and forwards the request to the specified resource URL using a 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 would look 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.
author:
   Rod Johnson
author:
   Juergen Hoeller
author:
   Rob Harrop
See Also:   javax.servlet.RequestDispatcher.forward
See Also:   javax.servlet.RequestDispatcher.include
See Also:   javax.servlet.ServletResponse.flushBuffer
See Also:   InternalResourceViewResolver



Constructor Summary
public  InternalResourceView()
     Constructor for use as a bean.
public  InternalResourceView(String url)
     Create a new InternalResourceView with the given URL.
public  InternalResourceView(String url, boolean alwaysInclude)
     Create a new InternalResourceView with the given URL.

Method Summary
protected  voidexposeForwardRequestAttributes(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.
protected  voidexposeHelpers(HttpServletRequest request)
     Expose helpers unique to each rendering operation.
protected  StringprepareForRendering(HttpServletRequest request, HttpServletResponse response)
     Prepare for rendering, and determine the request dispatcher path to forward to (or to include).
protected  voidrenderMergedOutputModel(Map model, HttpServletRequest request, HttpServletResponse response)
     Render the internal resource given the specified model.
public  voidsetAlwaysInclude(boolean alwaysInclude)
     Specify whether to always include the view rather than forward to it.

Default is "false".

protected  booleanuseInclude(HttpServletRequest request, HttpServletResponse response)
     Determine whether to use RequestDispatcher's include or forward method.


Constructor Detail
InternalResourceView
public InternalResourceView()(Code)
Constructor for use as a bean.
See Also:   InternalResourceView.setUrl
See Also:   InternalResourceView.setAlwaysInclude



InternalResourceView
public InternalResourceView(String url)(Code)
Create a new InternalResourceView with the given URL.
Parameters:
  url - the URL to forward to
See Also:   InternalResourceView.setAlwaysInclude



InternalResourceView
public InternalResourceView(String url, boolean alwaysInclude)(Code)
Create a new InternalResourceView with the given URL.
Parameters:
  url - the URL to forward to
Parameters:
  alwaysInclude - whether to always include the view rather than forward to it




Method Detail
exposeForwardRequestAttributes
protected void exposeForwardRequestAttributes(HttpServletRequest request)(Code)
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.

Does not override values if already present, to not conflict with Servlet 2.4+ containers.
See Also:   org.springframework.web.util.WebUtils.exposeForwardRequestAttributes




exposeHelpers
protected void exposeHelpers(HttpServletRequest request) throws Exception(Code)
Expose helpers unique to each rendering operation. This is necessary so that different rendering operations can't overwrite each other's contexts etc.

Called by InternalResourceView.renderMergedOutputModel(Map,HttpServletRequest,HttpServletResponse) . The default implementation is empty. This method can be overridden to add custom helpers as request attributes.
Parameters:
  request - current HTTP request
throws:
  Exception - if there's a fatal error while we're adding attributes
See Also:   InternalResourceView.renderMergedOutputModel
See Also:   JstlView.exposeHelpers
See Also:   org.springframework.web.servlet.view.tiles.TilesJstlView.exposeHelpers




prepareForRendering
protected String prepareForRendering(HttpServletRequest request, HttpServletResponse response) throws Exception(Code)
Prepare for rendering, and determine the request dispatcher path to forward to (or to include).

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.
Parameters:
  request - current HTTP request
Parameters:
  response - current HTTP response the request dispatcher path to use
throws:
  Exception - if preparations failed
See Also:   InternalResourceView.getUrl
See Also:   org.springframework.web.servlet.view.tiles.TilesView.prepareForRendering




renderMergedOutputModel
protected void renderMergedOutputModel(Map model, HttpServletRequest request, HttpServletResponse response) throws Exception(Code)
Render the internal resource given the specified model. This includes setting the model as request attributes.



setAlwaysInclude
public void setAlwaysInclude(boolean alwaysInclude)(Code)
Specify whether to always include the view rather than forward to it.

Default is "false". Switch this flag on to enforce the use of a Servlet include, even if a forward would be possible.
See Also:   javax.servlet.RequestDispatcher.forward
See Also:   javax.servlet.RequestDispatcher.include
See Also:   InternalResourceView.useInclude(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)




useInclude
protected boolean useInclude(HttpServletRequest request, HttpServletResponse response)(Code)
Determine whether to use RequestDispatcher's 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.
Parameters:
  request - current HTTP request
Parameters:
  response - current HTTP response true for include, false for forward
See Also:   javax.servlet.RequestDispatcher.forward
See Also:   javax.servlet.RequestDispatcher.include
See Also:   javax.servlet.ServletResponse.isCommitted
See Also:   org.springframework.web.util.WebUtils.isIncludeRequest




Methods inherited from org.springframework.web.servlet.view.AbstractUrlBasedView
public void afterPropertiesSet() throws Exception(Code)(Java Doc)
public String getUrl()(Code)(Java Doc)
public void setUrl(String url)(Code)(Java Doc)
public String toString()(Code)(Java Doc)

Fields inherited from org.springframework.web.servlet.view.AbstractView
final public static String DEFAULT_CONTENT_TYPE(Code)(Java Doc)

Methods inherited from org.springframework.web.servlet.view.AbstractView
public void addStaticAttribute(String name, Object value)(Code)(Java Doc)
protected RequestContext createRequestContext(HttpServletRequest request, Map model)(Code)(Java Doc)
protected void exposeModelAsRequestAttributes(Map model, HttpServletRequest request) throws Exception(Code)(Java Doc)
public Map getAttributesMap()(Code)(Java Doc)
public String getBeanName()(Code)(Java Doc)
public String getContentType()(Code)(Java Doc)
public String getRequestContextAttribute()(Code)(Java Doc)
public Map getStaticAttributes()(Code)(Java Doc)
public void render(Map model, HttpServletRequest request, HttpServletResponse response) throws Exception(Code)(Java Doc)
abstract protected void renderMergedOutputModel(Map model, HttpServletRequest request, HttpServletResponse response) throws Exception(Code)(Java Doc)
public void setAttributes(Properties attributes)(Code)(Java Doc)
public void setAttributesCSV(String propString) throws IllegalArgumentException(Code)(Java Doc)
public void setAttributesMap(Map attributes)(Code)(Java Doc)
public void setBeanName(String beanName)(Code)(Java Doc)
public void setContentType(String contentType)(Code)(Java Doc)
public void setRequestContextAttribute(String requestContextAttribute)(Code)(Java Doc)
public String toString()(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.