synopse mormot framework sad 1.17.pdf

Synopse mORMot Framework Software Architecture Design 1.17 Date: September 9, 2012

Software Architecture Design - Rev. 1.17 Page 1 of 835

PROJECT DOCUMENTATION

Project Name: Synopse mORMot Framework

Document Name: Software Architecture Design

Document Revision: 1.17

Date: September 9, 2012

Project Manager: Arnaud Bouchez

Document License

THE ATTACHED DOCUMENTS DESCRIBE INFORMATION RELEASED BY SYNOPSE INFORMATIQUE UNDER A GPL 3.0 LICENSE.

Synopse SQLite3/mORMot Framework Documentation. Copyright (C) 2008-2012 Arnaud Bouchez. Synopse Informatique - http://synopse.info..

This document is free document; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

The Synopse mORMot Framework Documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this documentation. If not, see http://www.gnu.org/licenses..

Trademark Notice

Rather than indicating every occurrence of a trademarked name as such, this document uses the names only in an editorial fashion and to the benefit of the trademark owner with no intention of infringement of the trademark.

Prepared by: Title: Signature: Date

Arnaud Bouchez Project Manager



Document Purpose

The Software Architecture Design document purpose is to describe the implications of each software requirement specification on all the affected software modules for the Synopse mORMot Framework project.

The current revision of this document is 1.17.

Related Documents

Name Description Rev. Date

SDD Software Design Document 1.17 September 9, 2012

SWRS Software Requirements Specifications 1.17 September 9, 2012

DI Design Input Product Specifications 1.17 September 9, 2012



TTaabbllee ooff CCoonntteennttss

Introduction

Purpose 28

Document layout 28

First part: global Software architecture 29

Second part: SWRS implications 29

Responsibilities 29

GNU General Public License 29

1. Global Architecture

1.1. Synopse mORMot Framework Overview 41

1.1.1. Highlights 42

1.1.2. mORMot 42

1.2. Architecture principles 44

1.2.1. Model-View-Controller 44

1.2.2. Multi-tier architecture 45

1.2.3. Service-oriented architecture 45

1.2.4. Object-relational mapping 46

1.2.5. Domain-Driven design 47

1.3. General design 50

1.3.1. SQLite3-powered, not SQLite3-limited 50

1.3.2. Client-Server ORM/SOA architecture 50

1.4. mORMot Framework 53



1.4.1. Object-Relational Mapping 53

1.4.1.1. TSQLRecord fields definition 53

1.4.1.1.1. Text fields 55

1.4.1.1.2. Date and time fields 55

1.4.1.1.3. Enumeration fields 56

1.4.1.1.4. Floating point and Currency fields 56

1.4.1.1.5. Record fields 57

1.4.1.2. Working with Objects 57

1.4.1.3. Queries 58

1.4.1.3.1. Return a list of objects 58

1.4.1.3.2. Query parameters 58

1.4.1.3.3. Introducing TSQLTableJSON 59

1.4.1.3.4. Note about query parameters 60

1.4.1.4. Objects relationship: cardinality 62

1.4.1.4.1. "One to one" or "One to many" 62

1.4.1.4.2. "Has many" and "has many through" 63

1.4.1.4.2.1. Shared nothing architecture (or sharding) 64

1.4.1.4.2.1.1. Arrays, TPersistent, TCollection, TMyClass

65

1.4.1.4.2.1.2. Dynamic arrays fields 66

1.4.1.4.2.1.3. Dynamic arrays from Delphi Code 66

1.4.1.4.2.1.4. Dynamic arrays from SQL code 67

1.4.1.4.2.1.5. TPersistent/TCollection fields 68

1.4.1.4.2.1.6. Custom TObject JSON serialization 71

1.4.1.4.2.2. ORM implementation via pivot table 73

1.4.1.4.2.2.1. Introducing TSQLRecordMany 73

1.4.1.4.2.2.2. Automatic JOIN query 76

1.4.1.5. Calculated fields 78

1.4.1.5.1. Setter for TSQLRecord 78

1.4.1.5.2. TSQLRecord.ComputeFieldsBeforeWrite 79

1.4.1.6. Daily ORM 80



1.4.1.6.1. ORM is not DB 81

1.4.1.6.2. Objects, not tables 81

1.4.1.6.3. Methods, not SQL 81

1.4.1.6.4. Think multi-tier 83

1.4.1.7. ORM Cache 84

1.4.1.8. MVC pattern 84

1.4.1.8.1. Creating a Model 84

1.4.1.8.2. Filtering and Validating 85

1.4.1.8.3. Views 87

1.4.1.8.3.1. RTTI 87

1.4.1.8.3.2. User Interface 89

1.4.1.9. One ORM to rule them all 89

1.4.1.9.1. Rude class definition 89

1.4.1.9.2. Several ORMs at once 90

1.4.1.9.3. The best ORM is the one you need 91

1.4.2. Database layer 92

1.4.2.1. SQLite3-powered, not SQLite3-limited 92

1.4.2.1.1. SQLite3 as core 92

1.4.2.1.2. Extended by SQLite3 virtual tables 93

1.4.2.1.3. Data access benchmark 93

1.4.2.2. SQLite3 implementation 96

1.4.2.2.1. Prepared statement 96

1.4.2.2.2. R-Tree inclusion 98

1.4.2.2.3. FTS3/FTS4 98

1.4.2.2.3.1. Dedicated FTS3/FTS4 record type 99

1.4.2.2.3.2. Stemming 100

1.4.2.2.3.3. FTS searches 101

1.4.2.2.4. NULL handling 102

1.4.2.2.5. ACID and speed 102

1.4.2.3. Virtual Tables magic 103

1.4.2.3.1. Virtual Table module classes 104



1.4.2.3.2. Defining a Virtual Table module 105

1.4.2.3.3. Using a Virtual Table module 107

1.4.2.3.4. Virtual Table, ORM and TSQLRecord 108

1.4.2.3.5. In-Memory "static" process 109

1.4.2.3.5.1. In-Memory tables 109

1.4.2.3.5.2. In-Memory virtual tables 110

1.4.2.3.6. Virtual Tables to access external databases 112

1.4.2.4. External database access 112

1.4.2.4.1. Database agnosticism 112

