com.hcl.domino.keep.dbrequests

Class DbRequestParametersBuilder<T>

java.lang.Object

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

Type Parameters:

T - Class of the request to be handled, currently Buffer and JsonObject

Direct Known Subclasses:

DbRequestParametersBuilderBuffer, DbRequestParametersBuilderJson

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

Builder to ease the creation of DbRequestParameters objects Builder for DbRequests

DbRequestParameters = new DbRequestParametersBuilder()
.db(aNotesDB)
.factory(KeepFactory)
.incoming(someJson)
.session(KeepSession)
.observer(someObserver)
.validator(aFunction)
.build();

Instead of validator(aFunction) we have some alternative methods to configure the validation (see below)

Constructor Summary

Constructors

Constructor and Description
DbRequestParametersBuilder()

Method Summary

Modifier and Type	Method and Description
DbRequestParameters<T>	build()
DbRequestParametersBuilder<T>	client(com.hcl.domino.DominoClient dominoClient)
DbRequestParametersBuilder<T>	db(com.hcl.domino.data.Database dominoDb)
DbRequestParametersBuilder<T>	factory(KeepFactory incomingFactory)
DbRequestParametersBuilder<T>	incoming(io.vertx.core.json.JsonObject incomingJson)
DbRequestParametersBuilder<T>	observer(io.reactivex.Observer<T> observer)
DbRequestParametersBuilder<T>	session(KeepJnxSession incomingSession)
DbRequestParametersBuilder<T>	skipValidation() Shortcut function for a non-validating DBRequest
DbRequestParametersBuilder<T>	validator(java.util.function.Predicate<io.vertx.core.json.JsonObject> incomingValidator)
abstract DbRequestParametersBuilder<T>	validatorFromEventBusId(java.lang.String eventBusId, java.util.function.Predicate<io.vertx.core.json.JsonObject> customValidator)
abstract DbRequestParametersBuilder<T>	validatorFromEventBusId(java.lang.String eventBusId, java.util.function.Predicate<io.vertx.core.json.JsonObject> customValidator, io.reactivex.Observer<T> observer)
abstract DbRequestParametersBuilder<T>	validatorFromEventBusId(java.lang.String eventBusId, java.util.function.Predicate<io.vertx.core.json.JsonObject> customValidator, io.reactivex.Observer<T> observer, boolean failIfMissing)

Methods inherited from class java.lang.Object

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

Constructor Detail

DbRequestParametersBuilder

public DbRequestParametersBuilder()

Method Detail

build

public DbRequestParameters<T> build()
                             throws KeepExceptionMissingParameters

Returns:

a complete DbRequestParameters with all parts

Throws:

KeepExceptionMissingParameters

client

public DbRequestParametersBuilder<T> client(@Nonnull
                                            com.hcl.domino.DominoClient dominoClient)

Parameters:

dominoClient - Domino client

Returns:

fluent

db

public DbRequestParametersBuilder<T> db(@Nonnull
                                        com.hcl.domino.data.Database dominoDb)

Parameters:

dominoDb - Domino database

Returns:

fluent

factory

public DbRequestParametersBuilder<T> factory(@Nonnull
                                             KeepFactory incomingFactory)

Parameters:

incomingFactory - Keep session

Returns:

fluent;

incoming

public DbRequestParametersBuilder<T> incoming(@Nonnull
                                              io.vertx.core.json.JsonObject incomingJson)

Parameters:

incomingJson - Json Payload params/body

Returns:

fluent

observer

public DbRequestParametersBuilder<T> observer(@Nonnull
                                              io.reactivex.Observer<T> observer)

Parameters:

observer - destination for results

Returns:

fluent

session

public DbRequestParametersBuilder<T> session(@Nonnull
                                             KeepJnxSession incomingSession)

Parameters:

incomingSession - Keep session

Returns:

fluent;

skipValidation

public DbRequestParametersBuilder<T> skipValidation()

Shortcut function for a non-validating DBRequest

Returns:

fluent

validator

public DbRequestParametersBuilder<T> validator(@Nonnull
                                               java.util.function.Predicate<io.vertx.core.json.JsonObject> incomingValidator)

Parameters:

incomingValidator -

• returns true if all good

Returns:

fluent

validatorFromEventBusId

public abstract DbRequestParametersBuilder<T> validatorFromEventBusId(java.lang.String eventBusId,
                                                                      java.util.function.Predicate<io.vertx.core.json.JsonObject> customValidator)
                                                               throws KeepExceptionMissingParameters

Parameters:

eventBusId -

• Identify the exact action to check against OpenAPI

customValidator -

• additional validation

Returns:

fluent

Throws:

KeepExceptionMissingParameters -

• thrown if the Observer is missing

validatorFromEventBusId

public abstract DbRequestParametersBuilder<T> validatorFromEventBusId(java.lang.String eventBusId,
                                                                      java.util.function.Predicate<io.vertx.core.json.JsonObject> customValidator,
                                                                      io.reactivex.Observer<T> observer)
                                                               throws KeepExceptionMissingParameters

Parameters:

eventBusId -

• Identify the exact action to check against OpenAPI

customValidator -

• additional validation

observer -

• observer to send errors too

Returns:

fluent

Throws:

KeepExceptionMissingParameters

validatorFromEventBusId

public abstract DbRequestParametersBuilder<T> validatorFromEventBusId(java.lang.String eventBusId,
                                                                      java.util.function.Predicate<io.vertx.core.json.JsonObject> customValidator,
                                                                      io.reactivex.Observer<T> observer,
                                                                      boolean failIfMissing)
                                                               throws KeepExceptionMissingParameters

Parameters:

eventBusId -

• Identify the exact action to check against OpenAPI

customValidator -

• additional validation

observer -

• observer to send errors too

failIfMissing -

• should validation fail if not found in config

Returns:

fluent

Throws:

KeepExceptionMissingParameters