com.hcl.domino.keep.dbrequests

Class KeepJnxSession

java.lang.Object

com.hcl.domino.keep.dbrequests.KeepJnxSession

All Implemented Interfaces:

java.lang.AutoCloseable

public class KeepJnxSession
extends java.lang.Object
implements java.lang.AutoCloseable

Wrapper / Replacement around a Domino Session to make the KEEP API functional

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KeepJnxSession.DocumentScope Options to deal with getDocumentbyXX(…) to allow inclusion or exclusion of deleted documents.
static class	KeepJnxSession.Note2JsonOptions Options available when converting a Note into a Json Structure

Constructor Summary

Constructors

Constructor and Description
KeepJnxSession(KeepUser user)

Method Summary

Modifier and Type	Method and Description
void	close()
com.hcl.domino.data.Document	createDocumentFromJson(com.hcl.domino.data.Database db, io.vertx.core.json.JsonObject body) Create and save a document based on pre-validated JSON
boolean	deleteApplicationConfig(TheBarbican barbican, java.lang.String appId) Deletes an application configuration
io.vertx.core.json.JsonObject	document2Json(com.hcl.domino.data.Document doc) Get all fields from a document
io.vertx.core.json.JsonObject	document2Json(com.hcl.domino.data.Document doc, java.util.Map<java.lang.String,java.lang.String> fieldMap) Get all fields from a document
io.vertx.core.json.JsonObject	document2Json(com.hcl.domino.data.Document doc, java.util.Map<java.lang.String,java.lang.String> rawFieldMap, java.util.Set<KeepJnxSession.Note2JsonOptions> options)
io.vertx.core.json.JsonObject	document2JsonSelected(com.hcl.domino.data.Document doc, java.util.Set<java.lang.String> fields, java.lang.String onLoadFormula, java.util.Map<java.lang.String,java.lang.String> fieldMap) Get document based on FormAccessMode fields and onLoad formula
java.util.Map<java.lang.String,java.lang.String>	extractFieldsForForm(io.vertx.core.json.JsonObject designInfo, java.lang.String formName)
com.hcl.domino.DominoClient	getClient()
com.hcl.domino.DominoClient	getClientAsIDUser()
com.hcl.domino.data.Database	getDatabase(java.lang.String apiName)
com.hcl.domino.data.Database	getDatabase(java.lang.String apiName, KeepDbInfo info)
com.hcl.domino.data.Database	getDatabaseDomino(java.lang.String filePath) Gets a database by its Domino filepath
java.util.Optional<com.hcl.domino.data.Document>	getDocumentById(com.hcl.domino.data.Database db, int id, KeepJnxSession.DocumentScope scope) Returns a document from a database, including the option to return deleted documents
java.util.Optional<com.hcl.domino.data.Document>	getDocumentByUNID(com.hcl.domino.data.Database db, java.lang.String unid, KeepJnxSession.DocumentScope scope) Returns a document from a database, including the option to return deleted documents, as deleted or restored
java.util.Optional<com.hcl.domino.data.Document>	getDocumentByUNID(com.hcl.domino.data.Database db, java.lang.String unid, KeepJnxSession.DocumentScope scope, java.util.Set<com.hcl.domino.data.Database.OpenDocumentMode> options) Returns a document from a database, including the option to return deleted documents, as deleted or restored
com.hcl.domino.dxl.DxlImporter	getDxlImporter() Grab a DXL Importer
java.lang.Object	getItemValueForJson(com.hcl.domino.data.Document doc, com.hcl.domino.data.Item item) Converts the item value into something suitable for JSON
KeepUser	getUser()
java.lang.String	getUserName()
io.vertx.core.json.JsonObject	getViewRow(java.util.Map<java.lang.String,com.hcl.domino.data.CollectionColumn> columnMap, java.util.List<java.lang.String> columnNames, com.hcl.domino.data.CollectionEntry curEntry, boolean includeUnreadInfo) Converts a NotesView Row into a JSON Object
KeepApplicationConfigInfo	loadApplicationConfig(TheBarbican barbican, java.lang.String appId) Finds a KeepApplication document for a specific appId and converts it to a KeepApplicationConfigInfo object
void	mime2doc(com.hcl.domino.data.Document doc, java.lang.String message, java.util.List<java.lang.String> headerNames) Writes MIME content out into a Note By nature of Mime, Mime only gets appended, so we need to clear fields and most important the Body before commencing
java.lang.String	modifyAndEvaluateFormula(java.lang.String formulaString, com.hcl.domino.data.Document doc, com.hcl.domino.data.Database db)
com.hcl.domino.data.Formula.FormulaExecutionResult	modifyAndExecuteFormula(java.lang.String formulaString, com.hcl.domino.data.Document doc, com.hcl.domino.data.Database db)
java.lang.String	modifyFormulaForUser(java.lang.String formula, com.hcl.domino.data.Document doc, com.hcl.domino.data.Database db)
boolean	processItemRequired(com.hcl.domino.data.Item item, java.util.Map<java.lang.String,java.lang.String> fieldMap, java.util.TreeMap<java.lang.String,java.lang.Object> itemsAlreadyProcessed, java.util.Set<KeepJnxSession.Note2JsonOptions> options) Determines if an item needs to be processed and converted into JSON
void	readDocToMIME(com.hcl.domino.data.Document doc, java.io.Writer writer, java.lang.Class<?> clazz) Reads the raw mime Stream from a NotesItem into a writer, based on options.
void	readRawMIME(com.hcl.domino.data.Document doc, java.lang.String itemName, java.io.Writer writer, java.util.Set<com.hcl.domino.mime.MimeReader.ReadMimeDataType> options, java.lang.Class<?> clazz) Reads the raw mime Stream from a NotesItem into a writer, based on options.
com.hcl.domino.person.OutOfOffice	startOOOOperation(java.lang.String userName, java.lang.String mailServer, boolean isMailServer, com.hcl.domino.data.Database db)
void	updateDocFromJson(io.vertx.core.json.JsonObject jsonSource, com.hcl.domino.data.Document doc) Write fields into a pre-created document, without validation against a Form Access Mode.
void	validateAccessRequest(com.hcl.domino.data.Database db, com.hcl.domino.security.AclLevel minimumRequiredAclLevel, java.util.Set<AclAccessFlags> aclAccessFlags, java.util.Set<java.lang.String> accessRolesRequired)
com.hcl.domino.data.Document	validateAttachmentAccessRequest(com.hcl.domino.data.Database db, java.lang.String unid, java.lang.String fileName, DocumentAccess docAccess) Validates request for attachment reading / writing
com.hcl.domino.data.Document	validateDocumentAccessRequest(com.hcl.domino.data.Database db, java.lang.String unid, DocumentAccess docAccess) Validates the user has access to read and, if required, write the document Checks for the document directly, we presume ACL check has been done already if the document is protected by a reader field it will return a not found error
void	validateFormAccessFormula(java.lang.String formula, com.hcl.domino.data.Document doc, java.lang.String apiName) Validate the user has access to perform an action using a FormAccessMode, according to the DQL access formula in the KeepConfig
void	writeRawMIME(com.hcl.domino.data.Document doc, java.io.Reader reader)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeepJnxSession

