com.hcl.domino.keep.dbrequests

Interface AsyncDominoBase<T>

Type Parameters:

T - Payload that is going over the wire, typically JsonObject or Buffer

All Superinterfaces:

KeepSubscriberInfo

All Known Implementing Classes:

AbstractAsyncDominoAdmin, AbstractAsyncDominoDirectory, AbstractAsyncDominoUser, AddRemoveToLabel, AddSMTPserver, AsyncDominoJNX, AsyncDominoJNXBuffer, AsyncDominoJNXJson, AuthLocal, AuthLogin, AuthLoginBasic, AuthLogout, AuthRenewJwt, CancelAgent, CreateCalendarEntry, CreateCalendarResponse, CreateCalendars, CreateDbConfig, CreateDirectoryAssistance, CreateDocument, CreateDocumentAttachment, CreateGroup, CreateKeepApplication, CreateKeepConfig, CreateLabel, CreateLdapDirectory, CreateLetsEncryptCertificates, CreateLocalUser, CreateMessage, CreateMimeMessage, CreateNotebookEntry, CreateNSF, CreatePerson, CreatePersonalMailingList, CreatePimAttachment, CreatePublicGroup, CreatePublicPerson, CreateReplaceDelegation, CreateRule, CreateRules, CreateSamlConfig, CreateTask, CreateTaskResponse, CreateTemplate, CreateUser, DeleteAclEntry, DeleteCache, DeleteCalendarEntry, DeleteDbConfig, DeleteDelegation, DeleteDirectoryAssistance, DeleteDirectoryInformation, DeleteDocument, DeleteDocumentAttachment, DeleteDxl, DeleteFormMode, DeleteGroup, DeleteKeepApplication, DeleteLabel, DeleteLocalUser, DeleteMailAttachment, DeleteMimeMessage, DeleteNotebookEntry, DeleteOneCalendar, DeletePerson, DeletePersonalMailingList, DeletePublicPerson, DeleteRole, DeleteRule, DeleteRules, DeleteSharedGroup, DeleteSMTPserver, DeleteTask, DeleteTaskResponse, DeleteTemplate, DeleteTLSCertificates, DeleteUser, DesignGetformmodes, EmptyTrash, Execute, ExecuteAgent, ExecuteAgentAsync, ExecuteAgentWithContext, ExecuteGroovy, ExecuteJavaScript, ExecuteJavaScriptWithContext, FetchAclEntries, FetchAllApplications, FetchAllKeepDbs, FetchDesignAll, FetchDesignType, FetchFormModes, FetchKeepDbs, FetchMyApplications, FetchNsfList, FetchOdata, FetchOdataList, FetchRoles, FetchViewEntries, FetchViews, GenerateKeepApplicationSecret, GetAclEntry, GetAddressLookupQuery, GetAddressLookupSimple, GetAgentInfo, GetCache, GetCalendarEntry, GetCalendarResponses, GetCalendars, GetCaList, GetCollection, GetDbConfig, GetDelegation, GetDesign, GetDirectoryAssistance, GetDirectoryInformation, GetDocument, GetDocumentAttachment, GetDocumentFormModes, GetDrafts, GetDxl, GetEntriesInfo, GetGroup, GetGroupByName, GetInbox, GetJunkEmail, GetKeepApplication, GetKeepConfig, GetLabelInfo, GetLabels, GetLabelsAll, GetLdapDirectory, GetLocalUser, GetMailAttachment, GetMailboxInfo, GetMailThread, GetMessage, GetMessageBody, GetMessageHeaders, GetMessageList, GetMessagesWithLabel, GetMimeMessage, GetNotebookEntries, GetNotebookEntry, GetOdataItem, GetOdataMetadata, GetOdataServiceInfo, GetOneCalendar, GetOOO, GetOpenAPI, GetPeople, GetPerson, GetPersonalMailingList, GetPersonalMailingLists, GetPimItem, GetPublicGroup, GetPublicGroups, GetPublicPeople, GetPublicPerson, GetPublicResources, GetRoleInfo, GetRule, GetRules, GetSentList, GetSettings, GetSMTPserver, GetTask, GetTaskList, GetTaskResponse, GetTaskResponses, GetTemplate, GetTemplates, GetTrash, GetUser, GetUsers, HardDeleteDocument, LookupUserInfo, ModifyCalendarEntry, MoveLabel, PatchKeepApplication, PatchTask, PostSettings, PostTask, PutPerson, PutTrash, Query, QueryBusyTime, QueryFreetime, QueryOOO, ReplaceCreateAclEntry, ReplaceCreateRole, RestoreFromTrash, RunFormula, SearchPIM, TestLdap, UpdateCalendarEntry, UpdateCreateDesign, UpdateCreateForm, UpdateCreateFormMode, UpdateCreateView, UpdateDbConfig, UpdateDelegation, UpdateDirectoryAssistance, UpdateDirectoryInformation, UpdateDocument, UpdateDominoDirectory, UpdateDxl, UpdateGroup, UpdateGroupMembers, UpdateKeepConfig, UpdateLabel, UpdateLdapDirectory, UpdateLocalUser, UpdateMessage, UpdateMessageProperties, UpdateMimeMessage, UpdateNotebookEntry, UpdateOOO, UpdatePersonalMailingList, UpdatePimItem, UpdatePublicGroup, UpdatePublicPerson, UpdateRoleHolders, UpdateRule, UpdateRules, UpdateSamlConfig, UpdateSMTPServer, UpdateTaskResponse, UpdateTemplate, UpdateUser, UploadUserCertificate

