Training materials for developers of X-Road interfaces

Weekly outline

• General
  
  

  General

  • The objective of this training course is to improve the skills and knowledge of the development of X-Road interfaces.
    

    Estimated load of the training course is 16 academic hours.

    Target group of the training includes developers of X-Road interfaces. The training materials are suitable for training on JAVA as well as .NET platform.

    A person having passed the training:

    • understands the operation principles of X-Road
      
    • understands service-oriented architecture
      
    • can find service WSDL of X-Road
      
    • can read SOAP messages
      
    • can install executed service and set it up in a security server
      
    • knows where to find information about X-Road

    
    

    
    

• Module 1
  
  

  Module 1

  Keywords:

  • character of X-Road
    
  • development of X-Road through versions
    
  • need for transfer to new version
    
  • short overview of the main differences between X-Road versions 5 and 6
    

  Study outputs:

  • understands the nature and operation principles of X-Road
    
  • understands the differences between X-Road versions 5 and 6
    

  • 1.1. X-Road: what, why and for whom? Page
  • 1.2. Functioning of X-Road in the view of dataservice developer Page
  • 1.3. Security of X-Road Page
  • 1.4. Distribution of X-Road Page
  • 1.5. X-Road as backbone of the state Page
  • 1.6. Development of X-Road through versions Page
  • 1.7. Need for transfer to new version Page
  • 1.8. Main differences between X-Road versions 5 and 6 Page
  • Bibliography and references Page
  • Module 1 Presentation File
  • Control questions, Module 1 Book
• Module 2
  
  

  Module 2

  Keywords:

  • Service-oriented architecture
    
  • Structure of SOA and its application on X-Road
    
  • Properties of service-oriented architecture
    
  • Bases of design of dataservices
    
  • Interfacing patterns
    

  Study outputs:

  • understands properties of service-oriented architecture
    
  • understands bases of design of dataservices, able to use interfacing patterns
    

  
  

  • 2.1. Service-oriented architecture Page
  • 2.2. Structure of service-oriented architecture and its application on X-Road Page
  • 2.3. Properties of service-oriented architecture Page
  • 2.4 Bases of design of dataservices Page
  • 2.5 Steps of development of dataservices of X-Road Page
  • 2.6 Interfacing patterns Page
  • Bibliography and references Page
  • Module 2 Presentation File
  • Control questions, Module 2 Book
• Module 3
  
  

  Module 3

  Keywords:

  • Structure of X-Road message
    
  • Description of SOAP protocol
    
  • Changes in relation to the X-Road ver 6
    
  • WSDL of X-Road dataservices
    

  Study outputs:

  • able to find X-Road service WSDL
    
  • able to read SOAP messages
  • understands the connection between SOAP and WSDL
  • knows where to find additional information about WSDL and SOAP
  
  

  
  

  • 3.1 Description of SOAP protocol Page
  • 3.2 Structure of X-Road message Page
  • 3.3 Header of X-Road message Page
  • 3.4 Changes of headers upon transfer from message protocol version 3.1 to version 4.0 Page
  • 3.5 Comparison of headers of SOAP message of X-Road Version 5 and Version 6 Page
  • 3.6 Examples of SOAP message body Page
  • 3.7 WSDL of X-Road dataservices Page
  • 3.8 Finding WSDL documents of dataservices Page
  • 3.9 Quality of technical solution Page
  • 3.10 Documentation of WSDL description Page
  • 3.11 Validation rules of WSDL description and validator Page
  • 3.12 Versioning X-Road services Page
  • 3.13 Typical mistakes Page
  • Bibliography and references Page
  • Module 3 Presentation File
  • Control questions, module 3 Book
• Module 4
  
  

  Module 4

  Keywords:

  • Namespace of X-Road
    
  • Dataservices
    
  • X-Road metaservices
    

  Study outputs:

  • knows how to use X-Road metaservices and able to find descriptions of services (from security server)
    
  • knows, where to find document templates for describing services and architecture of the information system
  • understands what documents are needed and why

  • 4.1 Namespace of X-Road Page
  • 4.2 Services Page
  • 4.3 Descriptions of services and how to find them Page
  • 4.4 Document templates for describing services and architecture of the information system Page
  • 4.5 Documents needed for describing dataservices Page
  • Control questions, module 4 Book
  • Module 4 presentation File