1.4.2.4.1.1. Direct access to any Database engine 113

1.4.2.4.1.2. Data types 114

1.4.2.4.1.3. SynDB Units 114

1.4.2.4.1.4. Classes and generic use 114

1.4.2.4.1.5. ISQLDBRows interface 116

1.4.2.4.1.6. Late binding 117

1.4.2.4.2. Database access 118

1.4.2.4.2.1. OleDB or ODBC to rule them all 118

1.4.2.4.2.2. Oracle via OCI 119

1.4.2.4.2.3. SQLite3 120

1.4.2.4.3. ORM Integration 120

1.4.2.4.3.1. Transparent use 120

1.4.2.4.3.2. Behind the scene 122

1.4.3. Client-Server 125

1.4.3.1. Involved technologies 125

1.4.3.1.1. JSON 125

1.4.3.1.1.1. Why use JSON? 125

1.4.3.1.1.2. JSON format density 125

1.4.3.1.1.3. JSON format layouts 126

1.4.3.1.1.4. JSON global cache 126

1.4.3.1.2. REST 127

1.4.3.1.2.1. RESTful implementation 127



1.4.3.1.2.2. REST and BLOB fields 128

1.4.3.1.2.3. REST and JSON 128

1.4.3.1.2.4. REST is Stateless 129

1.4.3.1.2.4.1. Server side synchronization 129

1.4.3.1.2.4.2. Client side synchronization 129

1.4.3.1.3. Interfaces 130

1.4.3.1.3.1. Delphi and interfaces 130

1.4.3.1.3.1.1. Declaring an interface 130

1.4.3.1.3.1.2. Implementing an interface with a class 131

1.4.3.1.3.1.3. Using an interface 132

1.4.3.1.3.1.4. There is more than one way to do it 133

1.4.3.1.3.1.5. Here comes the magic 133

1.4.3.1.3.2. SOLID design principles 133

1.4.3.1.3.2.1. Single responsibility principle 134

1.4.3.1.3.2.2. Open/closed principle 135

1.4.3.1.3.2.3. Liskov substitution principle 136

1.4.3.1.3.2.4. Interface segregation principle 137

1.4.3.1.3.2.5. Dependency Inversion Principle 137

1.4.3.1.3.3. Circular reference and (zeroing) weak pointers

137

1.4.3.1.3.3.1. Weak pointers 137

1.4.3.1.3.3.2. Handling weak pointers 139

1.4.3.1.3.3.3. Zeroing weak pointers 139

1.4.3.1.3.3.4. Weak pointers functions implementation details

140

1.4.3.2. Client-Server implementation 141

1.4.3.2.1. Implementation design 141

1.4.3.2.2. Client-Server classes 147

1.4.3.2.3. HTTP client 148

1.4.3.2.4. HTTP server using http.sys 149

1.4.3.2.4.1. Presentation 149



1.4.3.2.4.2. UAC and Vista/Seven support 150

1.4.3.2.5. BATCH sequences for adding/updating/deleting records

151

1.4.3.2.5.1. BATCH process 151

1.4.3.2.5.2. Implementation details 153

1.4.3.2.5.3. Array binding 154

1.4.3.2.6. CRUD level cache 155

1.4.3.2.6.1. Where to cache 156

1.4.3.2.6.2. When to cache 157

1.4.3.2.6.3. What to cache 157

1.4.3.2.6.4. How to cache 157

1.4.3.2.7. Server side process (aka stored procedure) 158

1.4.3.2.7.1. Custom SQL functions 159

1.4.3.2.7.1.1. Implementing a function 159

1.4.3.2.7.1.2. Registering a function 160

1.4.3.2.7.1.3. Direct low-level SQLite3 registration 160

1.4.3.2.7.1.4. Class-driven registration 160

1.4.3.2.7.1.5. Custom class definition 161

1.4.3.2.7.2. Low-level Delphi stored procedure 163

1.4.3.2.7.3. External stored procedure 163

1.4.3.3. Client-Server services 163

1.4.3.3.1. Client-Server services via methods 163

1.4.3.3.1.1. My Server is rich 164

1.4.3.3.1.2. The Client is always right 165

1.4.3.3.2. Interface based services 167

1.4.3.3.2.1. Implemented features 167

1.4.3.3.2.2. How to make services 168

1.4.3.3.2.3. Defining a data contract 168

1.4.3.3.2.3.1. Define an interface 169

1.4.3.3.2.3.2. Available types for methods parameters

170



1.4.3.3.2.3.3. Custom JSON serialization of records 171

1.4.3.3.2.3.4. TInterfacedCollection kind of parameter

172

1.4.3.3.2.4. Server side 173

1.4.3.3.2.4.1. Implementing service contract 173

1.4.3.3.2.4.2. Set up the Server factory 174

1.4.3.3.2.4.3. Instances life time implementation 174

1.4.3.3.2.4.4. Using services on the Server side 177

1.4.3.3.2.5. Client side 178

1.4.3.3.2.5.1. Set up the Client factory 178

1.4.3.3.2.5.2. Using services on the Client side 178

1.4.3.3.2.6. Sample code 179

1.4.3.3.2.6.1. The shared contract 179

1.4.3.3.2.6.2. The server sample application 179

1.4.3.3.2.6.3. The client sample application 181

1.4.3.3.2.7. Implementation details 181

1.4.3.3.2.7.1. Involved classes 181

1.4.3.3.2.7.2. Security 182

1.4.3.3.2.7.3. Transmission content 184

1.4.3.3.2.7.4. Request format 184

1.4.3.3.2.7.5. Response format 185

1.4.3.3.2.7.6. Standard answer as JSON object 185

1.4.3.3.2.7.7. Custom returned content 187

1.4.3.3.2.8. Hosting services 188

1.4.3.3.2.8.1. Shared server 188

1.4.3.3.2.8.2. Two servers 189

1.4.3.3.2.8.3. Two instances on the same server 190

1.4.3.3.2.9. Comparison with WCF 191

1.4.4. Security and Testing 194

1.4.4.1. Security 194

1.4.4.1.1. Per-table access rights 194



1.4.4.1.2. SQL statements safety 194

1.4.4.1.3. Authentication 195

1.4.4.1.3.1. Principles 195