public KeepJnxSession(KeepUser user)

Parameters:

user -

• UserName

Method Detail

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

createDocumentFromJson

public com.hcl.domino.data.Document createDocumentFromJson(com.hcl.domino.data.Database db,
                                                           io.vertx.core.json.JsonObject body)

Create and save a document based on pre-validated JSON

Parameters:

db -

• Database in which to create the document

body -

• JsonObject containing name value pairs to store in document

Returns:

Created document, already saved in database

deleteApplicationConfig

public boolean deleteApplicationConfig(TheBarbican barbican,
                                       java.lang.String appId)

Deletes an application configuration

Parameters:

barbican -

appId -

Returns:

true if it worked

document2Json

public io.vertx.core.json.JsonObject document2Json(com.hcl.domino.data.Document doc)

Get all fields from a document

Parameters:

doc -

• Document to extract data from

Returns:

JsonObject with values from document

document2Json

public io.vertx.core.json.JsonObject document2Json(com.hcl.domino.data.Document doc,
                                                   java.util.Map<java.lang.String,java.lang.String> fieldMap)

Get all fields from a document

Parameters:

doc -

• Document to extract data from

fieldMap -

Returns:

JsonObject with values from document

document2Json

public io.vertx.core.json.JsonObject document2Json(com.hcl.domino.data.Document doc,
                                                   java.util.Map<java.lang.String,java.lang.String> rawFieldMap,
                                                   @Nonnull
                                                   java.util.Set<KeepJnxSession.Note2JsonOptions> options)

