Download Introduction of a new Framework to do SIF3

SIF 3.0 REST Framework
Melbourne Developer’s Workshop
November 2013
Presented by: Joerg Huber
2
Overview








What is it?
Goal of the Framework
Framework Architecture
What is its current state?
What is missing?
What is next?
Where can I find it?
Demo
Melbourne MCG: SIF 3.0 REST Framework
November 2013
© Systemic Pty Ltd
3
What is it?






Open-Source Java Framework for SIF
3.0
Library with a number of Interfaces &
Pre-Implemented classes
Basic Environment Provider
Framework for Consumers
Framework for Providers
Ideas and Concepts based on
SIFCommon Framework (SIF 2.x)
Melbourne MCG: SIF 3.0 REST Framework
November 2013
© Systemic Pty Ltd
4
Goal of the Framework



Enable SIF 3.0 Developers to quickly
implement Adapters/Services/Agents
Encourage SIF 3.x Adoption
Fully Abstract Infrastructure


Developers only need to care about:



REST, SOAP, XML or JSON
Read data from their data store (i.e. SIS)
Persist data to their data store (i.e. SIS)
Hide/automate “complex” workflows


Environment Management
Access controls to services
Melbourne MCG: SIF 3.0 REST Framework
November 2013
© Systemic Pty Ltd
Goal of the Framework (cont.)
5



Utilise Of-The-Shelf libraries
Avoid Customisation to 3rd Party Libraries
Be independent from Data Model



Rapid adoption of a new Data Model


Different SIF Locales (AU, US, UK)
Non-SIF Data Models (LTI, EDFI)
Generate Data Model from XSDs
SHOW THAT SIF 3.0 WORKS AS INTENDED!
Melbourne MCG: SIF 3.0 REST Framework
November 2013
© Systemic Pty Ltd
6
Framework Architecture
SIF3 Framework Architecture
(work in progress)
SIF3 Framework
REST/SOAP Provider, Consumer & Environment
Factories/Interfaces
Direct Zone
Implementation
Brokered Zone
Implementation
Agent/Service
uses only this
Layer!
Any Data
Model
Basic Environment
Provider
REST
Infra
SOAP
Infra
Melbourne MCG: SIF 3.0 REST Framework
November 2013
© Systemic Pty Ltd
7
What is its current state?









Java only (maybe .Net later this year)
REST only
Direct Environment & Immediate Response
Zone & Context in URLs supported
Consumer Framework Implementation
Provider Framework Implementation
CRUD for Single Objects and Collections
Paging Supported
Some Demo Code to show how to use
framework
Melbourne MCG: SIF 3.0 REST Framework
November 2013
© Systemic Pty Ltd
8
What is missing?







No SOAP (SIF 3.0 does not specify this, yet)
Brokered Environment
Delayed Response
Events & Queues
xQueries
Caching
Multi-Threading
Melbourne MCG: SIF 3.0 REST Framework
November 2013
© Systemic Pty Ltd
What is next?
9
End of year it is hoped to have support for:
 More Zone & Context support
 Events & Queues
 Better Multi-Threading
Early 2014 (To be confirmed):
 Caching Framework
 .Net version of Framework
 Maybe some Perl Framework
Melbourne MCG: SIF 3.0 REST Framework
November 2013
© Systemic Pty Ltd
1
0
Where can I find it?



The Framework is Open-Source
Located on NSIP’s Github
https://github.com/nsip
There are many other NSIP
sponsored frameworks on that same
Github location:



SIF Common Framework (Java & .Net)
SPB Agent Framework (Java & .Net)
Sample SIF3 Code (Java, .Net, Perl etc)
Melbourne MCG: SIF 3.0 REST Framework
November 2013
© Systemic Pty Ltd
1
1
Demo

Chose a Data Model (SIF AU 1.3)





Generate from XSD
Manual
Implement Marshal/Unmarshal Interface for
Data Model
Setup Environment Template
Implement:


Consumers: Extends AbstractConsumer
Providers: Extends BaseProvider
Melbourne MCG: SIF 3.0 REST Framework
November 2013
© Systemic Pty Ltd
1
2
Contacts
Joerg Huber – Systemic Pty Ltd
SIF Solution Architect
Co-Lead of ITB
Email: [email protected]
Web: http://www.systemic.com.au/sif
NSIP
National Schools Interoperability Program
Web: http://www/nsip.edu.au
Melbourne MCG: SIF 3.0 REST Framework
November 2013
© Systemic Pty Ltd
1
3
Question Time…
Questions?
Melbourne MCG: SIF 3.0 REST Framework
November 2013
© Systemic Pty Ltd