REST services in Domino - Domino Access Services

Transcription

1 REST services in Domino - Domino Access Services Domino Programmability Team 2012 IBM Corporation

2 Agenda Why REST? REST Basics RESTful Domino Domino Access Services Overview Domino Access Services Domino data service Calendar service Mail service Other services we are discussing Enable Domino Access Services Build customized service Some user stories API by release Reference IBM Corporation

3 Why REST REST Basics What is REST? Representational State Transfer (REST) Resource-oriented: Documents, views, messages, & calendar entries are all just resources Each resource has a unique URL Multiple representations of a resource (JSON, XML, MIME, icalendar, etc.) Uses HTTP uniform interface (GET, POST, PUT & DELETE) REST in the marketplace Google, Facebook, Twitter all depend on REST to build market share Benefits of REST Secure lightweight web service based on HTTP Great for web applications, native mobile applications and server-to-server access IBM Corporation 2013 IBM Corporation

4 Why REST RESTful Domino Domino works as service provider Client and server are more decoupled Very low barrier to use Easy to integrated in web/mobile applications Two ways to access REST service of Domino From XPages using the REST Service control (won't cover in this slide) As built-in service called Domino Access Services (DAS) REST API vs Traditional API REST vs SOAP REST vs NRPC/DIIOP 2013 IBM Corporation

5 REST vs SOAP Both are web services, but... It's easier to build a REST client No need for special libraries or generated code REST clients are lighter Easy to access a REST service by http client REST vs NRPC/DIIOP Client doesn't need Notes/Domino libraries or Notes ID Great for web and native mobile applications IBM Corporation

6 What is Domino Access Services (DAS)? Growing family of REST services including:... Domino data service Mail service Calendar service Access Domino data from any HTTP client Strategically important for integrating with other IBM products IBM Corporation

7 Domino Access Services (DAS) is also a framework One framework for adding REST services to Domino Extensible framework built on Apache Wink (see and OSGi IBM Corporation

8 DAS in API Framework Customer solutions using SSJS Customer solutions using REST Customer solutions using Notes Java API Customer solutions using LotusScript JS Wrappers REST Service Java Wrappers LotusScript Wrappers Customer solutions using C / C++ Back-end Classes C SDK Core function IBM Corporation

9 Domino Access Services Architecture Data Service Plug-in Domino Server Calendar Service Plug-in... Traveler Admin Plug-in All components in blue are OSGi plugins (Java code). DAS Servlet Apache Wink Runtime Domino Web Engine (native code) Client can be a browser, native mobile app, etc anything that can send an HTTP request IBM Corporation IBM Corporation

10 Domino Access Services (DAS) Domino data service Calendar service Mail service Other services we are discussing 2013 IBM Corporation

11 Domino Data Service Overview Released in Upgrade Pack 1; also planned for 9.0 Access to databases, views, folders & documents JSON representation for easy access from JavaScript and other languages Create, Read, Update & Delete (CRUD) operations for documents IBM Corporation

12 Domino Data Service Functionality Reading database collection Reading/updating view/folder entry collection Creating new documents Reading/updating/deleting existing documents IBM Corporation

13 Domino Data Service Sample GET Method: Resource: URI: GET View Entries [ { }, { }, "@entryid":"1-0f7e8f76cacc d0c5", "@unid":"0f7e8f76cacc d0c5", "@noteid":"2c7a", "@position":"1", "Key":"AL", "Name":"ALABAMA" "@entryid":"2-df127ef6e034afe d0c6", "@unid":"df127ef6e034afe d0c6", "@noteid":"2c7e", "@position":"2", "Key":"AK", "Name":"ALASKA" IBM Corporation

14 Calendar Service - Overview Planned for 9.x Higher level of abstraction for access to calendar data JSON and icalendar representations CRUD operations with implicit scheduling IBM Corporation

15 Calendar Service Functionality Create, read, update and delete calendar entries Read a range of entries from a calendar Get a list of invitations or unapplied notices Simple actions for calendar entries and notices Controls for implicit scheduling IBM Corporation

16 Calendar service example Read a range of events GET JSON response { } "events": [ { "id": "8A AD700661DAE", "summary": "Super Bowl XLVII", "location": "New Orleans", "start": { "date": " ", "time": "23:30:00", "utc": true }, "end": { "date": " ", "time": "03:00:00", "utc": true } }, { "id": "09C4206D7BD743D685257AB0007BA513", "summary": "Repeating Appointment", "location": "test", "start": {...}, "end": {...} },... ] IBM Corporation

17 Calendar service example Read a range of events GET icalendar response BEGIN:VCALENDAR X-LOTUS-CHARSET:UTF-8 VERSION:2.0 BEGIN:VEVENT DTSTART: T233000Z DTEND: T030000Z SUMMARY:Super Bowl XLVII LOCATION:New Orleans UID:8A AD700661DAE X-LOTUS-SUMMARYDATAONLY:TRUE END:VEVENT BEGIN:VEVENT DTSTART: T140000Z DTEND: T150000Z SUMMARY:Repeating Appointment LOCATION:test UID:09C4206D7BD743D685257AB0007BA513 X-LOTUS-SUMMARYDATAONLY:TRUE END:VEVENT... END:VCALENDAR IBM Corporation

18 Calendar service example Create a new event POST Content-Type: application/json JSON request { } "events": [ { "summary": "2013 Boston Marathon", "location": "Hopkinton to Boston", "start": { "date": " ", "time": "13:00:00", "utc": true }, "end": { "date": " ", "time": "19:00:00", "utc": true } } ] IBM Corporation

19 Calendar service example Create a new event POST Content-Type: text/calendar icalendar request BEGIN:VCALENDAR VERSION:2.0 PRODID:-//Some Company//NONSGML Some Product//EN BEGIN:VEVENT DTSTART: T130000Z DTEND: T190000Z SUMMARY:2013 Boston Marathon LOCATION:Hopkinton to Boston END:VEVENT END:VCALENDAR IBM Corporation

20 Mail Service Overview and Functionality On OpenNTF now; no firm plans for product release JSON and MIME representations Read views, folders & messages; Send messages; Draft messages IBM Corporation

21 Mail service example Get messages Method: Resource: URI: GET Inbox [ { "from":"dan Misawa", "subject":"test sending mail...", "date":" t17:52:09z", "href":" }, { "from":"frank Adams", "subject":" with Mime", "date":" t17:16:55z", "href":" }, { "from":"betty Zechman", "subject":"message with rich text conent and attachment.", "date":" t18:35:43z", "href":" } ] IBM Corporation

22 Calendar service example Get a message in JSON Method: Resource: URI: GET Messages { "from":"cn=fadams\/o=renovations", "to": ["CN=Dan Misawa \/O=Renovations"], "subject":"message with rich text conent and attachment.", "date":" t19:42:49z", "href":" "content": [ { "contenttype":"multipart\/mixed; boundary=\"=_mixed 006C4A7C _=\"" }, { "contenttype":"text\/html; charset=\"us-ascii\"", "data":"<font size=2 color=red face=\"sans-serif\"><b>this text is bold and red.<\/b><\/font>\r\n<br>\r\n<br>", "boundary":"--=_mixed 006C4A7C _=" }, { "contenttype":"text\/plain; name=\"text Document.txt\"", "contenttransferencoding":"quoted-printable", "data":"this is a simple text file with some text.=\r\n=", "boundary":"--=_mixed 006C4A7C _=", "contentdisposition":"attachment; filename=\"text Document.txt\"" } ] } IBM Corporation

23 Calendar service example Get a message in MIME Method: Resource: URI: GET Messages MIME-Version: 1.0 To: Dan Misawa@notesdev.ibm.com Subject: Message with rich text conent and attachment. Message-ID: <OFD02D492E.423DBF5F-ON C242C C4A7F@LocalDomain> Date: Fri, 9 Dec :42: Sender: fadams@explorer.swg.usma.ibm.com From: fadams@notesdev.ibm.com Content-Type: multipart/mixed; boundary="=_mixed 006C4A7C _=" MIME-Version: =_mixed 006C4A7C _= Content-Type: text/html; charset="us-ascii" <font size=2 color=red face="sans-serif"><b>this text is bold and red.</b></font> <br> --=_mixed 006C4A7C _= Content-Type: text/plain; name="text Document.txt" Content-Disposition: attachment; filename="text Document.txt" Content-Transfer-Encoding: quoted-printable This is a simple text file with some text.= = --=_mixed 006C4A7C _= IBM Corporation

24 Other services we're discussing FreeBusy Rooms & Resources Traveler admin Looking for customer feedback on other ideas and priorities IBM Corporation

25 Enabling service on server is required DAS is disabled by default. Can be enabled for Server, Database (View and Document), and View { } "code":403, "text":"forbidden", "message":"database not allowed for Web Access" Administrator controls which servers run the data service: Internet Site or Server Document IBM Corporation

26 Enabling service for a database Application developer controls Database access: Database Advanced Properties Application developer controls View access: View Advanced Properties IBM Corporation

27 Custom REST Services Tools to build your own services using OSGi and Apache Wink Java, OSGi, Wink skills required Apache Wink is an open source project Easy to build a service in a Java servlet container Uses Java annotations Most of the code is contributed to Apache by the WebSphere team See Enforces consistency across services for example Common URL path (/api/data, /api/mail, /api/calendar) Common JSON error object Administrator uses one UI to choose what services run on a server IBM Corporation

28 User story (1 of 3) Data service : Document Repository User story User want to read/write document in domino server on mobile or web browser Pro-art and limitation Xpages,Help documents on Lotus wiki are implemented by xpage, Xpages is developed and binding with db. Quickr,product of document repository based on domino Solution After we public RESTful service, any vendor or partner can develop client application product or integrate this service into their product 2013 IBM Corporation

29 User story (2 of 3) Mail service : Social mail/connection mail User story User want to read his mail on mobile or web browser Pro-art and limitation inotes, use internal domino api instead of consume REST mail service. Additional library needed on server. Solution REST API is standard and general service, independent of client/server, after we provide mail service api, all kinds of web-based mail client can consume it, integrate it, including next generation notes client- Social mail 2013 IBM Corporation

30 User story (3 of 3) Calendar service : General calendar User story User want to check his calendar on mobile, this calendar is collection for all his calendar events, including google calendar, notes calendar, icalendar on mac Pro-art and limitation N/A Solution After we public RESTful service, any vendor or partner can develop client application product or integrate this service into their product 2013 IBM Corporation

31 APIs by Release API Name Upgrade Pack 1 Extension Library (OpenNTF) 9.0 Social Edition Domino data service Yes Yes In Plan In Plan 9.x Calendar service No No No In Plan Mail service No Yes No Not in Plan IBM Corporation

32 Documentation and other references Topic Source Link Domino data service App Dev Wiki lookupname=domino%20data%20service Mail service OpenNTF AC F2/%24file/Domino%20Mail%20Service.pdf Calendar service Planned for an extlib release coming soon ( Domino application development in general App Dev Wiki Extension library in general OpenNTF IBM Corporation