Skip to content

Factories and Caches

KeepFactory

The KeepFactory provides access to individual caches for:

  • KeepConfig
  • DesignCache
  • LoggedOutUserList
  • JWTManager

It also provides a holder for a relevant user session, a KeepJnxSession object. This is why each instance of AsyncDominoJNXRequest creates a new KeepFactory object, to ensure no pollution of KeepJnxSessions.

KeepFactory often needs to work differently for JUnit tests. This is why instances of AbstractKeepVerticle (and AsyncDominoJNXRequest) create their own instance of KeepFactory and have a setter.

The KeepFactory is also used by the HttpListener and AbstractKeepDataVerticle to load handler classes according to the OpenAPI spec.

Domino REST API Errors

KeepConfig

The KeepConfig contains two main objects:

  • A map of KeepApiInfo objects, one for each endpoint in the OpenAPI spec with an operationId. The key in the map is the operationId. The contents are loaded when Domino REST API loads. The KeepApiInfo object also checks whether it can work as a JSON handling endpoint, if it:

    • responds with JSON
    • receives only JSON or expects no body

  • A map of KeepDbInfo objects, one for each database exposed for Domino REST API access. The key in the map is the Domino REST API name for the database. The structure is:

    • ApiName
    • FilePath
    • Icon
    • IconName
    • Description
    • List of owners, for reference purposes only
    • FormulaEngine (currently just "domino", future plan will include OpenFormula)
    • Whether or not it's active
    • UNID of the Notes Document in Domino REST API Config database
    • ConfigInfo, indicating:
      • Whether the database allows access from browsers (openAccess).
      • Whether the database allows code to be submitted via the "/run/code" and "/run/codejs" endpoints (allowCode).
      • Whether Domino Query Language (DQL) can be run against the database (dqlAccess).
      • Formula (applied according to the formulaEngine) for more tightly constraining access to DQL (dqlAccessFormula).
      • List of views that can be used from Domino REST API (availableViews).
      • List of agents than can be run from Domino REST API (agents).
      • List of stored procedures (code that the Domino REST API Administrator has added to be run) - NOT YET IMPLEMENTED (storedProcedures).
      • List of people who must approve requests for external applications to use this database - NOT YET IMPLEMENTED (applicationAccessApprovers).
      • Map of FormAccessModeInfo objects (formConfigs) where the modeName is the key. Every form exposed must have at least one FormAccessModeInfo for a modeName "default". Each FormAccessModeInfo contains:
        • ModeName
        • List of fields exposed to read access (readAccessFields)
        • List of fields exposed to write access (writeAccessFields)
        • Formula (applied according to the formulaEngine) for read access (readAccessFormula)
        • Formula (applied according to the formulaEngine) for write access (writeAccessFormula). This can include validation of the payload.
        • Formula(s) to be applied for any GET requests for the form mode (onLoad)
        • Formula(s) to be applied before saving any documents for this form mode (onSave)
      • Whether the Input Translation and Input Validation formulas on the underlying Notes Form should be applied (computeWithForm).

The KeepConfig is also used to:

  • Get and retrieve the system user name.
  • Check if local users are allowed, managed via the GodMode environment variable.
  • Scan and retrieve actual database names for the Domino REST API Admin module.
  • Read the JSON OpenAPI spec.

DesignCache

This is a cache for a database's design. It's populated from DesignFetchdxlRequest. Requests for individual design elements automatically route through DesignFetchdxlRequest if the design hasn't yet been cached. There are two buckets of data:

  • bucket, containing the design extracted as a JSON object.
  • dxlbucket, containing the raw DXL.

Entries are removed from the caches after 8 hours. There is also a specific endpoint to evict the whole cache.

The design cache is used by the Domino REST API Admin module to select:

  • Views to enable for Domino REST API access.
  • Forms to enable for Domino REST API access.
  • Agents to expose for Domino REST API access. As a result, anyone using the Domino REST API Admin module must have a minimum of Designer access to the databases they are enabling for Domino REST API access.

JWTManager

This is responsible for generating JWT tokens.

LoggedOutUserList

This uses an ExpiringMap to auto-expire JWT tokens. The "/logout" endpoint also expires a JWT token. The expired tokens are checked by the "jwt" security handler, ExpiringJwtHandler.