com.hcl.domino.keep.dbrequests.designcode

Class GetDxl

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.designcode.GetDxl

All Implemented Interfaces:

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

@MinimumAcl(value=DESIGNER)
public class GetDxl
extends AsyncDominoJNXBuffer

Extract the entire design from a database into 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
GetDxl()

Method Summary

Modifier and Type	Method and Description
io.vertx.core.Future<java.lang.Void>	preflight(java.lang.String userName, io.vertx.core.json.JsonObject payload) Preflight is called BEFORE we establish a NotesSession/Database and returns a Future.
void	process(DbRequestParameters<io.vertx.core.buffer.Buffer> request) Actual work is done here.

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

getDbRequestParameters, processDominoRequest

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

Constructor Detail

GetDxl

public GetDxl()

Method Detail

preflight

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

Description copied from interface: AsyncDominoBase

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

payload -

• requested data

Returns:

• Future - are we good to go?

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