public interface AsyncDominoBase<T>
extends KeepSubscriberInfo

Core Interface that all handling classes that interact with Domino implement Works for both DominoJNA and

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AsyncDominoBase.RequestType Authentication type used to field the request

Method Summary

Modifier and Type	Method and Description
default java.util.function.Predicate<io.vertx.core.json.JsonObject>	customValidator() Additional validation that is not covered by the OpenAPI specification or otherwise default is: validation is OK
java.lang.String	getApiName()
java.util.List<io.micrometer.core.instrument.Tag>	getAppTags()
TheBarbican	getBarbican()
DbRequestParameters<T>	getDbRequestParameters(KeepJnxSession session, com.hcl.domino.DominoClient client, com.hcl.domino.data.Database db, io.reactivex.Observer<T> observer, io.vertx.core.json.JsonObject incoming, java.lang.String eventBusId) Returns the flexible DBRequest object that is used for calling processPayload
AsyncDominoBase.RequestType	getRequestType()
KeepUser	getUser()
boolean	isProcessPayloadRequired() Check if we need to execute processPayload or everything was done in preflight or elsewhere asynchronously
default io.vertx.core.Future<java.lang.Void>	preflight(java.lang.String userName, io.vertx.core.json.JsonObject incoming) Preflight is called BEFORE we establish a NotesSession/Database and returns a Future.
void	process(DbRequestParameters<T> request) Actual work is done here.
void	setApiName(java.lang.String apiName) Sets the OperationId / APIName the implementing class is reacting to typically matched the class name
void	setDbFileName(java.lang.String dbFileName) Overwrite the physical file name for the database to act on.
void	setKeepDbInfo(KeepDbInfo keepDbInfo) Provides the database information like path and configured forms to the method.
void	setProcessPayloadRequired(boolean processPayloadRequired) When set to false no code in process incoming is executed usually added when everything is done async in preflight
void	setRequestParams(io.vertx.core.json.JsonObject source) Updates the parameter object coming in from the request
AsyncDominoBase<T>	setRequestType(AsyncDominoBase.RequestType requestType)
void	setSubscriber(io.reactivex.ObservableEmitter<T> subscriber) Sets the subscriber receiving the events that the class generates from interacting with the database.
void	setUser(KeepUser user) Overwrite the user to act upon.
void	setVertx(io.vertx.core.Vertx vertx) Inject the runtime into the request

Method Detail

customValidator

default java.util.function.Predicate<io.vertx.core.json.JsonObject> customValidator()

Additional validation that is not covered by the OpenAPI specification or otherwise default is: validation is OK

Returns:

Function that validates the incoming data

getApiName

java.lang.String getApiName()

