com.hcl.domino.keep

Interface KeepFactory

public interface KeepFactory

This interface defines factory methods to generate Handler (http side) and requestor (Domino side) instances The default implementation is @see KeepFactoryHolder singleton but might get overwritten by test classes Also contains default implementations for other keep objects

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	logger Factory Logger

Method Summary

Modifier and Type	Method and Description
default com.hcl.domino.DominoClient	authenticatedDominoClient(java.lang.String userName, java.lang.String password) Returns an authenticated Domino client
default KeepApplicationCache	getApplicationCache()
default AuthLogin	getAuthLogin()
default ConfigLoader	getConfigLoader(io.vertx.core.Vertx vertx, io.vertx.core.eventbus.EventBus eventBus, ConfigLoader.LoaderType loaderType) Instantiates a configLoader that can provide access to people, servers, design, dxl etc.
default java.util.Optional<DBRequestHandler>	getDBRequestHandler(io.vertx.core.Vertx vertx, java.lang.String methodName, java.lang.String packageName, io.vertx.core.json.JsonObject config, io.vertx.core.json.JsonObject handlerResults) Retrieves a handler for an incoming (http) request Typically the handler interacts with the eventbus and returns results
default DesignCache	getDesignCache()
default com.hcl.domino.DominoProcess	getDominoProcess()
default FormItemTypeCache	getFormItemTypeCache()
default io.vertx.ext.web.handler.impl.BodyHandlerImpl	getHandlerForIncomingRequest(io.vertx.core.Vertx vertx, KeepApiInfo method, boolean useDefaultIfMissing, java.lang.String packageName, io.vertx.core.json.JsonObject config, io.vertx.core.json.JsonObject missing) Retrieves a HTTP handler for incoming OpenAPI spec routes
default java.lang.ThreadLocal<SessionPreload>	getHeartBeatSession()
default DominoJMapMapperFactory	getJMapperFactory()
default JwtManager	getJwtManager()
default KeepConfig	getKeepConfig()
default KeepJnxSession	getKeepJnxSession(KeepUser user) Returns a KeepJnxSession for a given user
default KeepSAML	getKeepSAML() Returns the KeepSAML instance to interact with the IDVault
default KeepStatistics	getKeepStatistics()
default KeepUsers	getKeepUsers()
default io.vertx.ext.auth.ldap.LdapAuthentication	getLdapAuthentication(io.vertx.core.Vertx vertx, io.vertx.ext.auth.ldap.LdapAuthenticationOptions options) Returns LdapAuthentication
default LoggedOutUsers	getLoggedOutUsers()
default MimeHelper	getMimeHelper()
default NameLookupCache	getNameCache()
default KeepRequestCache	getRequestCache()
default KeepUser	getSystemUser()
default com.hcl.domino.DominoProcess.DominoThreadContext	getThreadContext() Access to the auto-garbage collectting DominoThreadContext
default com.hcl.domino.DominoProcess.DominoThreadContext	getThreadContext(com.hcl.domino.DominoProcess process) Access to the auto-garbage collectting DominoThreadContext
default ValidatorFactory	getValidatorFactory()
default com.hcl.domino.DominoClient	namedDominoClient(java.lang.String userName) Returns an authenticated Domino client

Field Detail

logger

static final org.slf4j.Logger logger

Factory Logger

Method Detail

authenticatedDominoClient

default com.hcl.domino.DominoClient authenticatedDominoClient(java.lang.String userName,
                                                              java.lang.String password)

Returns an authenticated Domino client

Parameters:

userName -

password -

Returns:

a DominoClient

getApplicationCache

default KeepApplicationCache getApplicationCache()

Returns:

external application cache

getAuthLogin

default AuthLogin getAuthLogin()

Returns:

new Authlogin handler to perform authentication

getConfigLoader

default ConfigLoader getConfigLoader(io.vertx.core.Vertx vertx,
                                     io.vertx.core.eventbus.EventBus eventBus,
                                     ConfigLoader.LoaderType loaderType)

Instantiates a configLoader that can provide access to people, servers, design, dxl etc.

Parameters:

vertx -

• EventLoop

eventBus -

• needed to reply

loaderType -

• what load do we need to process

Returns:

a new config loader

getDBRequestHandler

default java.util.Optional<DBRequestHandler> getDBRequestHandler(@Nonnull
                                                                 io.vertx.core.Vertx vertx,
                                                                 @Nonnull
                                                                 java.lang.String methodName,
                                                                 @Nonnull
                                                                 java.lang.String packageName,
                                                                 @Nonnull
                                                                 io.vertx.core.json.JsonObject config,
                                                                 @Nonnull
                                                                 io.vertx.core.json.JsonObject handlerResults)

