【文件属性】:
文件名称:软件设计文档(OPGW SOFTWARE DESIGN DOCUMENT FOR HMA FOLLOW)
文件大小:426KB
文件格式:PDF
更新时间:2015-04-02 05:31:34
软件设计 文档 模板
非常好的一个设计文档,可以作为模板
TABLE OF CONTENTS
1 INTRODUCTION ............................................................................................................................................................... 10
2 APPLICABLE AND REFERENCE DOCUMENTS .............................................................................................................. 11
3 TERMS, DEFINITION AND ABBREVIATIONS TERMS ....................................................................................................... 13
4 SOFTWARE DESIGN OVERVIEW .................................................................................................................................... 15
4.1 Software static architecture ................................................................................................................................. 15
4.1.1 Components Overview .............................................................................................................................. 15
4.1.2 Relationship with other systems ................................................................................................................ 16
4.1.3 Information Model Overview .................................................................................................................... 17
4.1.3.1 Order Options Model .................................................................................................................. 17
4.1.3.2 Order Model ................................................................................................................................. 19
4.1.3.3 User Profile Overview ................................................................................................................... 21
4.2 Software dynamic architecture .......................................................................................................................... 21
4.3 Interfaces Context ................................................................................................................................................. 22
4.3.1 OPGW vs. HMA Client (Input Interfaces) ................................................................................................ 24
4.3.1.1 HMA Ordering::GetCapabilities [Discrete flow] ..................................................................... 24
4.3.1.2 HMA Ordering::GetOptions [Discrete flow] ............................................................................. 25
4.3.1.3 HMA Ordering::Submit [Discrete flow]...................................................................................... 25
4.3.1.4 HMA Ordering::GetStatus [Discrete flow] ................................................................................ 25
4.3.1.5 HMA Ordering::Cancel [Discrete flow] .................................................................................... 26
4.3.1.6 HMA Ordering::GetQuotation [Discrete flow] ........................................................................ 26
4.3.1.7 HMA Ordering::DescribeResultAccess [Discrete flow] .......................................................... 26
4.3.1.8 key exchange [Control flow] ..................................................................................................... 27
4.3.2 OPGW vs. HMA Client (Output Interfaces)............................................................................................. 27
4.3.2.1 HMA Ordering::SubmitResponse [Discrete flow] .................................................................... 27
4.3.2.2 HMA Ordering::CancelResponse [Discrete flow] ................................................................... 28
4.3.2.3 HMA Ordering::GetQuotationResponse [Discrete flow] ....................................................... 28
4.3.3 OPGW vs. EOLI XML Catalogue (Input Interfaces) ............................................................................... 28
4.3.4 OPGW vs. EOLI XML Catalogue (Output Interfaces) ............................................................................ 28
4.3.4.1 EOLI XML Catalogue::processPresentationRequest [Discrete flow] ................................... 28
4.3.5 OPGW vs. EOLI XML Order Server (Input Interfaces)............................................................................. 29
4.3.6 OPGW vs. EOLI XML Order Server (Output Interfaces) ......................................................................... 29
4.3.6.1 EOLI XML Order::processProductOrderRequest [Discrete flow] .......................................... 29
4.3.6.2 EOLI XML Order::processOrderMonitorRequest [Discrete flow] ........................................... 29
4.3.7 OPGW vs. OPGW Operator (Input Interfaces) ...................................................................................... 29
UNCLASSIFIED
P50638/DSASGT-0083-10/00
OPGW – Software Design Document
for HMA Follow On Task4 - Order
Page 4 of 71
Elsag Datamat spa Copyright as reported on the cover page
4.3.7.1 ServiceDirectory.xml [Discrete flow] ......................................................................................... 29
4.3.7.2 Users_YYYYMMDD_HHMMSS.xml [Discrete flow] ..................................................................... 30
4.4 Long lifetime software ........................................................................................................................................... 30
4.5 Memory and CPU budget .................................................................................................................................... 30
4.6 Design Standards, conventions and procedures ............................................................................................. 31
4.6.1 UML Notations .............................................................................................................................................. 31
4.6.1.1 Deployment Diagrams Notations.............................................................................................. 31
4.6.1.2 Component Diagrams Notations .............................................................................................. 32
4.6.1.3 Class Diagrams Notations ........................................................................................................... 33
4.6.1.4 Sequence Diagrams Notations ................................................................................................. 37
4.6.2 Data Flow Diagrams Notations ................................................................................................................. 37
4.6.3 Database Schema Notations ................................................................................................................... 38
5 SOFTWARE DESIGN ......................................................................................................................................................... 39
5.1 General .................................................................................................................................................................... 39
5.2 Overall architecture............................................................................................................................................... 39
5.2.1 Components overview .............................................................................................................................. 39
5.3 Software components design - General ........................................................................................................... 41
5.4 Software components design – Aspect of each component ....................................................................... 42
5.4.1 OPGW - HMA Skeleton [RD-02] ................................................................................................................. 42
5.4.1.1 Type ................................................................................................................................................ 42
5.4.1.2 Purpose .......................................................................................................................................... 42
5.4.1.3 Function ......................................................................................................................................... 42
5.4.1.4 Subordinates ................................................................................................................................. 43
5.4.1.5 Dependencies .............................................................................................................................. 43
5.4.1.6 Interfaces ....................................................................................................................................... 43
5.4.1.7 Resources ...................................................................................................................................... 43
5.4.1.8 References .................................................................................................................................... 43
5.4.1.9 Processing...................................................................................................................................... 43
5.4.1.10 Data ............................................................................................................................................... 43
5.4.2 OPGW - Order Service ............................................................................................................................... 44
5.4.2.1 Type ................................................................................................................................................ 48
5.4.2.2 Purpose .......................................................................................................................................... 48
5.4.2.3 Function ......................................................................................................................................... 48
5.4.2.4 Subordinates ................................................................................................................................. 49
5.4.2.5 Dependencies .............................................................................................................................. 49
5.4.2.6 Interfaces ....................................................................................................................................... 49
UNCLASSIFIED
P50638/DSASGT-0083-10/00
OPGW – Software Design Document
for HMA Follow On Task4 - Order
Page 5 of 71
Elsag Datamat spa Copyright as reported on the cover page
5.4.2.7 Resources ...................................................................................................................................... 49
5.4.2.8 References .................................................................................................................................... 49
5.4.2.9 Processing...................................................................................................................................... 50
5.4.2.10 Data ............................................................................................................................................... 50
5.4.3 OPGW - Support Tools ................................................................................................................................ 51
5.4.3.1 Type ................................................................................................................................................ 52
5.4.3.2 Purpose .......................................................................................................................................... 52
5.4.3.3 Function ......................................................................................................................................... 52
5.4.3.4 Subordinates ................................................................................................................................. 52
5.4.3.5 Dependencies .............................................................................................................................. 53
5.4.3.6 Interfaces ....................................................................................................................................... 53
5.4.3.7 Resources ...................................................................................................................................... 53
5.4.3.8 References .................................................................................................................................... 53
5.4.3.9 Processing...................................................................................................................................... 53
5.4.3.10 Data ............................................................................................................................................... 53
5.4.4 OPGW - Database ...................................................................................................................................... 54
5.4.4.1 Type ................................................................................................................................................ 55
5.4.4.2 Purpose .......................................................................................................................................... 55
5.4.4.3 Function ......................................................................................................................................... 55
5.4.4.4 Subordinates ................................................................................................................................. 55
5.4.4.5 Dependencies .............................................................................................................................. 55
5.4.4.6 Interfaces ....................................................................................................................................... 55
5.4.4.7 Resources ...................................................................................................................................... 56
5.4.4.8 References .................................................................................................................................... 56
5.4.4.9 Processing...................................................................................................................................... 56
5.4.4.10 Data ............................................................................................................................................... 56
5.4.5 Security Layer ............................................................................................................................................... 57
5.4.5.1 Type ................................................................................................................................................ 58
5.4.5.2 Purpose .......................................................................................................................................... 58
5.4.5.3 Function ......................................................................................................................................... 58
5.4.5.4 Subordinates ................................................................................................................................. 58
5.4.5.5 Dependencies .............................................................................................................................. 58
5.4.5.6 Interfaces ....................................................................................................................................... 58
5.4.5.7 Resources ...................................................................................................................................... 58
5.4.5.8 References .................................................................................................................................... 58
5.4.5.9 Processing...................................................................................................................................... 58
UNCLASSIFIED
P50638/DSASGT-0083-10/00
OPGW – Software Design Document
for HMA Follow On Task4 - Order
Page 6 of 71
Elsag Datamat spa Copyright as reported on the cover page
5.4.5.10 Data ............................................................................................................................................... 59
5.5 Dynamical Model ................................................................................................................................................... 59
5.5.1 Identity Management Scenario ............................................................................................................... 59
5.5.2 Product Ordering Scenario ....................................................................................................................... 60
5.5.3 Configuration Scenario .............................................................................................................................. 62
5.5.4 Asynchronous operations .......................................................................................................................... 62
5.6 Internal Interfaces design ..................................................................................................................................... 63
5.6.1 activate Ordering Class ............................................................................................................................. 63
5.6.1.1 Type ................................................................................................................................................ 63
5.6.1.2 Description .................................................................................................................................... 63
5.6.2 key ................................................................................................................................................................. 63
5.6.2.1 Type ................................................................................................................................................ 63
5.6.2.2 Description .................................................................................................................................... 63
5.6.3 decrypt SAML Token ................................................................................................................................... 63
5.6.3.1 Type ................................................................................................................................................ 63
5.6.3.2 Description .................................................................................................................................... 63
5.6.4 encrypt SAML Token ................................................................................................................................... 64
5.6.4.1 Type ................................................................................................................................................ 64
5.6.4.2 Description .................................................................................................................................... 64
5.6.5 create signature .......................................................................................................................................... 64
5.6.5.1 Type ................................................................................................................................................ 64
5.6.5.2 Description .................................................................................................................................... 64
5.6.6 verify signature ............................................................................................................................................ 64
5.6.6.1 Type ................................................................................................................................................ 64
5.6.6.2 Description .................................................................................................................................... 64
5.6.7 Database Files ............................................................................................................................................. 64
5.6.7.1 Type ................................................................................................................................................ 64
5.6.7.2 Description .................................................................................................................................... 64
5.6.8 HMA Ordering ICD Interface .................................................................................................................... 64
5.6.8.1 Type ................................................................................................................................................ 64
5.6.8.2 Description .................................................................................................................................... 64
5.6.9 JDBC access ................................................................................................................................................ 65
5.6.9.1 Type ................................................................................................................................................ 65
5.6.9.2 Description .................................................................................................................................... 65
5.6.10 Order Capabilities File ................................................................................................................................ 65
5.6.10.1 Type ................................................................................................................................................ 65
UNCLASSIFIED
P50638/DSASGT-0083-10/00
OPGW – Software Design Document
for HMA Follow On Task4 - Order
Page 7 of 71
Elsag Datamat spa Copyright as reported on the cover page