Skip to content

How HCL Domino REST API works

Let's take a look at the internal structure of Domino REST API to understand how it works. Domino REST API has a layered architecture with an HTTP listener at the top that receives the requests and hands them over to the handler. The handler then sends the requests to EventBus, which distributes them between different worker verticles. Then come the dbrequests classes that process the requests.

Domino REST API Classes

  • Requests arrive at the HTTP listener.
  • Based on OpenAPI specification, the listener loads routes and the required classes are derived from the OperationId of the OpenAPI specification.
  • Most requests and responses are JSON data and the HTTP listener identifies it based on OpenAPI specification.
  • Requests that provide and expect JSON are handled by the default code i.e. the defaultJsonHandler class. When the content-type is different, an HTTP side handler is provided. This handler is named after the operationID from the OpenAPI specification. The runtime indicates which handler classes are missing.
  • These classes then send the message to EventBus.
  • The EventBus then distributes the work to worker verticles, the DominoDefaultVerticle class.
  • The basic configuration of the Domino REST API system has worker verticles for code, data, design and personal information management (PIM). Since Domino REST API is extensible, you can add worker verticles, if needed.
  • The DominoDefault Verticle class knows which handler class to load.
  • The appropriate dbrequests handler class then takes over and processes the request, for example, talks to the Notes database, retrieves or updates information, and so forth.

Here is how Domino REST API handles different errors. Domino REST API Errors