com.hcl.domino.keep.dbrequests

Class AsyncDominoJNXJson

java.lang.Object

com.hcl.domino.keep.dbrequests.AsyncDominoJNX<io.vertx.core.json.JsonObject>

com.hcl.domino.keep.dbrequests.AsyncDominoJNXJson

All Implemented Interfaces:

AsyncDominoBase<io.vertx.core.json.JsonObject>, KeepSubscriberInfo, io.reactivex.ObservableOnSubscribe<io.vertx.core.json.JsonObject>

Direct Known Subclasses:

AbstractAsyncDominoAdmin, AbstractAsyncDominoUser, AddRemoveToLabel, AddSMTPserver, AuthLocal, AuthLogin, AuthLoginBasic, AuthLogout, AuthRenewJwt, CancelAgent, CreateCalendarEntry, CreateCalendarResponse, CreateCalendars, CreateDbConfig, CreateDocument, CreateDocumentAttachment, CreateKeepApplication, CreateKeepConfig, CreateLabel, CreateLdapDirectory, CreateLetsEncryptCertificates, CreateMessage, CreateMimeMessage, CreateNotebookEntry, CreateNSF, CreatePerson, CreatePersonalMailingList, CreatePimAttachment, CreatePublicGroup, CreatePublicPerson, CreateReplaceDelegation, CreateRule, CreateRules, CreateTask, CreateTaskResponse, CreateTemplate, CreateUser, DeleteCache, DeleteCalendarEntry, DeleteDbConfig, DeleteDelegation, DeleteDirectoryInformation, DeleteDocument, DeleteDocumentAttachment, DeleteDxl, DeleteFormMode, DeleteKeepApplication, DeleteLabel, DeleteMailAttachment, DeleteMimeMessage, DeleteNotebookEntry, DeleteOneCalendar, DeletePerson, DeletePersonalMailingList, DeletePublicPerson, DeleteRule, DeleteRules, DeleteSharedGroup, DeleteSMTPserver, DeleteTask, DeleteTaskResponse, DeleteTemplate, DeleteTLSCertificates, DeleteUser, DesignGetformmodes, EmptyTrash, Execute, ExecuteAgent, ExecuteAgentAsync, ExecuteAgentWithContext, ExecuteGroovy, ExecuteJavaScriptWithContext, FetchAllApplications, FetchAllKeepDbs, FetchDesignAll, FetchDesignType, FetchFormModes, FetchKeepDbs, FetchMyApplications, FetchNsfList, FetchOdata, FetchOdataList, FetchViewEntries, FetchViews, GenerateKeepApplicationSecret, GetAddressLookupQuery, GetAddressLookupSimple, GetAgentInfo, GetCache, GetCalendarEntry, GetCalendarResponses, GetCalendars, GetCaList, GetCollection, GetDbConfig, GetDelegation, GetDirectoryInformation, GetDocument, GetDocumentFormModes, GetEntriesInfo, GetKeepApplication, GetKeepConfig, GetLabelInfo, GetLabels, GetLabelsAll, GetLdapDirectory, GetMailboxInfo, GetMessage, GetMessageHeaders, GetNotebookEntry, GetOdataItem, GetOdataMetadata, GetOdataServiceInfo, GetOneCalendar, GetOOO, GetOpenAPI, GetPerson, GetPersonalMailingList, GetPimItem, GetPublicGroup, GetPublicPerson, GetPublicResources, GetRule, GetSettings, GetSMTPserver, GetTask, GetTaskResponse, GetTaskResponses, GetTemplate, GetUser, GetUsers, HardDeleteDocument, LookupUserInfo, ModifyCalendarEntry, MoveLabel, PatchKeepApplication, PatchTask, PostSettings, PostTask, PutPerson, PutTrash, Query, QueryBusyTime, QueryFreetime, QueryOOO, RestoreFromTrash, RunFormula, SearchPIM, UpdateCalendarEntry, UpdateCreateDesign, UpdateCreateForm, UpdateCreateFormMode, UpdateCreateView, UpdateDbConfig, UpdateDelegation, UpdateDirectoryInformation, UpdateDocument, UpdateDominoDirectory, UpdateDxl, UpdateKeepConfig, UpdateLabel, UpdateLdapDirectory, UpdateMessage, UpdateMessageProperties, UpdateNotebookEntry, UpdateOOO, UpdatePersonalMailingList, UpdatePimItem, UpdatePublicGroup, UpdatePublicPerson, UpdateRule, UpdateRules, UpdateSamlConfig, UpdateSMTPServer, UpdateTaskResponse, UpdateTemplate, UpdateUser, UploadUserCertificate

public abstract class AsyncDominoJNXJson
extends AsyncDominoJNX<io.vertx.core.json.JsonObject>

Base class for all DB Operations that return a buffer (and not JSON)

Nested Class Summary

Nested classes/interfaces inherited from interface com.hcl.domino.keep.dbrequests.AsyncDominoBase

AsyncDominoBase.RequestType

Field Summary

Fields inherited from class com.hcl.domino.keep.dbrequests.AsyncDominoJNX

apiName, appTags, logger, requestParams, UNNEEDED_CALL, user, vertx

Constructor Summary

Constructors

Constructor and Description
AsyncDominoJNXJson()

Method Summary

Modifier and Type	Method and Description
DbRequestParameters<io.vertx.core.json.JsonObject>	getDbRequestParameters(KeepJnxSession session, com.hcl.domino.DominoClient client, com.hcl.domino.data.Database db, io.reactivex.Observer<io.vertx.core.json.JsonObject> observer, io.vertx.core.json.JsonObject incoming, java.lang.String eventBusId) Returns the flexible DBRequest object that is used for calling processPayload

Methods inherited from class com.hcl.domino.keep.dbrequests.AsyncDominoJNX

accessControlCheck, dontCallProcessPayload, emitterToObserver, getActualDatabaseName, getApiName, getAppTags, getBarbican, getEventbusId, getKeepDbInfo, getRequestType, getSubscriber, getUser, getUserForMetrics, isProcessPayloadRequired, isWorkInProgress, processDominoRequest, recordAppMetrics, setApiName, setBarbican, setDbFileName, setKeepDbInfo, setProcessPayloadRequired, setRequestParams, setRequestType, setSubscriber, setUser, setVertx, subscribe, validateDqlAccess, validateOpenAccess, validationCheck

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hcl.domino.keep.dbrequests.AsyncDominoBase

customValidator, preflight, process

Constructor Detail

AsyncDominoJNXJson

public AsyncDominoJNXJson()

Method Detail

getDbRequestParameters

public DbRequestParameters<io.vertx.core.json.JsonObject> getDbRequestParameters(KeepJnxSession session,
                                                                                 com.hcl.domino.DominoClient client,
                                                                                 com.hcl.domino.data.Database db,
                                                                                 io.reactivex.Observer<io.vertx.core.json.JsonObject> 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

db - Domino database to act on

observer - The observer to report errors to

incoming - the JSON parameters

eventBusId - what operation do we attempt

client - DominoClient

Returns:

request object containing Session, Database etc

Throws:

KeepExceptionMissingParameters