com.hcl.domino.keep.dbrequests.data

Class GetDocumentAttachment

java.lang.Object

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

com.hcl.domino.keep.dbrequests.AsyncDominoJNXBuffer

com.hcl.domino.keep.dbrequests.data.GetDocumentAttachment

All Implemented Interfaces:

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

@MinimumAcl(value=READER)
public class GetDocumentAttachment
extends AsyncDominoJNXBuffer

Endpoint to stream an attachment from a document

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

Method Summary

Modifier and Type	Method and Description
void	process(DbRequestParameters<io.vertx.core.buffer.Buffer> request) Actual work is done here.
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.AsyncDominoJNXBuffer

getDbRequestParameters

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

Constructor Detail

GetDocumentAttachment

public GetDocumentAttachment()

Method Detail

process

public void process(DbRequestParameters<io.vertx.core.buffer.Buffer> request)
             throws java.lang.Exception

Description copied from interface: AsyncDominoBase

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

processDominoRequest

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

Description copied from class: AsyncDominoJNXBuffer

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 AsyncDominoJNXBuffer

Parameters:

incoming -

• the message triggering the database action