1.4.4.1.3.2. HTTP basic auth over HTTPS 195

1.4.4.1.3.3. Session via Cookies 196

1.4.4.1.3.4. Query Authentication 196

1.4.4.1.4. Framework authentication 196

1.4.4.1.4.1. Per-User authentication 197

1.4.4.1.4.2. Session handling 198

1.4.4.1.4.3. Client interactivity 199

1.4.4.1.4.4. URI signature 199

1.4.4.1.4.5. Authentication using AJAX 200

1.4.4.2. Testing 200

1.4.4.2.1. Thread-safety 200

1.4.4.2.2. Automated testing 201

1.4.4.2.2.1. Involved classes in Unitary testing 201

1.4.4.2.2.2. First steps in testing 202

1.4.4.2.2.3. Implemented tests 204

1.4.4.2.3. Logging 204

1.4.5. Source code 206

1.4.5.1. License 206

1.4.5.2. Availability 206

1.4.5.2.1. Obtaining the Source Code 207

1.4.5.2.2. Expected compilation platform 207

1.4.5.2.3. Note about sqlite3*.obj files 207

1.4.5.2.4. Folder layout 208

1.4.5.3. Installation 210

1.4.6. SynCommons unit 211

1.4.6.1. Unicode and UTF-8 211

1.4.6.2. Currency handling 212

1.4.6.3. Dynamic array wrapper 212



1.4.6.3.1. TList-like properties 213

1.4.6.3.2. Enhanced features 214

1.4.6.3.3. Capacity handling via an external Count 214

1.4.6.3.4. JSON serialization 215

1.4.6.3.4.1. TDynArray JSON features 215

1.4.6.3.4.2. Custom JSON serialization of dynamic arrays

216

1.4.6.3.5. Daily use 217

1.4.6.4. Enhanced logging 219

1.4.6.4.1. Using logging 219

1.4.6.4.2. Including symbol definitions 220

1.4.6.4.3. Exception handling 221

1.4.6.4.3.1. Intercepting exceptions 221

1.4.6.4.3.2. One patch to rule them all 222

1.4.6.4.4. Serialization 224

1.4.6.4.5. Family matters 224

1.4.6.4.6. Automated log archival 225

1.4.6.4.7. Log Viewer 225

1.4.6.4.7.1. Open log files 225

1.4.6.4.7.2. Log browser 226

1.4.6.4.7.3. Customer-side profiler 226

1.4.7. Source code implementation 227

1.4.7.1. mORMot Framework used Units 227

1.4.7.2. SynCommons unit 229

1.4.7.3. SynCrtSock unit 369

1.4.7.4. SynCrypto unit 383

1.4.7.5. SynDB unit 395

1.4.7.6. SynDBODBC unit 428

1.4.7.7. SynDBOracle unit 432

1.4.7.8. SynGdiPlus unit 438

1.4.7.9. SynLZ unit 445



1.4.7.10. SynLZO unit 447

1.4.7.11. SynOleDB unit 447

1.4.7.12. SynPdf unit 459

1.4.7.13. SynSelfTests unit 500

1.4.7.14. SynSQLite3 unit 502

1.4.7.15. SynTaskDialog unit 553

1.4.7.16. SynWinSock unit 559

1.4.7.17. SynZip unit 560

1.4.7.18. SQLite3 unit 567

1.4.7.19. SQLite3Commons unit 575

1.4.7.20. SQLite3HttpClient unit 731

1.4.7.21. SQLite3HttpServer unit 733

1.4.7.22. SQLite3i18n unit 736

1.4.7.23. SQLite3Pages unit 745

1.4.7.24. SQLite3SelfTests unit 760

1.4.7.25. SQLite3Service unit 761

1.4.7.26. SQLite3ToolBar unit 768

1.4.7.27. SQLite3UI unit 781

1.4.7.28. SQLite3UIEdit unit 790

1.4.7.29. SQLite3UILogin unit 793

1.4.7.30. SQLite3UIOptions unit 796

1.4.7.31. SQLite3UIQuery unit 798

1.5. Main SynFile Demo 799

1.5.1. SynFile application 799

1.5.2. General architecture 799

1.5.3. Database design 800

1.5.4. User Interface generation 804

1.5.4.1. Rendering 804

1.5.4.2. Enumeration types 807

1.5.4.3. ORM Registration 807



1.5.4.4. Report generation 808

1.5.4.5. Application i18n and L10n 811

1.5.4.5.1. Creating the reference file 811

1.5.4.5.2. Adding a new language 813

1.5.4.5.3. Language selection 813

1.5.4.5.4. Localization 814

1.5.5. Source code implementation 814

1.5.5.1. Main SynFile Demo used Units 814

1.5.5.2. FileClient unit 816

1.5.5.3. FileEdit unit 818

1.5.5.4. FileMain unit 820

1.5.5.5. FileServer unit 821

1.5.5.6. FileTables unit 822

2. SWRS implications

Software Architecture Design Reference Table 827

2.1. Client Server JSON framework 828

2.1.1. SWRS # DI-2.1.1 828

2.1.2. SWRS # DI-2.1.1.1 828

2.1.3. SWRS # DI-2.1.1.2.1 829

2.1.4. SWRS # DI-2.1.1.2.2 829

2.1.5. SWRS # DI-2.1.1.2.3 829

2.1.6. SWRS # DI-2.1.1.2.4 830

2.1.7. SWRS # DI-2.1.2 830

2.1.8. SWRS # DI-2.1.3 831

2.2. SQlite3 engine 832

2.2.1. SWRS # DI-2.2.1 832

2.2.2. SWRS # DI-2.2.2 833

2.3. User interface 833

2.3.1. SWRS # DI-2.3.1.1 833

2.3.2. SWRS # DI-2.3.1.2 834



2.3.3. SWRS # DI-2.3.1.3 834

2.3.4. SWRS # DI-2.3.2 835



Pictures Reference Table The following table is a quick-reference guide to all the Pictures referenced in this Software Architecture Design (SAD) document.

Pictures Page

Client-Server implementation - Client side 142

Client-Server implementation - Server side 142

Client-Server implementation - Server side 146

Client-Server implementation - Server side with Virtual Tables 144

Client-Server implementation - Stand-Alone application 143

Client-Server implementation - Server side with "static" Virtual Tables 145