Parameters:

doc -

• Document to extract data from

rawFieldMap -

• Map with field names to either include or exclude

options - EnumSet to icnlude/exclude fields / RichText

Returns:

a complete JSonObject

document2JsonSelected

public io.vertx.core.json.JsonObject document2JsonSelected(com.hcl.domino.data.Document doc,
                                                           java.util.Set<java.lang.String> fields,
                                                           java.lang.String onLoadFormula,
                                                           java.util.Map<java.lang.String,java.lang.String> fieldMap)

Get document based on FormAccessMode fields and onLoad formula

Parameters:

doc -

• Document to extract data from

fields -

• List of fields, or empty list to retrieve everything

onLoadFormula -

• Formula to apply before extracting fields

fieldMap -

• translate fieldNames to proper from

Returns:

JsonObject with values from document

extractFieldsForForm

public java.util.Map<java.lang.String,java.lang.String> extractFieldsForForm(io.vertx.core.json.JsonObject designInfo,
                                                                             java.lang.String formName)

Parameters:

designInfo -

formName -

Returns:

Map with lowercase field names

getClient

public com.hcl.domino.DominoClient getClient()

Returns:

A valid Domino client

getClientAsIDUser

public com.hcl.domino.DominoClient getClientAsIDUser()

Returns:

A Domino client with the ID user

getDatabase

public com.hcl.domino.data.Database getDatabase(java.lang.String apiName)
                                         throws KeepExceptionInsufficientAccess

Parameters:

apiName -

• how we address it

Returns:

a Database

Throws:

KeepExceptionInsufficientAccess

getDatabase

public com.hcl.domino.data.Database getDatabase(java.lang.String apiName,
                                                KeepDbInfo info)
                                         throws KeepExceptionInsufficientAccess

Parameters:

apiName -

• how we address it

info -

Returns:

a Database

Throws:

KeepExceptionInsufficientAccess

getDatabaseDomino

public com.hcl.domino.data.Database getDatabaseDomino(java.lang.String filePath)
                                               throws KeepExceptionInsufficientAccess

Gets a database by its Domino filepath

Parameters:

filePath - actual filepath

Returns:

a Database

Throws:

KeepExceptionInsufficientAccess

getDocumentById

public java.util.Optional<com.hcl.domino.data.Document> getDocumentById(com.hcl.domino.data.Database db,
                                                                        int id,
                                                                        KeepJnxSession.DocumentScope scope)

Returns a document from a database, including the option to return deleted documents

Parameters:

db -

• the database to query

id -

• the id of the document

scope -

• search all or no documents

Returns:

a document or null if invalid

getDocumentByUNID

public java.util.Optional<com.hcl.domino.data.Document> getDocumentByUNID(com.hcl.domino.data.Database db,
                                                                          java.lang.String unid,
                                                                          KeepJnxSession.DocumentScope scope)

Returns a document from a database, including the option to return deleted documents, as deleted or restored

Parameters:

db -

• the database to query

unid -

• the unid of the document

scope -

• search all or no documents

Returns:

a document or null if invalid

getDocumentByUNID

public java.util.Optional<com.hcl.domino.data.Document> getDocumentByUNID(com.hcl.domino.data.Database db,
                                                                          java.lang.String unid,
                                                                          KeepJnxSession.DocumentScope scope,
                                                                          java.util.Set<com.hcl.domino.data.Database.OpenDocumentMode> options)

Returns a document from a database, including the option to return deleted documents, as deleted or restored

Parameters:

db -

• the database to query

unid -

• the unid of the document

scope -

• search all or no documents

options -

• OpenOptions

Returns:

a document or null if invalid

getDxlImporter

public com.hcl.domino.dxl.DxlImporter getDxlImporter()

Grab a DXL Importer

Returns:

A working DXL Importer

