com.hcl.domino.keep.dbrequests

Class AsyncDominoJNX<T>

java.lang.Object

com.hcl.domino.keep.dbrequests.AsyncDominoJNX<T>

Type Parameters:

T - Class of Request

All Implemented Interfaces:

AsyncDominoBase<T>, KeepSubscriberInfo, io.reactivex.ObservableOnSubscribe<T>

Direct Known Subclasses:

AsyncDominoJNXBuffer, AsyncDominoJNXJson

public abstract class AsyncDominoJNX<T>
extends java.lang.Object
implements AsyncDominoBase<T>, io.reactivex.ObservableOnSubscribe<T>

Interaction with the Domino backend to execute requests based on DominoJNX

Nested Class Summary

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

AsyncDominoBase.RequestType

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	apiName
protected java.util.List<io.micrometer.core.instrument.Tag>	appTags
protected static org.slf4j.Logger	logger
protected io.vertx.core.json.JsonObject	requestParams
static java.lang.String	UNNEEDED_CALL
protected KeepUser	user
protected io.vertx.core.Vertx	vertx

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AsyncDominoJNX() Default constructor for easy object creation

Method Summary

Modifier and Type	Method and Description
void	accessControlCheck(KeepJnxSession session, com.hcl.domino.data.Database db) Checks if the current user has the required access to perform the operation on a given database
protected void	dontCallProcessPayload()
protected io.reactivex.Observer<T>	emitterToObserver(io.reactivex.ObservableEmitter<T> oe)
protected io.vertx.core.Future<java.lang.String>	getActualDatabaseName(KeepUser actualUser, io.vertx.core.json.JsonObject payloadData)
java.lang.String	getApiName()
java.util.List<io.micrometer.core.instrument.Tag>	getAppTags()
TheBarbican	getBarbican()
java.lang.String	getEventbusId()
protected KeepDbInfo	getKeepDbInfo()
AsyncDominoBase.RequestType	getRequestType()
protected io.reactivex.ObservableEmitter<T>	getSubscriber()
KeepUser	getUser()
protected java.lang.String	getUserForMetrics()
boolean	isProcessPayloadRequired() Check if we need to execute processPayload or everything was done in preflight asynchronously
boolean	isWorkInProgress() Is the implementation of the (sub)class still work in progress? Needs to be overwritten by subclasses
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.
protected void	recordAppMetrics(java.lang.String appId) Records the use of this API for an application
void	setApiName(java.lang.String apiName) Sets the OperationId / APIName the implementing class is reacting to typically matched the class name
void	setBarbican(TheBarbican barbican) Setter for TheBarbican, allowing a mock TheBarbican to be used in tests
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
void	subscribe(io.reactivex.ObservableEmitter<T> newSubscriber) Execution of the request inside a vert.x execute Blocking to ensure we don’t block the event loop Loads user and apiName (?db= query string param) from the observer
protected void	validateDqlAccess(KeepJnxSession s, com.hcl.domino.data.Database db) Validate the user has access to run DQL, according to the DQL access formula in the KeepConfig
protected void	validateOpenAccess()
protected boolean	validationCheck(boolean status, java.lang.String message, java.lang.Object... params) Helper class to log failures to local onError method of subscriber used in custom validator

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, getDbRequestParameters, preflight, process

Field Detail

UNNEEDED_CALL

public static final java.lang.String UNNEEDED_CALL

See Also:

Constant Field Values

logger

protected static final org.slf4j.Logger logger

requestParams

protected io.vertx.core.json.JsonObject requestParams

vertx

protected io.vertx.core.Vertx vertx

appTags

protected final java.util.List<io.micrometer.core.instrument.Tag> appTags

user

protected KeepUser user

apiName

protected java.lang.String apiName

Constructor Detail

AsyncDominoJNX

protected AsyncDominoJNX()

Default constructor for easy object creation

Method Detail

isWorkInProgress

public boolean isWorkInProgress()

Is the implementation of the (sub)class still work in progress? Needs to be overwritten by subclasses

Returns:

true if it isn’t done

accessControlCheck

public void accessControlCheck(KeepJnxSession session,
                               com.hcl.domino.data.Database db)
                        throws KeepException

Checks if the current user has the required access to perform the operation on a given database

Parameters:

session - Keep Session

db - Domino database

Throws:

KeepException

getApiName

public java.lang.String getApiName()

Specified by:

getApiName in interface AsyncDominoBase<T>

Specified by:

getApiName in interface KeepSubscriberInfo

Returns:

the API Name of the database in use

getAppTags

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

Specified by:

getAppTags in interface AsyncDominoBase<T>

Returns:

List of metrics tags currently applied

getBarbican

public TheBarbican getBarbican()

Specified by:

getBarbican in interface AsyncDominoBase<T>

Returns:

The Barbican - application security module

getEventbusId

public java.lang.String getEventbusId()

Returns:

the eventbusId

getRequestType

