Java Doc for OpenSessionInViewInterceptor.java in  » J2EE » spring-framework-2.5 » org » springframework » orm » hibernate3 » support » 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.5 » org.springframework.orm.hibernate3.support 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.springframework.orm.hibernate3.HibernateAccessor
      org.springframework.orm.hibernate3.support.OpenSessionInViewInterceptor

OpenSessionInViewInterceptor
public class OpenSessionInViewInterceptor extends HibernateAccessor implements WebRequestInterceptor(Code)
Spring web request interceptor that binds a Hibernate Session to the thread for the entire processing of the request.

This class is a concrete expression of the "Open Session in View" pattern, which is a pattern that allows for the lazy loading of associations in web views despite the original transactions already being completed.

This interceptor makes Hibernate Sessions available via the current thread, which will be autodetected by transaction managers. It is suitable for service layer transactions via org.springframework.orm.hibernate3.HibernateTransactionManager or org.springframework.transaction.jta.JtaTransactionManager as well as for non-transactional execution (if configured appropriately).

NOTE: This interceptor will by default not flush the Hibernate Session, with the flush mode being set to FlushMode.NEVER. It assumes that it will be used in combination with service layer transactions that handle the flushing: the active transaction manager will temporarily change the flush mode to FlushMode.AUTO during a read-write transaction, with the flush mode reset to FlushMode.NEVER at the end of each transaction. If you intend to use this interceptor without transactions, consider changing the default flush mode (through the OpenSessionInViewInterceptor.setFlushMode(int) "flushMode" property).

In contrast to OpenSessionInViewFilter , this interceptor is configured in a Spring application context and can thus take advantage of bean wiring. It inherits common Hibernate configuration properties from org.springframework.orm.hibernate3.HibernateAccessor , to be configured in a bean definition.

WARNING: Applying this interceptor to existing logic can cause issues that have not appeared before, through the use of a single Hibernate Session for the processing of an entire request. In particular, the reassociation of persistent objects with a Hibernate Session has to occur at the very beginning of request processing, to avoid clashes with already loaded instances of the same objects.

Alternatively, turn this interceptor into deferred close mode, by specifying "singleSession"="false": It will not use a single session per request then, but rather let each data access operation or transaction use its own session (as would be the case without Open Session in View). Each of those sessions will be registered for deferred close though, which will actually be processed at request completion.

A single session per request allows for the most efficient first-level caching, but can cause side effects, for example on saveOrUpdate or when continuing after a rolled-back transaction. The deferred close strategy is as safe as no Open Session in View in that respect, while still allowing for lazy loading in views (but not providing a first-level cache for the entire request).
author:
   Juergen Hoeller
since:
   1.2
See Also:   OpenSessionInViewInterceptor.setSingleSession
See Also:   OpenSessionInViewInterceptor.setFlushMode
See Also:   OpenSessionInViewFilter
See Also:   org.springframework.orm.hibernate3.HibernateInterceptor
See Also:   org.springframework.orm.hibernate3.HibernateTransactionManager
See Also:   org.springframework.orm.hibernate3.SessionFactoryUtils.getSession
See Also:   org.springframework.transaction.support.TransactionSynchronizationManager



Field Summary
final public static  StringPARTICIPATE_SUFFIX
     Suffix that gets appended to the SessionFactory toString() representation for the "participate in existing session handling" request attribute.

Constructor Summary
public  OpenSessionInViewInterceptor()
     Create a new OpenSessionInViewInterceptor, turning the default flushMode to FLUSH_NEVER.

Method Summary
public  voidafterCompletion(WebRequest request, Exception ex)
     Unbind the Hibernate Session from the thread and close it (in single session mode), or process deferred close for all sessions that have been opened during the current request (in deferred close mode).
protected  StringgetParticipateAttributeName()
     Return the name of the request attribute that identifies that a request is already intercepted.
protected  booleanisSingleSession()
     Return whether to use a single session for each request.
public  voidpostHandle(WebRequest request, ModelMap model)
     Flush the Hibernate Session before view rendering, if necessary.
public  voidpreHandle(WebRequest request)
     Open a new Hibernate Session according to the settings of this HibernateAccessor and bind it to the thread via the TransactionSynchronizationManager .
public  voidsetSingleSession(boolean singleSession)
     Set whether to use a single session for each request.

Field Detail
PARTICIPATE_SUFFIX
final public static String PARTICIPATE_SUFFIX(Code)
Suffix that gets appended to the SessionFactory toString() representation for the "participate in existing session handling" request attribute.
See Also:   OpenSessionInViewInterceptor.getParticipateAttributeName