• Module 5
  
  

  Module 5

  Keywords:

  • creation of WSDL file of X-Road dataservice
    
  • description of X-Road dataservice WSDL
    
  • dataservice life and operating cycle planning and using
    

  Study outputs:

  • knows how to create WSDL of the X-Road dataservice
    
  • knows, how to planning the dataservice life and operating cycle and using it

  
  

  • 5.1 Preparation of training environment for practical part Page
  • 5.2 Practical part: Creation of WSDL file of X-Road dataservice Page
  • 5.2.1 Preparing Eclipse environment Page
  • 5.2.2 Creating a new project Page
  • 5.2.3 Creation of WSDL file Page
  • 5.2.4 Adaptation of WSDL example with graphic editor Page
  • 5.2.5 Bringing the structure of dataservice into conformity with the description of the service Page
  • 5.2.6 Add descriptions of X-Road headers Page
  • Sample WSDL File
  • Module 5 presentation File
• Module 6
  
  

  Module 6

  Keywords:

  • creation of X-Road dataservice (client and server) 
    
  • creation of X-Road dataservice
  • setting up the generated X-Road dataservice
    

  Study outputs:

  • knows how to create WSDL of the X-Road dataservice
    
  • knows, how to generated X-Road dataservice publish and configure the security server
  
  

  
  

  • 6.1 Practical part: Creation of X-Road data service and client based on WSDL (on Java platform) Page
  • 6.2 Creation of X-Road dataservice and client based on WSDL (.NET platform) Page
  • 6.3 Setting up secure connection Page
  • Bibliography and references Page
  • Module 6 Presentation Practical part: Creation of X-Road dataservice and client based on WSDL (on Java platform) File
  • Module 6 Practical part: Creation of X-Road dataservice and client based on WSDL (.NET platform) File
  • Sample Java Folder
  • Sample PHP Folder
• Module 7
  
  

  Module 7

  Keywords:

  • testing dataservice with SoapUI tool  
    
  • setting MISP2 server for testing X-Road services
  • testing X-Road service in MISP2 application
    
  • Testing services between authorities (group task)
    
  • Testing services prepared testenviroment
    

  Study outputs:

  • knows how to test dataservice (for example with SoapUI tool)
    
  • knows how to test dataservice in MISP2 application
  • knows how testing services between authorities (for example in group task)
    

  
  

  • 7.1 Testing X-Road dataservice Page
  • 7.2 Testing dataservice with SoapUI tool Page
  • 7.3 Setting service in X-Road security server Page
  • 7.4 Testing dataservice with SoapUI tool in X-Road security server Page
  • 7.5 Introduction of MISP2 application Page
  • 7.6 MISP2 server of training environment Page
  • 7.7 Setting MISP2 server for testing X-Road services Page
  • 7.8 XForms Page
  • 7.9 Testing X-Road service in MISP2 application Page
  • 7.10 Using Orbeon Inspector Page
  • 7.11 Opening services in MISP2 portal for the role of regular user Page
  • 7.12 Testing services between authorities (group task) Page
  • Module 7 Presentation File
  • Quick start guide for preparing the X-Road XForms complex service File
• Module 8
  
  

  Module 8

  Keywords:

  • X-Road knowledge materials
    
  • general frameworks and policies
    
  • X-Road instances
    
  • materials for X-Road architect and developer
    
  • materials needed for security server administrator
    

  Study outputs:

  • to be able to find additional information about X-Road interfaces
    
  • knows, where to find additional information
    
  
  

  
  

  • 8.1 Introduction of X-Road knowledge materials Page
  • 8.2 General frameworks and policies Page
  • 8.3 Repository Page
  • 8.4 X-Road instances and affiliation of membership Page
  • 8.5 Materials for X-Road architect and developer Page
  • 8.6 Materials needed for security server administrator Page
  • 8.7 X-tee User Group Estonia Page
  • 8.8 X-Road marketing materials Page
  • Module 8 Presentation File