A (XPages) developers guide to Cloudant

8th Sutol Conference, November 2016

A (XPages) developers guide to Cloudant

Frank van der Linden



About me• Freelance Java and web developer, with

XPages experience• …..and JEE technologies• Owner of Elstar IT• Frequent (trail)runner


Roadmap• Introduction to Cloudant• Inside Cloudant• Connect to Cloudant• Cloudant @ XPages


Why Cloudant• For HR Assistant wanted to try a new

datastore


Introduction to Cloudant


What is Cloudant• It is the cloud version of CouchDb• It is document based• CouchDb is created by Damien Katz• Cloudant is bought by IBM• Is like MongoDb or NSF a NoSQL

datastore


What is Cloudant• Data stored as JSON• View and Search ‘formula’ with

javascript• Replication• Tasks• Build in API• No annoying limitations


Cloudant as service• Cloudant can be added as service in

BlueMix


Cloudant standalone• Via website, https://cloudant.com

cloudant.com

http://cloudant.com/


Inside Cloudant


Inside Cloudant


Inside Cloudant• View mapping

• Search index


Connect to Cloudant


Connect to Cloudant• Direct via REST

• https://someusername:[email protected]

• Via a OSGi Plugin, uses the HTTPConnection• https://bitbucket.org/flinden68/cloudant-connector

https://someusername:[email protected]

https://bitbucket.org/flinden68/cloudant-connector


Connect to Cloudant• Credentials

• Account, necessary for the OSGi plugin


Connect to Cloudant• It is JSON everywhere• _rev and _id are reserved

parameters• doc{}, is the actual data

from application


Cloudant connector• Storing in and retrieving from Cloudant • Accessed from Java backend.• Will take out the security issues.• Do the heavy lifting. • Don't reinvent the wheel.


Cloudant @ XPages


Cloudant @ XPages


Cloudant @ XPages


Cloudant @ XPages• Repeat in XPages

• columns - values from Job class


Cloudant @ XPages• JobController -

getJobs


Cloudant @ XPages• Job Java Class


Cloudant @ XPages• CloudantDAO


Cloudant @ XPages• CloudantService - connect

• Find the data in Cloudant


Cloudant @ XPages• Job JSON in Cloudant


Attachment @ Cloudant• Stored as base64 encoded String• Can be as standalone• Or as part of Document (we choose this

way)• Store id as attachmentId, so it can be

retrieved when needed


Attachment @ Cloudant• AttachmentDAO


Attachment @ Cloudant• AttachmentController• Convert upload to

Attachment object


Attachment @ Cloudant• ControllerBase• All controllers can

use these methods


Attachment @ Cloudant• Servlet is called in application for

download

• base64 data for the image tag


RichText @ Cloudant• Stored as MultiMimePart


RichText @ Cloudant• Which is nice converted to

JSON ;-)


Search @ Cloudant• Search example, filter the view


Search @ Cloudant• Do the search in the Controller, call

DAO


Search @ Cloudant• Search method calls the

CloudantService


Search @ Cloudant• CloudantService calls connector to get

the data


Search @ Cloudant• CloudantService calls connector to get

the data


Search @ Cloudant• Cloudant job ftSearch index


Resources• OSGi Cloudant connector

– https://bitbucket.org/flinden68/cloudant-connector

• Cloudant documentation

– https://docs.cloudant.com/

• HR Assistant

– hrassistant.eu-gb.mybluemix.net

– github.com/flinden68/HR-Assistant

https://bitbucket.org/flinden68/cloudant-connector

https://docs.cloudant.com/

http://hrassistant.eu-gb.mybluemix.net/

http://github.com/flinden68/HR-Assistant



Thank you


Technology

A (XPages) developers guide to Cloudant