Constructor Detail
OpenSessionInViewInterceptor
public OpenSessionInViewInterceptor()(Code)
Create a new OpenSessionInViewInterceptor, turning the default flushMode to FLUSH_NEVER.
See Also:   OpenSessionInViewInterceptor.setFlushMode




Method Detail
afterCompletion
public void afterCompletion(WebRequest request, Exception ex) throws DataAccessException(Code)
Unbind the Hibernate Session from the thread and close it (in single session mode), or process deferred close for all sessions that have been opened during the current request (in deferred close mode).
See Also:   org.springframework.transaction.support.TransactionSynchronizationManager



getParticipateAttributeName
protected String getParticipateAttributeName()(Code)
Return the name of the request attribute that identifies that a request is already intercepted.

The default implementation takes the toString() representation of the SessionFactory instance and appends OpenSessionInViewInterceptor.PARTICIPATE_SUFFIX .




isSingleSession
protected boolean isSingleSession()(Code)
Return whether to use a single session for each request.



postHandle
public void postHandle(WebRequest request, ModelMap model) throws DataAccessException(Code)
Flush the Hibernate Session before view rendering, if necessary.

Note that this just applies in OpenSessionInViewInterceptor.isSingleSession() single session mode !

The default is FLUSH_NEVER to avoid this extra flushing, assuming that service layer transactions have flushed their changes on commit.
See Also:   OpenSessionInViewInterceptor.setFlushMode




preHandle
public void preHandle(WebRequest request) throws DataAccessException(Code)
Open a new Hibernate Session according to the settings of this HibernateAccessor and bind it to the thread via the TransactionSynchronizationManager .
See Also:   org.springframework.orm.hibernate3.SessionFactoryUtils.getSession



setSingleSession
public void setSingleSession(boolean singleSession)(Code)
Set whether to use a single session for each request. Default is "true".

If set to false, each data access operation or transaction will use its own session (like without Open Session in View). Each of those sessions will be registered for deferred close, though, actually processed at request completion.
See Also:   SessionFactoryUtils.initDeferredClose
See Also:   SessionFactoryUtils.processDeferredClose




Fields inherited from org.springframework.orm.hibernate3.HibernateAccessor
final public static int FLUSH_ALWAYS(Code)(Java Doc)
final public static int FLUSH_AUTO(Code)(Java Doc)
final public static int FLUSH_COMMIT(Code)(Java Doc)
final public static int FLUSH_EAGER(Code)(Java Doc)
final public static int FLUSH_NEVER(Code)(Java Doc)
final protected Log logger(Code)(Java Doc)

Methods inherited from org.springframework.orm.hibernate3.HibernateAccessor
public void afterPropertiesSet()(Code)(Java Doc)
protected FlushMode applyFlushMode(Session session, boolean existingTransaction)(Code)(Java Doc)
public DataAccessException convertHibernateAccessException(HibernateException ex)(Code)(Java Doc)
protected DataAccessException convertJdbcAccessException(JDBCException ex, SQLExceptionTranslator translator)(Code)(Java Doc)
protected DataAccessException convertJdbcAccessException(SQLException ex)(Code)(Java Doc)
protected void disableFilters(Session session)(Code)(Java Doc)
protected void enableFilters(Session session)(Code)(Java Doc)
protected void flushIfNecessary(Session session, boolean existingTransaction) throws HibernateException(Code)(Java Doc)
protected synchronized SQLExceptionTranslator getDefaultJdbcExceptionTranslator()(Code)(Java Doc)
public Interceptor getEntityInterceptor() throws IllegalStateException, BeansException(Code)(Java Doc)
public String[] getFilterNames()(Code)(Java Doc)
public int getFlushMode()(Code)(Java Doc)
public SQLExceptionTranslator getJdbcExceptionTranslator()(Code)(Java Doc)
public SessionFactory getSessionFactory()(Code)(Java Doc)
public void setBeanFactory(BeanFactory beanFactory)(Code)(Java Doc)
public void setEntityInterceptor(Interceptor entityInterceptor)(Code)(Java Doc)
public void setEntityInterceptorBeanName(String entityInterceptorBeanName)(Code)(Java Doc)
public void setFilterName(String filter)(Code)(Java Doc)
public void setFilterNames(String[] filterNames)(Code)(Java Doc)
public void setFlushMode(int flushMode)(Code)(Java Doc)
public void setFlushModeName(String constantName)(Code)(Java Doc)
public void setJdbcExceptionTranslator(SQLExceptionTranslator jdbcExceptionTranslator)(Code)(Java Doc)
public void setSessionFactory(SessionFactory sessionFactory)(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(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.