BATCH mode Client-Server latency 152

BATCH mode latency issue on external DB 155

HTTP/1.1 Client architecture 148

HTTP/1.1 Client RESTful classes 148

Client-Server RESTful classes 147

AuditTrail Record Layout 803

AuthGroup Record Layout 197

AuthUser Record Layout 197

Data Record Layout 802

Memo Record Layout 802

SafeData Record Layout 803

SafeMemo Record Layout 802

Design Inputs, FMEA and Risk Specifications 28

FTS3/FTS4 ORM classes 100

External Databases classes hierarchy 123

SynFile TSQLRecord classes hierarchy 801

HTTP Server classes hierarchy 150

Services implementation classes hierarchy 181

TSQLDataBaseSQLFunction classes hierarchy 161



Pictures Page

TSQLDBConnection classes hierarchy 116

TSQLDBConnectionProperties classes hierarchy 116

TSQLDBStatement classes hierarchy 116

Custom Virtual Tables records classes hierarchy 108

TSQLRestClient classes hierarchy 128

Virtual Tables classes hierarchy 104

Filtering and Validation classes hierarchy 86

Default filters and Validation classes hierarchy 86

TSynTest classes hierarchy 202

FileClient class hierarchy 817

FileEdit class hierarchy 819

FileMain class hierarchy 821

FileServer class hierarchy 822

FileTables class hierarchy 823

SQLite3 class hierarchy 568

SQLite3Commons class hierarchy 577

SQLite3HttpClient class hierarchy 731

SQLite3HttpServer class hierarchy 734

SQLite3i18n class hierarchy 737

SQLite3Pages class hierarchy 746

SQLite3Service class hierarchy 762

SQLite3ToolBar class hierarchy 769

SQLite3UI class hierarchy 782

SQLite3UIEdit class hierarchy 791

SQLite3UILogin class hierarchy 794

SQLite3UIOptions class hierarchy 797

SQLite3UIQuery class hierarchy 798

SynCommons class hierarchy 231



Pictures Page

SynCrtSock class hierarchy 370

SynCrypto class hierarchy 384

SynDB class hierarchy 395

SynDBODBC class hierarchy 429

SynDBOracle class hierarchy 433

SynGdiPlus class hierarchy 438

SynOleDB class hierarchy 448

SynPdf class hierarchy 461

SynSelfTests class hierarchy 501

SynSQLite3 class hierarchy 503

SynTaskDialog class hierarchy 554

SynZip class hierarchy 560

CRUD caching in mORMot 156

N-Layered Domain-Oriented Architecture of mORMot 48

Alternate Domain-Oriented Architecture of mORMot 48

General mORMot architecture - Client / Server 50

General mORMot architecture - Stand-alone application 51

General mORMot architecture - Client Server implementation 52

Service Hosting on mORMot - shared server 189

Service Hosting on mORMot - two servers 190

Service Hosting on mORMot - one server, two instances 191

Model View Controller concept 44

Oracle Connectivity with SynDBOracle 119

Unit dependencies in the "Lib\SQLite3" directory 229

Unit dependencies in the "Lib" directory 228

Unit dependencies in the "Lib\SQLite3\Samples\MainDemo" directory 816

Unit dependencies in the "Lib\SQLite3" directory 815

Unit dependencies in the "Lib" directory 814



Pictures Page

User Interface generated using TMS components 806

User Interface generated using VCL components 806



Source code File Names Reference Table The following table is a quick-reference guide to all the Source code File Names referenced in this Software Architecture Design (SAD) document.

Others - Source Reference Table

Source code File Names Page

Lib\SQLite3\Samples\MainDemo\FileClient.pas 800, 808

Lib\SQLite3\Samples\MainDemo\FileEdit.pas 800

Lib\SQLite3\Samples\MainDemo\FileMain.pas 130, 812

Lib\SQLite3\Samples\MainDemo\FileServer.pas 800

Lib\SQLite3\Samples\MainDemo\FileTables.pas 800

Lib\SQLite3\SQLite3Commons.pas 104, 204

Lib\SQLite3\SQLite3i18n.pas 807

Lib\SQLite3\SQLite3Pages.pas 808

Lib\SQLite3\SQLite3UIEdit.pas 804

Lib\SynCommons.pas 201, 211

Lib\SynCrypto.pas 800

Lib\SynGdiPlus.pas 800, 810

Lib\SynSQLite3.pas 218



Keywords Reference Table The following table is a quick-reference guide to all the Keywords referenced in this Software Architecture Design (SAD) document.

.

.msg 811

6

64 bit 113, 120, 149, 207

A

ACID 91, 94, 102

AJAX 41, 42, 44, 45, 66, 80, 93, 102, 125, 126, 128, 150, 165, 167, 168, 169,

170, 185, 186, 187, 200, 207, 804

ARC 138

Array bind 96, 120, 154

Atomic 111, 194

ATTACH DATABASE 109, 109

Authentication 92, 165, 168, 182, 184, 194, 195

B

Backup 103

BATCH 70, 109, 151

Benchmark 93, 155

BinToBase64WithMagic 59

BLOB 55, 65, 66, 67, 92, 98, 125, 128, 166, 215, 800, 800

Business rules 42

C

Cache 41, 49, 84, 96, 126, 150, 201



Camel 88, 88, 204, 807

Cardinality 62, 64

Client-Server 41, 42, 45, 47, 53, 70, 80, 83, 84, 92, 92, 109, 109, 127, 128, 129, 135,

135, 137, 137, 141, 147, 151, 158, 195, 196, 226

Contract 163

CQRS 91

CreateAndFillPrepare 58, 82

CRUD 44, 57, 84, 87, 90, 111, 127, 144, 153, 156, 194, 197, 198

Currency 54, 56, 67, 68, 114, 211, 212, 215

D

DateTimeToSQL 59

DateToSQL 59

DMZ 188

Domain Values 90

Domain-Driven 41, 42, 44, 45, 47, 65, 90, 177

DTO 90

Dynamic array 55, 56, 57, 60, 65, 65, 65, 66, 67, 78, 81, 81, 125, 159, 159, 211, 212,

224

E

Enumerated 54, 88, 136, 220

Event Sourcing 193

Event-Sourcing 90

F