getItemValueForJson

public java.lang.Object getItemValueForJson(com.hcl.domino.data.Document doc,
                                            com.hcl.domino.data.Item item)

Converts the item value into something suitable for JSON

Parameters:

doc -

• The Notes document containing the items

item -

• Item from which to extract data

Returns:

JSON-ready value

getUser

public KeepUser getUser()

Returns:

the user

getUserName

public java.lang.String getUserName()

Returns:

the userName

getViewRow

public io.vertx.core.json.JsonObject getViewRow(java.util.Map<java.lang.String,com.hcl.domino.data.CollectionColumn> columnMap,
                                                java.util.List<java.lang.String> columnNames,
                                                com.hcl.domino.data.CollectionEntry curEntry,
                                                boolean includeUnreadInfo)

Converts a NotesView Row into a JSON Object

Parameters:

columnMap -

• Map with all column objects

columnNames -

• Arraylist (sorted) with column names

curEntry -

• the Notes data of a row in a view/folder

includeUnreadInfo - boolean include unread y/n

Returns:

A JsonObject equivalent of a row in a view

loadApplicationConfig

public KeepApplicationConfigInfo loadApplicationConfig(TheBarbican barbican,
                                                       java.lang.String appId)
                                                throws KeepException

Finds a KeepApplication document for a specific appId and converts it to a KeepApplicationConfigInfo object

Parameters:

barbican -

appId - to search for

Returns:

KeepApplicationConfigInfo object extracted

Throws:

KeepException

mime2doc

public void mime2doc(@Nonnull
                     com.hcl.domino.data.Document doc,
                     @Nonnull
                     java.lang.String message,
                     @Nonnull
                     java.util.List<java.lang.String> headerNames)
              throws java.io.IOException

Writes MIME content out into a Note By nature of Mime, Mime only gets appended, so we need to clear fields and most important the Body before commencing

Parameters:

doc -

• A Document to save the mime message to

message -

• the mime formatted message / data

headerNames -

• The list of header that will be updated

Throws:

java.io.IOException

modifyAndEvaluateFormula

public java.lang.String modifyAndEvaluateFormula(java.lang.String formulaString,
                                                 com.hcl.domino.data.Document doc,
                                                 com.hcl.domino.data.Database db)

Parameters:

formulaString - Formula to run

doc - Document to evaluate the formula against

db -

Returns:

result of the formula

modifyAndExecuteFormula

public com.hcl.domino.data.Formula.FormulaExecutionResult modifyAndExecuteFormula(java.lang.String formulaString,
                                                                                  com.hcl.domino.data.Document doc,
                                                                                  com.hcl.domino.data.Database db)
                                                                           throws java.lang.Exception

Parameters:

formulaString - Formula to run

doc - Document to evaluate the formula against

db - Host database

Returns:

result of the formula execution

Throws:

java.lang.Exception

modifyFormulaForUser

public java.lang.String modifyFormulaForUser(java.lang.String formula,
                                             com.hcl.domino.data.Document doc,
                                             com.hcl.domino.data.Database db)

Parameters:

formula -

• Lotus \@Formula to be evaluated

doc -

db -

• database

Returns:

Adjusted formula for current user

processItemRequired

public boolean processItemRequired(com.hcl.domino.data.Item item,
                                   java.util.Map<java.lang.String,java.lang.String> fieldMap,
                                   java.util.TreeMap<java.lang.String,java.lang.Object> itemsAlreadyProcessed,
                                   java.util.Set<KeepJnxSession.Note2JsonOptions> options)

Determines if an item needs to be processed and converted into JSON

Parameters:

item - the NoteItem to look at. Can be any type

fieldMap - the map with inclusion or exclusion values based on options

itemsAlreadyProcessed - Set of item names that we covered before

options - EnumSet with options to check @see KeepJnxSession.Notes2JsonOptions

Returns:

true if the item needs processing

readDocToMIME

public void readDocToMIME(com.hcl.domino.data.Document doc,
                          java.io.Writer writer,
                          java.lang.Class<?> clazz)
                   throws java.io.IOException

Reads the raw mime Stream from a NotesItem into a writer, based on options. The optional class is used

Parameters:

doc -

