- 1 EclipseLink Architecture
- 1.1 Abstract
- 1.2 Code Version
- 1.3 Overview
- 1.4 Components
- 1.5 Interfaces
- 1.6 Data Structures
- 1.7 Algorithms
- 1.8 Tools
This document gives an overview of the EclipseLink architecture. It documents the components and functionality of the EclipseLink product. Its purpose is to give EclipseLink developers an overview and understanding of the EclipseLink architecture and how it evolved to where it is today. Its focus is from the internal technical perspective. This is NOT a user document.
EclipseLink was originally an object-relational mapping runtime. A class library that enables Java developers to map their business object model onto a relational database schema. EclipseLink provides object-level access to the objects stored in a relational database.
EclipseLink also provides EIS, object-relational data-type, XML, WebSevice, and SDO components. These components reuse at a minimum the mapping functionality of the core product.
EclipseLink provides a rich feature set to facilitate:
- Decoupling/flexibility of the object and data models
- Object level processing, data transparency
- High performance, scalability, concurrency
- Adherence to standards
EclipseLink was first developed through consulting engagements in the early 1990’s in the Smalltalk language. It was developed to meet the needs of object-oriented applications that needed to store and access their data from relational databases. Before its first release it was refactored through several client engagements. It basic design has not changed significantly from the initial release in that its architecture is object-oriented, non-intrusive, plugable and meta-model driven.
A rough timeline that includes the major enhancements and refactoring to the product architecture follows:
- The Object People
- TopLink Smalltalk 1.0 – Descriptors, Mappings, Session, Accessor (ODBC), Cache, Indirection (proxy), Expressions (arrays), reflection
- TopLink Smalltalk 2.0 – Expressions (block), TrackingUpdateManager (backup-clones), prototype of Builder UI
- TopLink Smalltalk 2.1 - UnitOfWork (edit originals, backup-clones track changes)
- TopLink Smalltalk 4.0 – QueryFramework, SessionBroker
- TopLink Java 1.0 – Descriptors, Mappings, Session, Accessor (JDBC), Cache, QueryFramework, Expressions (tree), UnitOfWork (edit clones), Builder UI (Smalltalk, INI meta-data), Indirection (value-holders), reflection
- TopLink 2.0 – ServerSession, Session API interfaces, RemoteSession, JTS, SessionBroker
- TopLink 2.5 – EJB-CMP 1.0
- TopLink 3.0 – Cache Synch, SDK, XML, Mapping Workbench UI (Java, XML meta-data), EJB-CMP 1.1, JDO
- TopLink 4.0 – WebGain package rename, CMP 2.0, EJB-QL, internationalization, code generation
- TopLink 9.0.3 – Oracle package rename
- TopLink 9.0.4 - Sequencing redesign, JDeveloper UI (+MW)
- TopLink 10.1.3 - JPA preview, EIS, XML (OX), JAXB 1.0, JDeveloper UI, RCM cache coordination, change tracking, weaving
- TopLink 11 - JPA 1.0, JPQL, JAXB 2.0, SDO, DBWS, Eclipse Dali UI (+MW, JDev)
- EclipseLink 1.0M1 - Eclipse package rename, open source
EclipseLink's design approach is object-oriented, non-intrusive, plugable and meta-model driven.
- Descriptor and mappings are EclipseLink's object model, there is a class for each type of mapping
- Query framework is querying object model, there is a class for each type of database interaction
- Avoid object model and data model requirements
- Abstract classes used for most functionality, allows easy extension through subclassing (mappings, queries, accessors, platforms, query mechanisms, sessions, transaction controllers)
- Mapping information is stored in XML or annotations and read in at runtime into a descriptor/mapping meta-model, instead of being used to generate functional code.
The main logical components of EclipseLink are:
- Core - Core descriptor and mapping functionality and generic data access.
- Relational - Relational descriptor and mappings, JDBC data access.
- OR data-type - Object-relational data-type descriptor and mappings.
- Oracle - Oracle database extensions.
- EIS - Enterprise Information Systems descriptor and mappings, JCA data access and adapters.
- XML - XML descriptor and mappings, XML data access.
- JAXB - Java API for XML Binding facade and schema processing.
- JPA - Java Persistence API facade and meta-data processing.
- SDO - Service Data Objects implementation.
- DBWS - Database web services processing.
The diagram shows a somewhat idealized representation of the components and their dependencies. This differs slightly from the component organization in Eclipse SVN, and the compile time dependencies. There are some dependencies between the components that require some of the components to be coupled together. Also some components are not significant enough to warrant they own SVN component.
The physical EclipseLink SVN repository components are:
- eclipselink.core - core component classes, relational mapping, OR data-type mapping, EIS mapping, XML mapping, weaving
- eclipselink.core.test - core component tests, native (POJO) API tests, EIS tests
- eclipselink.extension.oracle - oracle extensions, code with dependecies on Oracle jars
- eclipselink.extension.oracle.test - oracle extensions tests, tests with dependecies on Oracle jars
- eclipselink.util - package rename utility
- eclipselink.jpa - JPA implementation / fascade, meta-data processing
- eclipselink.jpa.test - JPA tests
- eclipselink.moxy - JAXB fascade and schema processing
- eclipselink.moxy.test - XML and JAXB tests
- eclipselink.sdo - SDO implementation
- eclipselink.sdo.test - SDO tests
- eclipselink.dbws - DBWS implementation
- eclipselink.dbws.test - DBWS tests
EclipseLink makes use of interfaces to define public API, and to define internal API for certain components. Abstract classes are also used in several places to define internal API. The usage of internal interfaces and abstract classes allows the architecture to be extensible and new functionality easily added.
- Session – session API
- DatabaseSession – 2-tier CRUD session API
- UnitOfWork – unit of work API
- SessionEventListener – event interface
- Record - data interface
- IdentityMapAccessor - cache API
- Server – server session API
- UnitOfWorkChangeSet, ObjectChangeSet, ChangeRecord – change sets API
- ValueHolderInterface – basic value holder interface
- DescriptorEventListener – event interface
- SequencingControl - sequencing API
- AttributeTransformer, FieldTransformer - transformation mapping conversion
- Converter - mapping conversion
- WrapperPolicy – used for EJB2 EntityBean remote/local un/wrapping of bean instance/reference
- OptimisticLockingPolicy – abstraction of locking policy
- Call – abstraction for SQL and non-relation data source interactions
- Accessor – abstraction for JDBC and non-relational data source access
- Connector – login abstraction for different methods of data source connection
- Login – abstraction of login for relational and non-relational sessions
- SessionProfiler – abstraction for performance monitoring
- ExternalTransactionController - abstraction of external (JTA) transaction integration
- CommandManager, CommandProcessor - abstraction of cache coordination
- ServerPlatform - abstraction of JEE container
- Platform - abstraction of data source specific behavoir
- StructConverter - abstraction of complex data type conversion
- SessionLog - abstraction of log
- ObjectChangePolicy - abstraction of change tracking
- AbstractSession – session behavior (query execution, caching)
- DatabaseMapping – mapping, cloning, comparing behavoir
- DatabaseQuery – data source interaction execution
- DatabaseQueryMechanism – allows queries to support different execution types (JPQL, expression, SQL, calls)
- Expression – SQL generation, normalization, tree walking
- IdentityMap – cache
- IndirectionPolicy – indirection manipulation
- DatabaseValueHolder - deferred instantiation
- ContainerPolicy – collection manipulation
- RemoteConnection – communication independent remote abstraction
- ChangeRecord – change merging
- AbstractTransactionController – abstraction of external (JTA) transaction integration
- AbstractSynchronizationListener - abstraction of external (JTA) transaction integration
- QueryKey – query alias representation
- AbstractRecord - data representation
- TransportManager - cache coordination transport
- Sequence - sequence id allocation
- DatasourcePlatform - data source platform behavoir
- AbstractSessionLog - logging
- IdentityMapAccessor - caching behavoir
- SQLStatement - SQL generation
- EclipseLinkException - exceptions
- CacheInvalidationPolicy - cache invalidation
- AbstractCopyPolicy - object copying
- DeferredChangeDetectionPolicy - object change tracking
- XMLPlatform - abstraction of XML parser
Core Data Structures
EclipseLink defines several object models describing the meta-data that it uses, and data it processes:
- Descriptor and mappings
- Change Sets