com.hcl.domino.keep.dbrequests

Class AsyncDominoJNXBuffer

java.lang.Object

com.hcl.domino.keep.dbrequests.AsyncDominoJNX<io.vertx.core.buffer.Buffer>

com.hcl.domino.keep.dbrequests.AsyncDominoJNXBuffer

All Implemented Interfaces:

AsyncDominoBase<io.vertx.core.buffer.Buffer>, KeepSubscriberInfo, io.reactivex.ObservableOnSubscribe<io.vertx.core.buffer.Buffer>

Direct Known Subclasses:

GetDocumentAttachment, GetDxl, GetMailAttachment, GetMessageBody, GetMimeMessage

public abstract class AsyncDominoJNXBuffer
extends AsyncDominoJNX<io.vertx.core.buffer.Buffer>

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
AsyncDominoJNXBuffer()

Method Summary

Modifier and Type	Method and Description
DbRequestParameters<io.vertx.core.buffer.Buffer>	getDbRequestParameters(KeepJnxSession session, com.hcl.domino.DominoClient client, com.hcl.domino.data.Database db, io.reactivex.Observer<io.vertx.core.buffer.Buffer> observer, io.vertx.core.json.JsonObject incoming, java.lang.String eventBusId) Returns the flexible DBRequest object that is used for calling process
protected void	processDominoRequest(io.vertx.core.eventbus.Message<io.vertx.core.json.JsonObject> incoming) The processDominoRequest method provides the EventBusResponseSubscriber that listens to the result of the database operation.

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, 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

AsyncDominoJNXBuffer

public AsyncDominoJNXBuffer()

Method Detail

getDbRequestParameters

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

Returns the flexible DBRequest object that is used for calling process

Parameters:

session - Domino session with user identity

db - Domino database to act on

observer - The observer to report errors tp

incoming - the JSON parameters

eventBusId - what operation do we attempt

client - DominoClient

Returns:

request object containing Session, Database etc

Throws:

KeepExceptionMissingParameters

processDominoRequest

protected void processDominoRequest(@Nonnull
                                    io.vertx.core.eventbus.Message<io.vertx.core.json.JsonObject> incoming)

The processDominoRequest method provides the EventBusResponseSubscriber that listens to the result of the database operation. Most operations return JSON, but some (Attachments, MIME content) use Buffers. This default method uses JSON responses, overwrite this method in your extension to AsyncDominoJNX with an EventBusResponseSubscriber expecting your data type

Overrides:

processDominoRequest in class AsyncDominoJNX<io.vertx.core.buffer.Buffer>

Parameters:

incoming -

• the message triggering the database action