Factory 137

Filtering 85

FTS 92, 99, 99, 100, 101, 104

G



Gateway 169, 193

General Public License 29, 206

GUID 131

H

Has many through 64, 73

Has many 64

Hosting 42, 48, 174, 188

HTTP 41, 42, 45, 80, 126, 127, 128, 129, 129, 141, 147, 148, 149, 152, 154,

166, 195, 197, 208

HTTPS 195, 195, 200

I

I18n 41, 55, 88, 89, 210, 211, 807, 810, 811

IntegerDynArrayContains 66, 68, 159

Interface 42, 46, 130, 134, 136, 137, 137, 137

ISO 8601 54, 56, 92, 92

Iso8601ToSQL 59

J

JavaScript 45, 45, 80, 102, 125, 126, 195, 200, 207

JOIN 76

JSON

41, 42, 45, 45, 55, 57, 58, 59, 65, 71, 71, 80, 81, 84, 93, 102, 104, 113,

118, 120, 125, 125, 126, 126, 128, 150, 152, 163, 170, 171, 184, 204, 211, 213, 215, 224, 800

L

L10n 811

Lazy Loading 64

Lesser General Public License

206



License 135, 206

Log 116, 211, 219, 221, 224, 804

M

Map/reduce 155

Master/Detail 62, 65, 66, 78, 81, 81

Mozilla Public License 206

MS SQL 41, 45, 50, 112, 113, 115, 118, 121, 122, 124

MVC 41, 44, 84, 85, 88, 804

O

ODBC 41, 42, 50, 93, 96, 112, 114, 118, 209

OleDB 41, 42, 50, 93, 96, 112, 114, 118, 209

One to many 62, 62

One to one 62, 62

OOP 79, 113, 133, 135, 801

Oracle 41, 42, 45, 50, 93, 96, 112, 114, 118, 119, 123, 209

ORM

41, 42, 45, 46, 46, 53, 54, 58, 61, 64, 65, 65, 73, 77, 77, 80, 81, 81, 81, 82, 83, 84, 88, 89, 96, 97, 98, 101, 101, 104, 106, 108, 108, 109,

110, 112, 120, 134, 136, 137, 158, 163, 163, 166, 167, 168, 186, 189, 200, 204, 208, 209, 212, 213, 216, 799, 800, 800, 804, 808

P

Pdf 42, 112, 209, 800, 808

Prepared 60, 66, 83, 84, 96, 113, 218

Published method 158, 163, 201

Published properties 53, 54, 62, 65, 73, 80, 81, 92, 98, 105, 110, 121, 128, 213, 800, 801

Q

Query Authentication 194, 195, 196, 196, 199



Quotes 60, 60, 97

R

RawUTF8 54, 55, 60, 68, 70, 76, 83, 97, 101, 114, 170, 211, 215, 218

RDBMS 62, 65

Record 170, 171, 216

Reference-counted 132

RegisterCustomJSONSerializer

171, 215, 216

RegisterCustomSerializer 55, 66, 71, 170, 224

Report 42

Resourcestring 810, 811

REST

41, 42, 44, 45, 45, 45, 53, 57, 78, 80, 83, 84, 90, 109, 110, 112, 124,

125, 127, 127, 128, 128, 129, 129, 130, 141, 147, 150, 151, 156, 158, 163, 167, 191, 195, 196, 200, 204, 800, 804

RTREE 92, 98, 104

RTTI 45, 53, 57, 57, 60, 87, 212, 213, 224, 800, 804, 807, 807, 811

S

Security 41, 42, 88, 92, 167, 182, 187, 188, 194, 204

Serialization 42, 46, 68, 71, 125, 170, 171, 187, 213, 215

Server time stamp 79

Service 44, 45, 45, 68, 78, 83, 127, 147, 163, 800

Session 41, 70, 158, 165, 175, 194, 194, 195, 196, 196, 196, 198, 199, 204

SftBlob 59

Sharding 64, 65

Shared nothing architecture 65

SOA 41, 42, 45, 45, 90, 137, 137, 138, 167, 168, 191, 195, 216

SOAP 133, 167, 169, 191, 193

SOLID 48, 133, 169



SQL function 68, 68, 68, 84, 98, 102, 158, 159

SQL 41, 42, 45, 46, 53, 53, 58, 60, 61, 67, 69, 80, 80, 80, 81, 83, 84, 88, 88,

92, 92, 92, 96, 98, 101, 102, 103, 126, 126, 126, 204, 226

SQLite3 41, 45, 50, 53, 53, 55, 60, 68, 85, 88, 93, 96, 99, 102, 103, 105, 107,

109, 110, 111, 112, 114, 114, 120, 125, 126, 150, 158, 159, 194, 201, 204, 205, 207, 209, 209, 211, 215

Stateless 44, 44, 129, 129, 130, 130, 137, 196, 201

Statement 84

Static 104, 109, 109, 110, 145

Stored procedure 68, 80, 84, 158

Strong type 80, 88, 88, 90, 194

SynDB 55, 93, 96, 113, 114, 118, 119, 120, 122, 134, 204, 209

SynDBExplorer 113, 204

SynLZ 104, 150, 154, 208

T

TCollection 55, 65, 65, 66, 68, 81, 81, 169, 170, 213, 224

TCreateTime 55, 59, 79, 92

TDateTime 54, 56, 59

TDynArrayHashed 113

Test 41, 44, 66, 68, 69, 74, 101, 136, 152, 201, 205, 209, 210, 210, 211,

219

Text Search 42

Thread-safe 92, 194, 200

Tier 41, 41, 42, 44, 45

TInterfacedCollection 169, 170, 170

TModTime 55, 59, 79, 92

TObject 55, 66, 71, 170

TPersistent 55, 65, 66, 68, 81, 81, 165, 170, 224, 801

Transaction 69, 74, 75, 111, 127, 129, 152, 193, 199



TServiceCustomAnswer 169, 170, 187

TSQLModel 44, 53, 81, 81, 84, 87, 109, 110, 150, 151, 197, 800, 803

TSQLRecord 44, 53, 54, 57, 59, 60, 62, 64, 65, 65, 66, 68, 68, 70, 73, 77, 78, 79, 81, 81, 81, 84, 86, 87, 90, 90, 98, 101, 105, 108, 109, 110, 112, 121, 129,

