Spring - Java/J2EE Application Framework

Reference Documentation

Rod Johnson

Juergen Hoeller

Alef Arendsen

Colin Sampaleanu

Rob Harrop

Thomas Risberg

Darren Davison

Dmitriy Kopylenko

Mark Pollack

Thierry Templier

Version 1.2.3

Copies of this document may be made for your own use and for distribution to others, provided that you do not charge any fee for such copies and further provided that each copy contains this Copyright Notice, whether distributed in print or electronically.

(Work in progress)

Table of Contents

1. Introduction
1.1. Overview
1.2. Usage scenarios
2. Background information
2.1. Inversion of Control / Dependency Injection
3. Beans, BeanFactory and the ApplicationContext
3.1. Introduction
3.2. BeanFactory and BeanDefinitions - the basics
3.2.1. The BeanFactory
3.2.2. The BeanDefinition
3.2.3. The bean class Bean creation via constructor Bean creation via static factory method Bean creation via instance factory method
3.2.4. The bean identifiers (id and name)
3.2.5. To singleton or not to singleton
3.3. Properties, collaborators, autowiring and dependency checking
3.3.1. Setting bean properties and collaborators
3.3.2. Constructor Argument Resolution Constructor Argument Type Matching Constructor Argument Index
3.3.3. Bean properties and constructor arguments detailed The value element The null element The collection elements Inner bean definitions via nested bean elements The idref element The ref element Value and Ref shortcut forms Compound property names
3.3.4. Method Injection Lookup method Injection Arbitrary method replacement
3.3.5. Using depends-on
3.3.6. Autowiring collaborators
3.3.7. Checking for dependencies
3.4. Customizing the nature of a bean
3.4.1. Lifecycle interfaces InitializingBean / init-method DisposableBean / destroy-method
3.4.2. Knowing who you are BeanFactoryAware BeanNameAware
3.4.3. FactoryBean
3.5. Abstract and child bean definitions
3.6. Interacting with the BeanFactory
3.6.1. Obtaining a FactoryBean, not its product
3.7. Customizing beans with BeanPostProcessors
3.8. Customizing bean factories with BeanFactoryPostProcessors
3.8.1. The PropertyPlaceholderConfigurer
3.8.2. The PropertyOverrideConfigurer
3.9. Registering additional custom PropertyEditors
3.10. Using the alias element to add aliases for existing beans
3.11. Introduction to the ApplicationContext
3.12. Added functionality of the ApplicationContext
3.12.1. Using the MessageSource
3.12.2. Propagating events
3.12.3. Using resources within Spring
3.13. Customized behavior in the ApplicationContext
3.13.1. ApplicationContextAware marker interface
3.13.2. The BeanPostProcessor
3.13.3. The BeanFactoryPostProcessor
3.13.4. The PropertyPlaceholderConfigurer
3.14. Registering additional custom PropertyEditors
3.15. Setting a bean property or constructor arg from a property expression
3.16. Setting a bean property or constructor arg from a field value
3.17. Invoking another method and optionally using the return value.
3.18. Importing Bean Definitions from One File Into Another
3.19. Creating an ApplicationContext from a web application
3.20. Glue code and the evil singleton
3.20.1. Using SingletonBeanFactoryLocator and ContextSingletonBeanFactoryLocator
4. PropertyEditors, data binding, validation and the BeanWrapper
4.1. Introduction
4.2. Binding data using the DataBinder
4.3. Bean manipulation and the BeanWrapper
4.3.1. Setting and getting basic and nested properties
4.3.2. Built-in PropertyEditors, converting types
4.3.3. Other features worth mentioning
5. Spring AOP: Aspect Oriented Programming with Spring
5.1. Concepts
5.1.1. AOP concepts
5.1.2. Spring AOP capabilities and goals
5.1.3. AOP Proxies in Spring
5.2. Pointcuts in Spring
5.2.1. Concepts
5.2.2. Operations on pointcuts
5.2.3. Convenience pointcut implementations Static pointcuts Dynamic pointcuts
5.2.4. Pointcut superclasses
5.2.5. Custom pointcuts
5.3. Advice types in Spring
5.3.1. Advice lifecycles
5.3.2. Advice types in Spring Interception around advice Before advice Throws advice After Returning advice Introduction advice
5.4. Advisors in Spring
5.5. Using the ProxyFactoryBean to create AOP proxies
5.5.1. Basics
5.5.2. JavaBean properties
5.5.3. Proxying interfaces
5.5.4. Proxying classes
5.5.5. Using 'global' advisors
5.6. Convenient proxy creation
5.6.1. TransactionProxyFactoryBean
5.6.2. EJB proxies
5.7. Concise proxy definitions
5.8. Creating AOP proxies programmatically with the ProxyFactory
5.9. Manipulating advised objects
5.10. Using the "autoproxy" facility
5.10.1. Autoproxy bean definitions BeanNameAutoProxyCreator DefaultAdvisorAutoProxyCreator AbstractAdvisorAutoProxyCreator
5.10.2. Using metadata-driven auto-proxying
5.11. Using TargetSources
5.11.1. Hot swappable target sources
5.11.2. Pooling target sources
5.11.3. Prototype target sources
5.11.4. ThreadLocal target sources
5.12. Defining new Advice types
5.13. Further reading and resources
6. AspectJ Integration
6.1. Overview
6.2. Configuring AspectJ aspects using Spring IoC
6.2.1. "Singleton" aspects Example Ordering issues
6.2.2. Non-singleton aspects
6.2.3. Gotchas
6.3. Using AspectJ pointcuts to target Spring advice
6.4. Spring aspects for AspectJ
7. Transaction management
7.1. The Spring transaction abstraction
7.2. Transaction strategies
7.3. Resource synchronization with transactions
7.3.1. High-level approach
7.3.2. Low-level approach
7.3.3. TransactionAwareDataSourceProxy
7.4. Programmatic transaction management
7.4.1. Using the TransactionTemplate
7.4.2. Using the PlatformTransactionManager
7.5. Declarative transaction management
7.5.1. Source Annotations for Transaction Demarcation The Transactional Annotation
7.5.2. BeanNameAutoProxyCreator, another declarative approach
7.5.3. AOP and Transactions
7.6. Choosing between programmatic and declarative transaction management
7.7. Do you need an application server for transaction management?
7.8. AppServer-specific integration
7.8.1. BEA WebLogic
7.8.2. IBM WebSphere
7.9. Common problems
7.9.1. Use of the wrong transaction manager for a specific DataSource
7.9.2. Spurious AppServer warnings about the transaction or DataSource no longer being active
8. Source Level Metadata Support
8.1. Source-level metadata
8.2. Spring's metadata support
8.3. Integration with Jakarta Commons Attributes
8.4. Metadata and Spring AOP autoproxying
8.4.1. Fundamentals
8.4.2. Declarative transaction management
8.4.3. Pooling
8.4.4. Custom metadata
8.5. Using attributes to minimize MVC web tier configuration
8.6. Other uses of metadata attributes
8.7. Adding support for additional metadata APIs
9. DAO support
9.1. Introduction
9.2. Consistent Exception Hierarchy
9.3. Consistent Abstract Classes for DAO Support
10. Data Access using JDBC
10.1. Introduction
10.2. Using the JDBC Core classes to control basic JDBC processing and error handling
10.2.1. JdbcTemplate
10.2.2. DataSource
10.2.3. SQLExceptionTranslator
10.2.4. Executing Statements
10.2.5. Running Queries
10.2.6. Updating the database
10.3. Controlling how we connect to the database
10.3.1. DataSourceUtils
10.3.2. SmartDataSource
10.3.3. AbstractDataSource
10.3.4. SingleConnectionDataSource
10.3.5. DriverManagerDataSource
10.3.6. TransactionAwareDataSourceProxy
10.3.7. DataSourceTransactionManager
10.4. Modeling JDBC operations as Java objects
10.4.1. SqlQuery
10.4.2. MappingSqlQuery
10.4.3. SqlUpdate
10.4.4. StoredProcedure
10.4.5. SqlFunction
11. Data Access using O/R Mappers
11.1. Introduction
11.2. Hibernate
11.2.1. Resource management
11.2.2. SessionFactory setup in a Spring application context
11.2.3. Inversion of Control: HibernateTemplate and HibernateCallback
11.2.4. Implementing Spring-based DAOs without callbacks
11.2.5. Implementing DAOs based on plain Hibernate3 API
11.2.6. Programmatic transaction demarcation
11.2.7. Declarative transaction demarcation
11.2.8. Transaction management strategies
11.2.9. Container resources versus local resources
11.2.10. Spurious AppServer warnings about the transaction or DataSource no longer being active
11.3. JDO
11.3.1. PersistenceManagerFactory setup
11.3.2. JdoTemplate and JdoDaoSupport
11.3.3. Implementing DAOs based on plain JDO API
11.3.4. Transaction management
11.3.5. JdoDialect
11.4. Oracle TopLink
11.4.1. SessionFactory abstraction
11.4.2. TopLinkTemplate and TopLinkDaoSupport
11.4.3. Implementing DAOs based on plain TopLink API
11.4.4. Transaction management
11.5. Apache OJB
11.5.1. OJB setup in a Spring environment
11.5.2. PersistenceBrokerTemplate and PersistenceBrokerDaoSupport
11.5.3. Transaction management
11.6. iBATIS SQL Maps
11.6.1. Overview and differences between iBATIS 1.x and 2.x
11.6.2. iBATIS SQL Maps 1.x Setting up the SqlMap Using SqlMapTemplate and SqlMapDaoSupport
11.6.3. iBATIS SQL Maps 2.x Setting up the SqlMapClient Using SqlMapClientTemplate and SqlMapClientDaoSupport Implementing DAOs based on plain iBATIS API
12. Web MVC framework
12.1. Introduction to the web MVC framework
12.1.1. Pluggability of other MVC implementations
12.1.2. Features of Spring MVC
12.2. The DispatcherServlet
12.3. Controllers
12.3.1. AbstractController and WebContentGenerator
12.3.2. Other simple controllers
12.3.3. The MultiActionController
12.3.4. CommandControllers
12.4. Handler mappings
12.4.1. BeanNameUrlHandlerMapping
12.4.2. SimpleUrlHandlerMapping
12.4.3. Adding HandlerInterceptors
12.5. Views and resolving them
12.5.1. ViewResolvers
12.5.2. Chaining ViewResolvers
12.6. Using locales
12.6.1. AcceptHeaderLocaleResolver
12.6.2. CookieLocaleResolver
12.6.3. SessionLocaleResolver
12.6.4. LocaleChangeInterceptor
12.7. Using themes
12.8. Spring's multipart (fileupload) support
12.8.1. Introduction
12.8.2. Using the MultipartResolver
12.8.3. Handling a fileupload in a form
12.9. Handling exceptions
13. Integrating view technologies
13.1. Introduction
13.2. JSP & JSTL
13.2.1. View resolvers
13.2.2. 'Plain-old' JSPs versus JSTL
13.2.3. Additional tags facilitating development
13.3. Tiles
13.3.1. Dependencies
13.3.2. How to integrate Tiles InternalResourceViewResolver ResourceBundleViewResolver
13.4. Velocity & FreeMarker
13.4.1. Dependencies
13.4.2. Context configuration
13.4.3. Creating templates
13.4.4. Advanced configuration velocity.properties FreeMarker
13.4.5. Bind support and form handling the bind macros simple binding form input generation macros overriding HTML escaping and making tags XHTML compliant
13.5. XSLT
13.5.1. My First Words Bean definitions Standard MVC controller code Convert the model data to XML Defining the view properties Document transformation
13.5.2. Summary
13.6. Document views (PDF/Excel)
13.6.1. Introduction
13.6.2. Configuration and setup Document view definitions Controller code Subclassing for Excel views Subclassing for PDF views
13.7. JasperReports
13.7.1. Dependencies
13.7.2. Configuration Configuring the ViewResolver Configuring the Views About Report Files Using JasperReportsMultiFormatView
13.7.3. Populating the ModelAndView
13.7.4. Working with Sub-Reports Configuring Sub-Report Files Configuring Sub-Report Data Sources
13.7.5. Configuring Exporter Parameters
14. Integrating with other web frameworks
14.1. Introduction
14.2. JavaServer Faces
14.2.1. DelegatingVariableResolver
14.2.2. FacesContextUtils
14.3. Struts
14.3.1. ContextLoaderPlugin DelegatingRequestProcessor DelegatingActionProxy
14.3.2. ActionSupport Classes
14.4. Tapestry
14.4.1. Architecture
14.4.2. Implementation Sample application context Obtaining beans in Tapestry pages Exposing the application context to Tapestry Component definition files Adding abstract accessors
14.4.3. Summary
14.5. WebWork
15. Remoting and web services using Spring
15.1. Introduction
15.2. Exposing services using RMI
15.2.1. Exporting the service using the RmiServiceExporter
15.2.2. Linking in the service at the client
15.3. Using Hessian or Burlap to remotely call services via HTTP
15.3.1. Wiring up the DispatcherServlet for Hessian
15.3.2. Exposing your beans by using the HessianServiceExporter
15.3.3. Linking in the service on the client
15.3.4. Using Burlap
15.3.5. Applying HTTP basic authentication to a service exposed through Hessian or Burlap
15.4. Exposing services using HTTP invokers
15.4.1. Exposing the service object
15.4.2. Linking in the service at the client
15.5. Web Services
15.5.1. Exposing services using JAX-RPC
15.5.2. Accessing Web Services
15.5.3. Register Bean Mappings
15.5.4. Registering our own Handler
15.5.5. Exposing web services using XFire
15.6. Auto-detection is not implemented for remote interfaces
15.7. Considerations when choosing a technology
16. Accessing and implementing EJBs
16.1. Accessing EJBs
16.1.1. Concepts
16.1.2. Accessing local SLSBs
16.1.3. Accessing remote SLSBs
16.2. Using Spring convenience EJB implementation classes
17. JMS
17.1. Introduction
17.2. Domain unification
17.3. JmsTemplate
17.3.1. ConnectionFactory
17.3.2. Transaction Management
17.3.3. Destination Management
17.4. Using the JmsTemplate
17.4.1. Sending a message
17.4.2. Synchronous Receiving
17.4.3. Using Message Converters
17.4.4. SessionCallback and ProducerCallback
18. JMX Support
18.1. Introduction
18.2. Exporting your Beans to JMX
18.2.1. Creating an MBeanServer
18.2.2. Lazy-Initialized MBeans
18.2.3. Automatic Registration of MBeans
18.3. Controlling the Management Interface of Your Beans
18.3.1. The MBeanInfoAssembler Interface
18.3.2. Using Source-Level Metadata
18.3.3. Using JDK 5.0 Annotations
18.3.4. Source Level Metadata Types
18.3.5. The AutodetectCapableMBeanInfoAssembler Interface
18.3.6. Defining Management Interfaces using Java Interfaces
18.3.7. Using MethodNameBasedMBeanInfoAssembler
18.4. Controlling the ObjectNames for your Beans
18.4.1. Reading ObjectNames from Properties
18.4.2. Using the MetadataNamingStrategy
18.5. Exporting your Beans with JSR-160 Connectors
18.5.1. Server-side Connectors
18.5.2. Client-side Connectors
18.5.3. JMX over Burlap/Hessian/SOAP
18.6. Accessing MBeans via Proxies
19.1. Introduction
19.2. Configuring CCI
19.2.1. Connector configuration
19.2.2. ConnectionFactory configuration in Spring
19.2.3. Configuring CCI connections
19.2.4. Using a single CCI connection
19.3. Using Spring's CCI access support
19.3.1. Record conversion
19.3.2. CciTemplate
19.3.3. DAO support
19.3.4. Automatic output record generation
19.3.5. Summary
19.3.6. Using a CCI Connection and Interaction directly
19.3.7. Example for CciTemplate usage
19.4. Modeling CCI access as operation objects
19.4.1. MappingRecordOperation
19.4.2. MappingCommAreaOperation
19.4.3. Automatic output record generation
19.4.4. Summary
19.4.5. Example for MappingRecordOperation usage
19.4.6. Example for MappingCommAreaOperation usage
19.5. Transactions
20. Sending Email with Spring mail abstraction layer
20.1. Introduction
20.2. Spring mail abstraction structure
20.3. Using Spring mail abstraction
20.3.1. Pluggable MailSender implementations
20.4. Using the JavaMail MimeMessageHelper
20.4.1. Creating a simple MimeMessage and sending it
20.4.2. Sending attachments and inline resources
21. Scheduling jobs using Quartz or Timer
21.1. Introduction
21.2. Using the OpenSymphony Quartz Scheduler
21.2.1. Using the JobDetailBean
21.2.2. Using the MethodInvokingJobDetailFactoryBean
21.2.3. Wiring up jobs using triggers and the SchedulerFactoryBean
21.3. Using JDK Timer support
21.3.1. Creating custom timers
21.3.2. Using the MethodInvokingTimerTaskFactoryBean
21.3.3. Wrapping up: setting up the tasks using the TimerFactoryBean
22. Testing
22.1. Unit testing
22.2. Integration testing
22.2.1. Context management and caching
22.2.2. Dependency Injection of test class instances
22.2.3. Transaction management
22.2.4. Convenience variables
22.2.5. Example
22.2.6. Running integration tests
A. spring-beans.dtd