com.hcl.domino.keep.dbrequests

Class DbRequestParameters<T>

java.lang.Object

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

Type Parameters:

T - Class of the result we expect

public abstract class DbRequestParameters<T>
extends java.lang.Object

Parameter object that is used to hand over all Elements that are needed to execute operations synchronously against a database for a given user

Field Summary

Fields

Modifier and Type	Field and Description
com.hcl.domino.DominoClient	client Access to commonly used Domino functions including DXL, databases and time ranges
com.hcl.domino.data.Database	db Notes database (nsf, ntf) containing the data to be acted upon Can be the database behind an alias, the mail file or the secondary calendar
KeepFactory	factory Shortcut access to the KeepFactory for DB related info current KeepFactory
io.vertx.core.json.JsonObject	incoming Incoming request containing parameters and eventually a body
io.reactivex.Observer<T>	observer Returns the observer for the values Observer
KeepJnxSession	session Keep Session that contains User and server info Starting point of entire action chain valid Keep Session
protected java.util.function.Predicate<io.vertx.core.json.JsonObject>	validator

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DbRequestParameters(KeepFactory factory, KeepJnxSession session, com.hcl.domino.DominoClient client, com.hcl.domino.data.Database db, io.reactivex.Observer<T> observer, io.vertx.core.json.JsonObject incoming)

Method Summary

Modifier and Type	Method and Description
abstract T	emit(T result) emit() is used to return results from the database operation It can be called zero to N times.
abstract void	validate() Default call to ensure valid requests
java.util.function.Predicate<io.vertx.core.json.JsonObject>	validator() Validation function for parameters.
DbRequestParameters<T>	validator(java.util.function.Predicate<io.vertx.core.json.JsonObject> newValidator) Allows to overwrite the existing validator

Methods inherited from class java.lang.Object

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

Field Detail

validator

protected java.util.function.Predicate<io.vertx.core.json.JsonObject> validator

db

public final com.hcl.domino.data.Database db

Notes database (nsf, ntf) containing the data to be acted upon Can be the database behind an alias, the mail file or the secondary calendar

factory

public final KeepFactory factory

Shortcut access to the KeepFactory for DB related info current KeepFactory

incoming

public final io.vertx.core.json.JsonObject incoming

Incoming request containing parameters and eventually a body

observer

public final io.reactivex.Observer<T> observer

Returns the observer for the values Observer

session

public final KeepJnxSession session

Keep Session that contains User and server info Starting point of entire action chain valid Keep Session

client

public final com.hcl.domino.DominoClient client

Access to commonly used Domino functions including DXL, databases and time ranges

Constructor Detail

DbRequestParameters

protected DbRequestParameters(KeepFactory factory,
                              KeepJnxSession session,
                              com.hcl.domino.DominoClient client,
                              com.hcl.domino.data.Database db,
                              io.reactivex.Observer<T> observer,
                              io.vertx.core.json.JsonObject incoming)

Parameters:

factory -

session -

client -

db -

observer -

incoming -

Method Detail

emit

public abstract T emit(@Nonnull
                       T result)

emit() is used to return results from the database operation It can be called zero to N times.

Parameters:

result - Outcome of the database operation

Returns:

the result back for use in stream API;

validate

public abstract void validate()
                       throws KeepException

Default call to ensure valid requests

Throws:

KeepException

validator

public java.util.function.Predicate<io.vertx.core.json.JsonObject> validator()

Validation function for parameters. Injected in main processing

Returns:

Function that validates the incoming data

validator

public DbRequestParameters<T> validator(java.util.function.Predicate<io.vertx.core.json.JsonObject> newValidator)

Allows to overwrite the existing validator

Parameters:

newValidator - a predicate to check validity

Returns:

fluent