134, 135, 163, 165, 170, 186, 211, 215, 224, 800, 801, 803, 808

TSQLRecordMany 55, 64, 64, 65, 68, 73, 76, 81

TSQLRecordMappedAutoID 90

TSQLRecordMappedForcedID

90

TSQLRecordVirtual 90

TSQLRest 55, 60, 80, 85, 96, 128, 128, 147, 803

TSQLRestClientDB 110, 142, 147, 194

TSQLRestServerDB 98, 110, 120, 126, 142, 147, 160, 163, 164, 174, 180, 201

TSQLRestServerFullMemory 93, 147, 164, 174, 180

TSQLRestServerRemoteDB 147, 190

TSQLRestServerStaticInMemory

85, 90, 91, 104, 106, 109, 109, 110, 111, 201

TSQLTableJSON 58, 59, 60, 129

TSQLVirtualTableBinary 104, 104, 109

TSQLVirtualTableJSON 104, 104, 109

TStrings 55, 65, 66, 81, 81

TTimeLog 55, 59, 92, 810

U

UTF-8 54, 55, 92, 101, 125, 202, 211, 211, 215

V

Validation 85

Virtual Table 42, 50, 98, 99, 103, 104, 105, 108, 109, 110, 112, 112, 122, 143

VirtualTableExternalRegister

90, 112, 122



W

WCF 41, 163, 191

Weak pointers 138

WideString 170

Z

Zeroing Weak pointers 138



IInnttrroodduuccttiioonn

The whole Software documentation process follows the typical steps of this diagram:

UserRequirements

Design Inputs(DI)

define

Specifications(SWRS)

are specified by

RegulatoryRequirements

Architecture + Design(SAD+SDD)

is implemented by

System-wideRisk Assessment

SW FMEA(RK)

defines

Test + Documentation

is associated to

refers to

Design Inputs, FMEA and Risk Specifications

Purpose This Software Architecture Design (SAD) document applies to the 1.17 release of the Synopse mORMot Framework library.

It summarizes the implications of every software features detailed in the Software Design Document (SDD) document.

Document layout

In a first part, this document presents the global Software architecture involved in this



implementation, i.e.:

- mORMot Framework (page 53) - Main SynFile Demo (page 799)

A second part then describes every Software Requirements Specifications (SWRS) document item, according to the Design Input Product Specifications (DI) document main sections:

- Client Server JSON framework (page 828) - SQlite3 engine (page 832) - User interface (page 833)

First part: global Software architecture

All the source code architecture of the library is deeply analyzed. After a global introduction, each source code unit is detailed, with clear diagrams and tables showing the dependencies between the units, and the class hierarchy of the objects implemented within.

The main sections of this architecture description are the following:

- Architecture principles - see below (page 44); - General design - see below (page 50); - ORM and MVC - see below (page 53); - Database layer - see below (page 92); - Client-Server - see below (page 125); - Security and testing - see below (page 194); - Source code - see below (page 206); - The SynCommons unit - see below (page 211); - Followed by the per-unit description of every defined class or type; - SynFile main demo - see below (page 799).

Second part: SWRS implications

For each SWRS item, links are made to the units sections of the first part, referring directly to the unit, class or function involved with the Software Design Document (SDD) document.

Responsibilities - Synopse will try to correct any identified issue; - The Open Source community will create tickets in a public Tracker web site located at

http://synopse.info/fossil.. ; - Synopse work on the framework is distributed without any warranty, according to the chosen

license terms - see below (page 206); - This documentation is released under the GPL (GNU General Public License) terms, without any

warranty of any kind.

GNU General Public License GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007

Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.



Preamble

The GNU General Public License is a free, copyleft license for software and other kinds of works.

The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too.

When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.

To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others.

For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.

Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it.

For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions.

Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users.

Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free.

The precise terms and conditions for copying, distribution and modification follow.



TERMS AND CONDITIONS

0. Definitions.

"This License" refers to version 3 of the GNU General Public License.

"Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.

"The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations.

To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work.

A "covered work" means either the unmodified Program or a work based on the Program.

To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.

To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.

An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.

1. Source Code.

The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work.

A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.

The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system



(if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.

The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work.

The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.

The Corresponding Source for a work in source code form is that same work.

2. Basic Permissions.

All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.

You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.

Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.

3. Protecting Users' Legal Rights From Anti-Circumvention Law.

No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.

When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures.



4. Conveying Verbatim Copies.

You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.

You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.

5. Conveying Modified Source Versions.

You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:

a) The work must carry prominent notices stating that you modified it, and giving a relevant date.

b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices".

c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it.

d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so.

A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.

6. Conveying Non-Source Forms.

You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:

a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange.



b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge.

c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b.

d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements.

e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d.

A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.

A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.

"Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.

If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as



part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).

The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.

Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.

7. Additional Terms.

"Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.

When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.

Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:

a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or

b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or

c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or

d) Limiting the use for publicity purposes of names of licensors or authors of the material; or

e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or



f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors.

All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.

If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.

Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.

8. Termination.

You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).

However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.

Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.

Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.

9. Acceptance Not Required for Having Copies.

You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.



10. Automatic Licensing of Downstream Recipients.

Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.

An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.

You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.

11. Patents.

A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version".

A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.

Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.

In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.

If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have



actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.

If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.

A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.

Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.

12. No Surrender of Others' Freedom.

If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.

13. Use with the GNU Affero General Public License.

Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such.

14. Revised Versions of this License.

The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.

Each version is given a distinguishing version number. If the



Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation.

If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program.

Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.

15. Disclaimer of Warranty.

THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

16. Limitation of Liability.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

17. Interpretation of Sections 15 and 16.

If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.

END OF TERMS AND CONDITIONS

How to Apply These Terms to Your New Programs

If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.

To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found.


SAD - Global Architecture - Rev. 1.17 Page 41 of 835

11.. GGlloobbaall AArrcchhiitteeccttuurree

1.1. Synopse mORMot Framework Overview Synopse mORMot is a Client-Server ORM and Service Oriented Architecture framework (SOA) for Delphi 6 up to XE2.

It provides an Open Source self-sufficient set of units (even Delphi starter edition is enough) for creating any Multi-tier application, up to the most complex Domain-Driven design - see below (page 47):