Retrieves a handler for an incoming (http) request Typically the handler interacts with the eventbus and returns results

Parameters:

vertx - The event loop

methodName -

• the operationId retrieved from OpenAPI 3.x specification

packageName -

• Name of the Java package for the handler

config -

• the “subconfig” with request specific settings. like: "package" : "com.hcl.domino.keep.handlers", "defaultClass" : "com.hcl.domino.keep.handlers.DefaultJsonHandler"

handlerResults -

• The JSONObject to report back a successful load

Returns:

a handler or null if not found

getDesignCache

default DesignCache getDesignCache()

Returns:

Design cache holding full information on an application including DXL

getDominoProcess

default com.hcl.domino.DominoProcess getDominoProcess()

Returns:

init the Domino process

getFormItemTypeCache

default FormItemTypeCache getFormItemTypeCache()

Returns:

Cache with info about forms

getHandlerForIncomingRequest

default io.vertx.ext.web.handler.impl.BodyHandlerImpl getHandlerForIncomingRequest(@Nonnull
                                                                                   io.vertx.core.Vertx vertx,
                                                                                   @Nonnull
                                                                                   KeepApiInfo method,
                                                                                   boolean useDefaultIfMissing,
                                                                                   java.lang.String packageName,
                                                                                   io.vertx.core.json.JsonObject config,
                                                                                   io.vertx.core.json.JsonObject missing)

Retrieves a HTTP handler for incoming OpenAPI spec routes

Parameters:

vertx -

• loop instance

method -

• OpenAPOI method

useDefaultIfMissing -

• use the default class if class not found

packageName -

• package of the handler class

config -

• configuration file

missing -

Returns:

• a context handler

getHeartBeatSession

default java.lang.ThreadLocal<SessionPreload> getHeartBeatSession()

Returns:

The initial Session to Domino as ThreadLocal

getJMapperFactory

default DominoJMapMapperFactory getJMapperFactory()

Returns:

Mapper factory to translate Jmap from/to domino

getJwtManager

default JwtManager getJwtManager()

Returns:

The JWTManager instance

getKeepConfig

default KeepConfig getKeepConfig()

Returns:

a keep configuration object

getKeepJnxSession

default KeepJnxSession getKeepJnxSession(KeepUser user)

Returns a KeepJnxSession for a given user

Parameters:

user - userId in X500 CN= format

Returns:

a Keep session or null if it failed

getKeepSAML

default KeepSAML getKeepSAML()

Returns the KeepSAML instance to interact with the IDVault

Returns:

KeepSAML Singleton

getKeepStatistics

default KeepStatistics getKeepStatistics()

Returns:

holder for Keep statistics

getKeepUsers

default KeepUsers getKeepUsers()

Returns:

the cache that is used to check on users

getLdapAuthentication

default io.vertx.ext.auth.ldap.LdapAuthentication getLdapAuthentication(io.vertx.core.Vertx vertx,
                                                                        io.vertx.ext.auth.ldap.LdapAuthenticationOptions options)

Returns LdapAuthentication

Parameters:

vertx -

options -

Returns:

LdapAuthentication

getLoggedOutUsers

default LoggedOutUsers getLoggedOutUsers()

Returns:

Object with loggedout users

getMimeHelper

default MimeHelper getMimeHelper()

Returns:

a Mime Helper

getNameCache

default NameLookupCache getNameCache()

Returns:

The cache to handle name lookups

getRequestCache

default KeepRequestCache getRequestCache()

Returns:

the current active request cache implementation

getSystemUser

default KeepUser getSystemUser()

Returns:

The username associated with the NotesID (client or server)

getThreadContext

default com.hcl.domino.DominoProcess.DominoThreadContext getThreadContext()

Access to the auto-garbage collectting DominoThreadContext

Returns:

A Domino Thread context

getThreadContext

default com.hcl.domino.DominoProcess.DominoThreadContext getThreadContext(com.hcl.domino.DominoProcess process)

Access to the auto-garbage collectting DominoThreadContext

Parameters:

process -

Returns:

A Domino Thread context

getValidatorFactory

default ValidatorFactory getValidatorFactory()

Returns:

Helper classs that provides parameter validation

namedDominoClient

default com.hcl.domino.DominoClient namedDominoClient(java.lang.String userName)

Returns an authenticated Domino client

Parameters:

userName -

Returns:

a DominoClient