com.hcl.domino.keep.security

Class TheBarbican

java.lang.Object

com.hcl.domino.keep.security.TheBarbican

public class TheBarbican
extends java.lang.Object

Module that ensures read & write access to documents is managed by the KeepConfig Configuration has convenience functions to check on forms, aliases and fields TODO: Extract API

Constructor Summary

Constructors

Constructor and Description
TheBarbican(KeepDbInfo dbInfo) Default constructor, the Barbican always works in the context of a database, so we init it with the configuration info of that database

Method Summary

Modifier and Type	Method and Description
boolean	barbicanAllowsThisDocument(KeepJnxSession s, com.hcl.domino.data.Database parentDB, com.hcl.domino.data.Document doc, java.lang.String formModeName, java.lang.String realFormName) Check if we can process these documents
boolean	deleteKeepApplicationByApiKey(KeepJnxSession s, java.lang.String appId) Deletes an KeepApplication document
boolean	deleteNote(KeepJnxSession s, com.hcl.domino.data.Database parentDB, java.lang.String dbFormName, java.lang.String dbModeName, com.hcl.domino.data.Document note)
io.vertx.core.json.JsonObject	filterDocument(KeepJnxSession s, java.lang.String modeName, com.hcl.domino.data.Document note)
io.vertx.core.json.JsonObject	filterDocumentSilent(KeepJnxSession s, java.lang.String modeName, com.hcl.domino.data.Document note) Like filterDocument, but no error bubbles up
java.lang.String	getRealFormName(com.hcl.domino.data.Database db, com.hcl.domino.data.Document note, java.lang.String overrideFormName)
java.lang.String	getRealFormName(com.hcl.domino.data.Database db, java.lang.String formName)
boolean	hasForm(java.lang.String formName) Returns if a specific form with any mode exist in the configuration Takes aliases into account
boolean	hasFormAndMode(java.lang.String formName, java.lang.String modeName) Returns if a specific form and mode exist in the configuration Takes aliases into account
KeepApplicationConfigInfo	retrieveKeepApplicationByApiKey(KeepJnxSession s, java.lang.String appId)
io.vertx.core.json.JsonObject	updateDocument(KeepJnxSession s, com.hcl.domino.data.Database parentDB, java.lang.String modeName, com.hcl.domino.data.Document note, io.vertx.core.json.JsonObject payload, java.lang.String parentUnid)
TheBarbican	updateNoteFromPayloadWithMode(KeepJnxSession s, com.hcl.domino.data.Database parentDB, io.vertx.core.json.JsonObject payload, com.hcl.domino.data.Document note, FormAccessModeInfo mode, java.lang.String apiName, java.lang.String parentUnid)
TheBarbican	validateFormAccessFormula(KeepJnxSession s, com.hcl.domino.data.Database parentDB, java.lang.String formula, com.hcl.domino.data.Document note, 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

Methods inherited from class java.lang.Object

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

Constructor Detail

TheBarbican

public TheBarbican(@Nonnull
                   KeepDbInfo dbInfo)

Default constructor, the Barbican always works in the context of a database, so we init it with the configuration info of that database

Parameters:

dbInfo -

• Database configuration info

Method Detail

deleteKeepApplicationByApiKey

public boolean deleteKeepApplicationByApiKey(KeepJnxSession s,
                                             java.lang.String appId)

Deletes an KeepApplication document

Parameters:

s -

appId -

Returns:

true/false

deleteNote

public boolean deleteNote(KeepJnxSession s,
                          com.hcl.domino.data.Database parentDB,
                          java.lang.String dbFormName,
                          java.lang.String dbModeName,
                          com.hcl.domino.data.Document note)
                   throws KeepException

Parameters:

s -

• The Keep Session

dbModeName -

• Name of the mode

dbFormName -

• Name of the form

note -

• Document to be processed

Returns:

true/false if deletion is permitted

Throws:

KeepException

filterDocument

public io.vertx.core.json.JsonObject filterDocument(KeepJnxSession s,
                                                    java.lang.String modeName,
                                                    com.hcl.domino.data.Document note)
                                             throws KeepException

Parameters:

s -

• KeepSession

modeName - Mode - to be used

note -

• NotesDocument

Returns:

JsonObject filtered document based on mode

Throws:

KeepException

filterDocumentSilent

public io.vertx.core.json.JsonObject filterDocumentSilent(KeepJnxSession s,
                                                          java.lang.String modeName,
                                                          com.hcl.domino.data.Document note)

Like filterDocument, but no error bubbles up

Parameters:

s - session

modeName -

note -

Returns:

Json or null

hasForm

public boolean hasForm(java.lang.String formName)

Returns if a specific form with any mode exist in the configuration Takes aliases into account

Parameters:

formName -

Returns:

true if form exist

hasFormAndMode

public boolean hasFormAndMode(java.lang.String formName,
                              java.lang.String modeName)

Returns if a specific form and mode exist in the configuration Takes aliases into account

Parameters:

formName -

modeName -

Returns:

true if form and mode exist

retrieveKeepApplicationByApiKey

public KeepApplicationConfigInfo retrieveKeepApplicationByApiKey(KeepJnxSession s,
                                                                 java.lang.String appId)
                                                          throws KeepException

Parameters:

s -

appId -

Returns:

A note with Application information

Throws:

KeepException

updateDocument

public io.vertx.core.json.JsonObject updateDocument(KeepJnxSession s,
                                                    com.hcl.domino.data.Database parentDB,
                                                    java.lang.String modeName,
                                                    com.hcl.domino.data.Document note,
                                                    io.vertx.core.json.JsonObject payload,
                                                    java.lang.String parentUnid)
                                             throws java.lang.Exception

Parameters:

s -

parentDB -

modeName -

note -

payload -

parentUnid -

Returns:

the updated document

Throws:

java.lang.Exception

java.lang.Throwable

updateNoteFromPayloadWithMode

public TheBarbican updateNoteFromPayloadWithMode(KeepJnxSession s,
                                                 com.hcl.domino.data.Database parentDB,
                                                 io.vertx.core.json.JsonObject payload,
                                                 com.hcl.domino.data.Document note,
                                                 FormAccessModeInfo mode,
                                                 java.lang.String apiName,
                                                 java.lang.String parentUnid)
                                          throws java.lang.Exception

Parameters:

s -

parentDB -

payload -

note -

mode -

apiName -

parentUnid -

Returns:

fluent

Throws:

java.lang.Exception

validateFormAccessFormula

public TheBarbican validateFormAccessFormula(KeepJnxSession s,
                                             com.hcl.domino.data.Database parentDB,
                                             java.lang.String formula,
                                             com.hcl.domino.data.Document note,
                                             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:

s -

parentDB -

formula -

• formula to check for access

note -

• document to validate against

apiName -

Returns:

fluent

Throws:

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

barbicanAllowsThisDocument

public boolean barbicanAllowsThisDocument(KeepJnxSession s,
                                          com.hcl.domino.data.Database parentDB,
                                          com.hcl.domino.data.Document doc,
                                          java.lang.String formModeName,
                                          java.lang.String realFormName)
                                   throws KeepExceptionInsufficientAccess

Check if we can process these documents

Parameters:

s - The Keep Session

parentDB - containing the document to validate

doc - to validate

formModeName - to verify

realFormName - formName, if passed

Returns:

whether the form access mode to check exists

Throws:

KeepExceptionInsufficientAccess

getRealFormName

public java.lang.String getRealFormName(@Nonnull
                                        com.hcl.domino.data.Database db,
                                        java.lang.String formName)

Parameters:

db - Database containing the form

formName - Form name or alias

Returns:

Actual form name - we may have been passed an alias

getRealFormName

public java.lang.String getRealFormName(@Nonnull
                                        com.hcl.domino.data.Database db,
                                        @Nonnull
                                        com.hcl.domino.data.Document note,
                                        java.lang.String overrideFormName)

Parameters:

db - Database containing the form

note - Note to check

overrideFormName - Form name to use instead

Returns:

Actual form name - we may have been passed an alias