- Presentation layer featuring MVC UI generation with i18n and reporting for rich Delphi clients, or rich AJAX clients;

- Application layer implementing Service Oriented Architecture via interface-based services (like WCF) and Client-Server ORM - following a RESTful model using JSON over several communication protocols (including HTTP/1.1);

- Domain Model layer handling all the needed business logic in plain Delphi objects, including high-level managed types like dynamic arrays or records for Value Objects, or dedicated classes for entities or aggregates;

- Data persistence infrastructure layer with ORM persistence over Oracle, MS SQL, OleDB, ODBC with a powerful SQLite3 kernel, and direct SQL access if needed;

- Cross-Cutting infrastructure layers for handling data filtering and validation, security, session, cache, logging and testing (framework uses test-driven approach).

If you do not know some of those concepts, don't worry: this document will detail them - see below (page 44).

The main two features of mORMot shine at the application layer:

- Client-Server ORM: objects persistence and remote access; - Client-Server Services: remote call of high-level data process.

With mORMot, ORM is not used only for data persistence of objects in databases (like in other implementations), but as part of a global n-Tier, Service Oriented Architecture, ready to implement Domain-Driven solutions. This really makes the difference.

The business logic of your applications will be easily exposed as Services, and will be accessible from light clients (written in Delphi or any other mean, including AJAX).

The framework Core is non-visual: it provides only a set of classes to be used from code. But you have also some UI units available (including screen auto-creation, reporting and ribbon GUI), and you can



use it from any RAD or AJAX clients.

No dependency is needed at the client level (no DB driver, nor third-party runtime): it is able to connect via standard HTTP, even through a corporate proxy or a VPN. Rich Delphi clients can be deployed just by copying and running a stand-alone small executable, with no installation process. Speed and scalability has been implemented from the ground up - see below (page 93): a single server is able to handle a lot of clients, and our rich SOA architecture is able to implement both vertical and horizontal scalable hosting.

In short, with mORMot, your ROI is maximized.

1.1.1. Highlights

At first, some points can be highlighted, which make this framework distinct to other available solutions:

- Client-Server orientation, with optimized request caching and intelligent update over a RESTful architecture - but can be used in stand-alone applications;

- No RAD components, but true ORM and SOA approach; - Multi-Tier architecture, with integrated Business rules as fast ORM-based classes (not via external

scripting or such) and Domain-Driven design; - Service-Oriented-Architecture model, using custom RESTful JSON services - you can send as JSON

any TStrings, TCollection, TPersistent or TObject (via registration of a custom serializer) instance, or even a dynamic array, or any record content, with integrated JSON serialization, via an interface-based contract shared on both client and server sides;

- Truly RESTful authentication with a dual security model (session + per-query); - Very fast JSON producer and parser, with caching at SQL level; - Fastest available HTTP server using http.sys kernel-mode server - but may communicate via named

pipes, GDI messages or in-process as lighter alternatives; - Using SQLite3 as its kernel, but able to connect to any other database (via OleDB / ODBC or direct

client library access e.g. for Oracle) - the SynDB classes are self-sufficient, and do not depend on the Delphi DB unit nor any third-party (so even the Delphi Starter edition is enough);

- Ability to use SQL and RESTful requests over multiple databases at once (thanks to SQLite3 unique Virtual Tables mechanism);

- Full Text Search engine included, with enhanced Google-like ranking algorithm; - Direct User Interface generation: grids are created on the fly, together with a modern Ribbon

('Office 2007'-like) screen layout - the code just has to define actions, and assign them to the tables, in order to construct the whole interface from a few lines of code, without any IDE usage;

- Integrated Reporting system, which could serve complex PDF reports from your application; - Designed to be as fast as possible (asm used when needed, buffered reading and writing avoid most

memory consumption, multi-thread ready architecture...) so benchmarks sound impressive when compared to other solutions - see below (page 93);

- More than 1000 pages of documentation; - Delphi and AJAX clients can share the same server; - Full source code provided - so you can enhance it to fulfill any need; - Works from Delphi 6 up to XE2, truly Unicode (uses UTF-8 encoding in its kernel, just like JSON),

with any version of Delphi (no need to upgrade your IDE).

1.1.2. mORMot

Why is this framework named mORMot?



- Because its initial identifier was "Synopse SQLite3 database framework", which may induce a SQLite3-only library, whereas the framework is now able to connect to any database engine;

- Because we like mountains, and those large ground rodents; - Because marmots do hibernate, just like our precious objects; - Because even if they eat greens, they use to fight at Spring; - Because it may be an acronym for "Manage Object Relational Mapping Over Tables", or whatever

you may think of...



1.2. Architecture principles This framework tries to implement some "best-practice" pattern, among them:

- Model-View Controller - see below (page 44); - Multi-tier architecture - see below (page 45); - Unit testing - see below (page 200); - Object-relational mapping - see below (page 46); - Service-oriented architecture - see below (page 45); - Stateless CRUD/REST - see below (page 127).

All those points render possible any project implementation, up to complex Domain-Driven design - see below (page 47).

1.2.1. Model-View-Controller

The Model-View-Controller (MVC) is a software architecture, currently considered an architectural pattern used in software engineering. The pattern isolates "domain logic" (the application logic for the user) from the user interface (input and presentation), permitting independent development, testing and maintenance of each (separation of concerns).

The model manages the behavior and data of the application domain, responds to requests for information about its state (usually from the view), and responds to instructions to change state (usually from the controller). In event-driven systems, the model notifies observers (usually views) when the information changes so that they can react - but since our ORM is stateless, it does not need to handle those events - see below (page 129).

The view renders the model into a form suitable for interaction, typically a user interface element. Multiple views can exist for a single model for different purposes. A viewport typically has a one to one correspondence with a display surface and knows how to render to it.

The controller receives user input and initiates a response by making calls on model objects. A controller accepts input from the user and instructs the model and viewport to perform actions based on that input.

Model

Viewindirect

association

Controller

indirectassociation

directassociation

directassociation

Model View Controller concept

In the framework, the model is not necessarily merely a database; the model in MVC is both the data and the business/domain logic needed to manipulate the data in the application. In our ORM, a model is implemented via a TSQLModel class, which centralizes all TSQLRecord inherited classes used by an application, both database-related and business-logic related.

