Transcript 01 - SIF3 Framework Overviewx

SIF3 REST Framework
Open-Source SIF3 Development Framework
Developed by Systemic Pty Ltd
www.systemic.com.au/sif
Sponsored by NSIP
www.nsip.edu.au
Presented by: Joerg Huber
2
Overview








What is it?
Assumptions & Constraints
Goal of the Framework
Framework Architecture
What is its current state?
What is missing?
What is next?
Where can I find it?
Training Course - Sydney: SIF3 Framework Overview
September 2014
© Systemic Pty Ltd
3
What is it?






Open-Source Java & .Net Framework for
SIF 3.0
Library with a number of Interfaces &
Pre-Implemented classes
Direct Environment Provider
Framework for Object Consumers
Framework for Object Providers
Ideas and Concepts based on
SIFCommon Framework (SIF 2.x)
Training Course - Sydney: SIF3 Framework Overview
September 2014
© Systemic Pty Ltd
4
Assumptions & Constraints




No guarantee that it all works without any
bugs (surely there are bugs)
There is commitment from NSIP to
maintain the SIF3 Framework for the near
future.
You don’t have to use it. You can always
use SIF 3.0 with your own REST
implementation.
You can modify it to suit your purpose
(Open Source) if absolutely needed.

Ensure you meet the SIF 3.x specification!
Training Course - Sydney: SIF3 Framework Overview
September 2014
© Systemic Pty Ltd
5
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
Training Course - Sydney: SIF3 Framework Overview
September 2014
© Systemic Pty Ltd
Goal of the Framework (cont.)
6



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!
Training Course - Sydney: SIF3 Framework Overview
September 2014
© Systemic Pty Ltd
7
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
Training Course - Sydney: SIF3 Framework Overview
September 2014
© Systemic Pty Ltd
8
What is its current state?










Java & .Net (vary slightly in functionality)
REST only
Works in Direct & Brokered Environment
Immediate Request/Response only
Zone & Context in URLs supported
Consumer Framework Implementation
Provider Framework Implementation
Direct Environment Provider Implementation
CRUD for Single Objects and Collections
Events in Brokered Environments (Java only)
Training Course - Sydney: SIF3 Framework Overview
September 2014
© Systemic Pty Ltd
9
What is missing?

No Service Path support, yet
(…/TeachingGroup/{GUID}/Students)


Delayed Request/Response
Alert Service (only of importance for Delayed
messaging)


xQueries Service
No JSON (SIF 3.0.1 does not specify this, yet)


Work in progress at the SIF Association.
No SOAP (SIF 3.0.1 does not specify this, yet)
Training Course - Sydney: SIF3 Framework Overview
September 2014
© Systemic Pty Ltd
1
0
What is next?
The following functional components are
planned to be part of the SIF3 Framework:
 Service Path Support
 Delayed Responses (asynchronous messaging)

May include support for Alert Service
JSON support once defined by SIF Spec.
 OAuth support once defined by SIF Spec.
 Simple SIF (already partially supported in Java

Framework)

xQuery Service support
Note: The above list may not be complete and it is not
prioritised.
Training Course - Sydney: SIF3 Framework Overview
September 2014
© Systemic Pty Ltd
1
1
Where can I find it?


The Framework is Open-Source
Located on NSIP’s Github
Java: https://github.com/nsip/sif3-framework-java
.Net: https://github.com/nsip/Sif3Framework-dotNet

There are many other NSIP sponsored
frameworks on that same Github location:
 SIF2: SIF Common Framework (Java & .Net)
 SIF2: SBP Agent Framework (Java & .Net)
 SIF3: Sample Code (Java, .Net, Perl etc.)
Training Course - Sydney: SIF3 Framework Overview
September 2014
© Systemic Pty Ltd
1
2
Contacts
Joerg Huber (Java) – Systemic Pty Ltd
SIF Solution Architect
Co-Lead of ITB
Email: [email protected]
Rafidzal Rafiq (.Net) – Systemic Pty Ltd
SIF Developer
Email: [email protected]
Systemic - http://www.systemic.com.au/sif
NSIP - http://www.nsip.edu.au
Training Course - Sydney: SIF3 Framework Overview
September 2014
© Systemic Pty Ltd
1
3
Question Time…
Questions?
Training Course - Sydney: SIF3 Framework Overview
September 2014
© Systemic Pty Ltd