writer -

• writer where content goes

clazz -

• what class did call that method

Throws:

java.io.IOException

readRawMIME

public void readRawMIME(com.hcl.domino.data.Document doc,
                        java.lang.String itemName,
                        java.io.Writer writer,
                        java.util.Set<com.hcl.domino.mime.MimeReader.ReadMimeDataType> options,
                        java.lang.Class<?> clazz)
                 throws java.io.IOException

Reads the raw mime Stream from a NotesItem into a writer, based on options. The optional class is used

Parameters:

doc -

• The MIME containing notes document

itemName -

• the item name, defaults to “Body”

writer -

• writer where content goes

options -

• execution options, include headers yes/no

clazz -

• what class did call that method

Throws:

java.io.IOException

startOOOOperation

public com.hcl.domino.person.OutOfOffice startOOOOperation(java.lang.String userName,
                                                           java.lang.String mailServer,
                                                           boolean isMailServer,
                                                           com.hcl.domino.data.Database db)

Parameters:

userName -

• user name

mailServer -

• a server name, preferably the user’s mail server

isMailServer -

• boolean to indicate if the server listed is a mail server

db -

• the user’s mail db; if null the db will be looked up, opened, and returned

Returns:

• the resulting NotesOOOContext object

updateDocFromJson

public void updateDocFromJson(io.vertx.core.json.JsonObject jsonSource,
                              com.hcl.domino.data.Document doc)

Write fields into a pre-created document, without validation against a Form Access Mode. NOTE: This does not save the document

Parameters:

jsonSource -

• JsonObject containing fields to set

doc -

• Document to update

validateAccessRequest

public void validateAccessRequest(com.hcl.domino.data.Database db,
                                  com.hcl.domino.security.AclLevel minimumRequiredAclLevel,
                                  java.util.Set<AclAccessFlags> aclAccessFlags,
                                  java.util.Set<java.lang.String> accessRolesRequired)
                           throws KeepException

Parameters:

db -

• The Database (DominoJNX)

minimumRequiredAclLevel -

• minimum level of access required, might be null

aclAccessFlags -

• various access flags to check (e.g. createDocument)

accessRolesRequired -

• List of Role names, user needs to have ONE of them

Throws:

KeepException -

• when access levels are missed

validateAttachmentAccessRequest

public com.hcl.domino.data.Document validateAttachmentAccessRequest(@Nonnull
                                                                    com.hcl.domino.data.Database db,
                                                                    @Nonnull
                                                                    java.lang.String unid,
                                                                    java.lang.String fileName,
                                                                    @Nonnull
                                                                    DocumentAccess docAccess)
                                                             throws KeepException

Validates request for attachment reading / writing

Parameters:

db - database from which to retrieve the attachment

unid - UniversalID of the document containing or to contain the note

fileName - filename for the attachment

docAccess - whether AUTHOR / EDITOR access is required

Returns:

Document containing or to contain the attachment

Throws:

KeepException - validation error

validateDocumentAccessRequest

public com.hcl.domino.data.Document validateDocumentAccessRequest(com.hcl.domino.data.Database db,
                                                                  java.lang.String unid,
                                                                  DocumentAccess docAccess)
                                                           throws KeepException

Validates the user has access to read and, if required, write the document Checks for the document directly, we presume ACL check has been done already if the document is protected by a reader field it will return a not found error

Parameters:

db - Database containing the document

unid - UniversalID of the document

docAccess - whether or not to check for write access

Returns:

Document if validation is passed

Throws:

KeepException - error if validation fails

validateFormAccessFormula

public void validateFormAccessFormula(java.lang.String formula,
                                      com.hcl.domino.data.Document doc,
                                      java.lang.String apiName)
                               throws KeepException

Validate the user has access to perform an action using a FormAccessMode, according to the DQL access formula in the KeepConfig

Parameters:

formula -

• formula to check for access

doc -

• document to validate against

apiName -

Throws:

KeepException - error, e.g. not enough access or failure parsing formula

writeRawMIME

public void writeRawMIME(com.hcl.domino.data.Document doc,
                         java.io.Reader reader)
                  throws java.io.IOException

Parameters:

doc -

reader -

Throws:

java.io.IOException