The view is currently only all the User-Interface part of the framework, which is mostly auto-generated from code. It will use the model as reference for rendering the data. AJAX clients can also be used -



RESTful and JSON will make it easy.

The controller is mainly already implemented in our framework, within the RESTful commands, and will interact with both the associated view (e.g. for refreshing the User Interface) and model (for data handling). Some custom actions, related to the business logic, can be implemented via some custom TSQLRecord classes or via custom RESTful Services - see below (page 163).

1.2.2. Multi-tier architecture

In software engineering, multi-tier architecture (often referred to as n-tier architecture) is a clientserver architecture in which the presentation, the application processing, and the data management are logically separate processes. For example, an application that uses middle-ware to service data requests between a user and a database employs multi-tier architecture. The most widespread use of multi-tier architecture is the three-tier architecture.

Both ORM and SOA aspects of our RESTful framework make it easy to develop using such a three-tier architecture.

The Synopse mORMot Framework follows this development pattern:

- Data Tier is either SQLite3 and/or an internal very fast in-memory database; most SQL queries are created on the fly, and database table layout are defined from Delphi classes; you can also use external databases (as MS SQL Server or Oracle) - see below (page 112);

- Logic Tier is performed by pure ORM aspect and SOA implementation: you write Delphi classes which are mapped by the Data Tier into the database, and you can write your business logic as Services called as Delphi interface, up to a Domain-Driven design - see below (page 47) - if your project reaches some level of complexity;

- Presentation Tier is either a Delphi Client, either an AJAX application, because the framework can communicate using RESTful JSON over HTTP/1.1 (the Delphi Client User Interface is generated from Code, by using RTTI and structures, not as a RAD - and the Ajax applications need to be written by using your own tools and JavaScript framework, there is no "official" Ajax framework included yet).

1.2.3. Service-oriented architecture

Service-oriented architecture (SOA) is a flexible set of design principles used during the phases of systems development and integration in computing. A system based on a SOA will package functionality as a suite of inter-operable services that can be used within multiple, separate systems from several business domains.

The SOA implementations rely on a mesh of software services. Services comprise unassociated, loosely coupled units of functionality that have no calls to each other embedded in them. Each service implements one action, such as filling out an online application for an account, or viewing an online bank statement, or placing an online booking or airline ticket order. Rather than services embedding calls to each other in their source code, they use defined protocols that describe how services pass and parse messages using description meta-data.

For more details about SOA, see http://en.wikipedia.org/wiki/Service-oriented_architecture..

SOA and ORM - see below (page 46) - do not exclude themselves. In fact, even if some software architects tend to use only one of the two features, both can coexist and furthermore complete each other, in any Client-Server application:

- ORM access could be used to access to the data with objects, that is with the native presentation of the Server or Client side (Delphi, JavaScript...) - so ORM can be used to provide efficient access to



the data or the business logic; - SOA will provide a more advanced way of handling the business logic: with custom parameters and

data types, it's possible to provide some high-level Services to the clients, hiding most of the business logic, and reducing the needed bandwidth.

In particular, SOA will help leaving the business logic on the Server side, therefore will help increasing the Multi-tier architecture (page 45). By reducing the back-and-forth between the Client and the Server, it will also reduce the network bandwidth, and the Server resources (it will always cost less to run the service on the Server than run the service on the Client, adding all remote connection and serialization to the needed database access). Our interface-based SOA model allows the same code to run on both the client and the server side, with a much better performance on the server side, but a full interoperability of both sides.

1.2.4. Object-relational mapping

Before defining what is an ORM, let's face one drawback of using a database via an object-oriented language like Delphi is that you must have your objects interact with the database. Some implementation schemes are possible, in which are some pros and cons. The table below is a very suggestive (but it doesn't mean wrong) Resum of some common schemes, in the Delphi world. ORM is just one nice possibility among others.

Scheme Pros Cons

Use DB views and tables, with GUI

components

- SQL is a powerful language - Can use high-level DB tools (UML)

and RAD approach

- Business logic can't be elaborated without stored procedures

- SQL code and stored procedures will bind you to a DB engine - Poor Client interaction

- Reporting must call the DB directly - No Multi-tier architecture

Map DB tables or views with Delphi classes

- Can use elaborated business logic, in Delphi

- Separation from UI and data

- SQL code must be coded by hand and synchronized with the classes - Code tends to be duplicated

- SQL code could bind you to a DB engine - Reports can be made from code or via

DB related tools - Difficult to implement true Multi-tier

architecture

Use a Database ORM

- Can use very elaborated business logic, in Delphi

- SQL code is generated (in most cases) by the ORM

- ORM will adapt the generated SQL to the DB engine

- More abstraction needed at design time (no RAD approach)

- In some cases, could lead to retrieve more data from DB than needed

- Not yet a true Multi-tier architecture, because ORM is for DB access only and

business logic will need to create separated classes



Use a Client-Server ORM

- Can use very elaborated business logic, in Delphi

- SQL code is generated (in most cases) by the ORM

- ORM will adapt the generated SQL to the DB engine

- Services will allow to retrieve or process only needed data

- Server can create objects viewed by the Client as if they were DB objects,

even if they are only available in memory or the result of some

business logic defined in Delphi - Complete Multi-tier architecture

- More abstraction needed at design time (no RAD approach)

Of course, you'll find out that this framework implements a Client-Server ORM.

1.2.5. Domain-Driven design

The "official" definition of Domain-driven design is supplied at http://domaindrivendesign.org.. :

Over the last decade or two, a philosophy has developed as an undercurrent in the object community. The premise of domain-driven design is two-fold:

- For most software projects, the primary focus should be on the domain and domain logic; - Complex domain designs should be based on a model.

Domain-driven design is not a technology or a methodology. It is a way of thinking and a set of priorities, aimed at accelerating software projects that have to deal with complicated domains.

It can be implemented in a kind of Multi-tier architecture (page 45). In this case, we are talking about N-Layered Domain-Oriented Architecture. It involves a common representation splitting the Logic Tier into two layers, i.e. Application layer and Domain Model layer. Of course, this particular layered architecture is customizable according to the needs of each project. We simply propose following an architecture that serves as a baseline t