Specified by:

getApiName in interface KeepSubscriberInfo

Returns:

the API Name of the database in use

getAppTags

java.util.List<io.micrometer.core.instrument.Tag> getAppTags()

Returns:

List of metrics tags currently applied

getBarbican

TheBarbican getBarbican()

Returns:

instance of the Barbican, representing data access module

getDbRequestParameters

DbRequestParameters<T> getDbRequestParameters(KeepJnxSession session,
                                              com.hcl.domino.DominoClient client,
                                              com.hcl.domino.data.Database db,
                                              io.reactivex.Observer<T> observer,
                                              io.vertx.core.json.JsonObject incoming,
                                              java.lang.String eventBusId)
                                       throws KeepExceptionMissingParameters

Returns the flexible DBRequest object that is used for calling processPayload

Parameters:

session - Domino session with user identity

client - DominoClient

db - Domino database to act on

observer - The observer to report errors tp

incoming - the JSON parameters

eventBusId - what operation do we attempt

Returns:

request object containing Session, Database etc

Throws:

KeepExceptionMissingParameters

getRequestType

AsyncDominoBase.RequestType getRequestType()

Returns:

RequestType used for metrics

getUser

KeepUser getUser()

Specified by:

getUser in interface KeepSubscriberInfo

Returns:

the current Domino User

isProcessPayloadRequired

boolean isProcessPayloadRequired()

Check if we need to execute processPayload or everything was done in preflight or elsewhere asynchronously

Returns:

the processPayloadRequired

preflight

default io.vertx.core.Future<java.lang.Void> preflight(@Nonnull
                                                       java.lang.String userName,
                                                       @Nonnull
                                                       io.vertx.core.json.JsonObject incoming)

Preflight is called BEFORE we establish a NotesSession/Database and returns a Future. Anything that needs to happen asynchronously needs to happen here, so the runtime has a chance to wait for completion

Parameters:

userName -

• Current username executing preflight

incoming -

• requested data

Returns:

• Future - are we good to go?

process

void process(DbRequestParameters<T> request)
      throws java.lang.Exception

Actual work is done here. The DbRequestParameters injects all needed components as well as functions like validation and results

Parameters:

request - DbRequestParameters granting access to session and database

Throws:

java.lang.Exception - Anything that can go wrong, will go wrong

setApiName

void setApiName(java.lang.String apiName)

Sets the OperationId / APIName the implementing class is reacting to typically matched the class name

Parameters:

apiName - the apiName to set

setDbFileName

void setDbFileName(java.lang.String dbFileName)

Overwrite the physical file name for the database to act on. Used in mail and testing scenarios

Parameters:

dbFileName - the dbFileName to set

setKeepDbInfo

void setKeepDbInfo(KeepDbInfo keepDbInfo)

Provides the database information like path and configured forms to the method. Important for subrequest handling

Parameters:

keepDbInfo - KeepDbInfo object for the database to be queried

setProcessPayloadRequired

void setProcessPayloadRequired(boolean processPayloadRequired)

When set to false no code in process incoming is executed usually added when everything is done async in preflight

Parameters:

processPayloadRequired - the processPayloadRequired to set

setRequestParams

void setRequestParams(io.vertx.core.json.JsonObject source)

Updates the parameter object coming in from the request

Parameters:

source -

setRequestType

AsyncDominoBase<T> setRequestType(AsyncDominoBase.RequestType requestType)

Parameters:

requestType - used for metrics

Returns:

this

setSubscriber

void setSubscriber(io.reactivex.ObservableEmitter<T> subscriber)

Sets the subscriber receiving the events that the class generates from interacting with the database. Could be and EventbusResponseSubscriber or a SubTask or a KeepTestSubscriber

Parameters:

subscriber - the subscriber to set

setUser

void setUser(KeepUser user)

Overwrite the user to act upon. Used in delegation scenarios or for test environments (doesn’t bypass security)

Parameters:

user - the KeepUser to set, alternative to user from KeepJnxSession

setVertx

void setVertx(io.vertx.core.Vertx vertx)

Inject the runtime into the request

Parameters:

vertx -

• Event runtime