public AsyncDominoBase.RequestType getRequestType()

Specified by:

getRequestType in interface AsyncDominoBase<T>

Returns:

RequestType used for metrics

getUser

public KeepUser getUser()

Specified by:

getUser in interface AsyncDominoBase<T>

Specified by:

getUser in interface KeepSubscriberInfo

Returns:

the current Domino User

isProcessPayloadRequired

public boolean isProcessPayloadRequired()

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

Specified by:

isProcessPayloadRequired in interface AsyncDominoBase<T>

Returns:

the processPayloadRequired

setApiName

public void setApiName(java.lang.String apiName)

Description copied from interface: AsyncDominoBase

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

Specified by:

setApiName in interface AsyncDominoBase<T>

Parameters:

apiName - the apiName to set

setBarbican

public void setBarbican(TheBarbican barbican)

Setter for TheBarbican, allowing a mock TheBarbican to be used in tests

Parameters:

barbican -

setDbFileName

public void setDbFileName(java.lang.String dbFileName)

Description copied from interface: AsyncDominoBase

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

Specified by:

setDbFileName in interface AsyncDominoBase<T>

Parameters:

dbFileName - the dbFileName to set

setKeepDbInfo

public void setKeepDbInfo(KeepDbInfo keepDbInfo)

Description copied from interface: AsyncDominoBase

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

Specified by:

setKeepDbInfo in interface AsyncDominoBase<T>

Parameters:

keepDbInfo - KeepDbInfo object for the database to be queried

setProcessPayloadRequired

public void setProcessPayloadRequired(boolean processPayloadRequired)

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

Specified by:

setProcessPayloadRequired in interface AsyncDominoBase<T>

Parameters:

processPayloadRequired - the processPayloadRequired to set

setRequestParams

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

Description copied from interface: AsyncDominoBase

Updates the parameter object coming in from the request

Specified by:

setRequestParams in interface AsyncDominoBase<T>

setRequestType

public AsyncDominoBase<T> setRequestType(AsyncDominoBase.RequestType requestType)

Specified by:

setRequestType in interface AsyncDominoBase<T>

Parameters:

requestType - used for metrics

Returns:

this

setSubscriber

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

Description copied from interface: AsyncDominoBase

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

Specified by:

setSubscriber in interface AsyncDominoBase<T>

Parameters:

subscriber - the subscriber to set

setUser

public void setUser(KeepUser user)

Description copied from interface: AsyncDominoBase

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

Specified by:

setUser in interface AsyncDominoBase<T>

Parameters:

user - the user to set

setVertx

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

Description copied from interface: AsyncDominoBase

Inject the runtime into the request

Specified by:

setVertx in interface AsyncDominoBase<T>

Parameters:

vertx -

• Event runtime

subscribe

public void subscribe(io.reactivex.ObservableEmitter<T> newSubscriber)

Execution of the request inside a vert.x execute Blocking to ensure we don’t block the event loop Loads user and apiName (?db= query string param) from the observer

Specified by:

subscribe in interface io.reactivex.ObservableOnSubscribe<T>

dontCallProcessPayload

protected void dontCallProcessPayload()
                               throws KeepExceptionServer

Throws:

KeepExceptionServer

emitterToObserver

protected io.reactivex.Observer<T> emitterToObserver(io.reactivex.ObservableEmitter<T> oe)

Parameters:

oe - Observable emitter

Returns:

Observer

getActualDatabaseName

protected io.vertx.core.Future<java.lang.String> getActualDatabaseName(KeepUser actualUser,
                                                                       io.vertx.core.json.JsonObject payloadData)

getKeepDbInfo

protected KeepDbInfo getKeepDbInfo()

Returns:

KeepDbInfo object for the database being queried

getSubscriber

protected io.reactivex.ObservableEmitter<T> getSubscriber()

Returns:

the subscriber

getUserForMetrics

protected java.lang.String getUserForMetrics()

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

Parameters:

incoming -

• the message triggering the database action

recordAppMetrics

protected void recordAppMetrics(java.lang.String appId)

Records the use of this API for an application

Parameters:

appId -

validateDqlAccess

protected void validateDqlAccess(KeepJnxSession s,
                                 com.hcl.domino.data.Database db)
                          throws KeepException

Validate the user has access to run DQL, according to the DQL access formula in the KeepConfig

Parameters:

s -

• current user’s KeepJnxSession

db -

• database to be queried

Throws:

KeepException - error, e.g. not enough access or failure parsing formula

validateOpenAccess

protected void validateOpenAccess()
                           throws KeepExceptionOpenAccessBlocked

Throws:

KeepExceptionOpenAccessBlocked

validationCheck

protected boolean validationCheck(boolean status,
                                  java.lang.String message,
                                  java.lang.Object... params)

Helper class to log failures to local onError method of subscriber used in custom validator

Parameters:

status - condition if false triggers onError

message - the error message

params - Parameters to format the message

Returns:

status passed from parameter