Jakarta NoSQL Driver For Domino Via Proton

This repository contains a Jakarta NoSQL driver that connects to a Domino server via Proton (the AppDev Pack). This driver targets Jakarta EE 9 and assumes that your application includes at least CDI 3.0, Bean Validation 3.0, and JSON-B 2.0. This driver builds on the core driver components developed in the XPages Jakarta EE Support project.

Usage

This driver can be retrieved from OpenNTF's Maven repository:

<repositories>
	<repository>
		<id>openntf</id>
		<url>https://artifactory.openntf.org/openntf</url>
	</repository>
</repositories>

<dependencies>
	<dependency>
		<groupId>org.openntf.jakarta</groupId>
		<artifactId>jnosql-driver-proton</artifactId>
		<version>1.0.0-SNAPSHOT</version>
	</dependency>
</dependencies>

To provide access to the contextual database, create a CDI bean that supplies a DatabaseSupplier instance and, optionally, an AccessTokenSupplier instance. For example:

@RequestScoped
public class ContextDatabaseSupplier {
	
	@Produces
	public DatabaseSupplier get() {
		return () -> {
			HttpServletRequest request = CDI.current().select(HttpServletRequest.class).get();
			return (Database)request.getAttribute("keySetByServletRequestListener");
		};
	}
	
	@Produces
	public AccessTokenSupplier getAccessToken() {
		return () -> /* Find the OIDC/IAM access token somehow, or return null/empty */;
	}
}

Implementation Notes

Currently, this driver does not support rich text, any view-based operations, or attachments.

Upstream Limitations

Because Proton does not expose a number of Domino APIs and concepts, this driver is limited compared to the LSXBE driver. Specifically:

• Sorting is not available when querying
• Views entries are not available
• Entities returned by @ViewDocuments (when implemented) may not be in view order
• DominoDocumentCollectionManager#getByNoteId is unavailable
• Folder add/remove methods are not available
• Transaction support is not available
• DominoDocumentCollectionManager#count is unreliable due to document-count restrictions in queries
• MIME is not supported
• The protected and signed item flags are not supported
• For time types, only LocalDate, LocalTime, and ZonedDateTime are supported
• Arrays of mixed time types (e.g. LocalDate and ZonedDateTime) are not supported

Jakarta NoSQL Dependencies

Because official builds of Jakarta NoSQL and the JNoSQL implementation target JEE8 upstream APIs, this project uses transformed artifacts hosted on OpenNTF's Maven repository using different coordinates and version numbers from the standard versions.

Requirements

• Java 8 or above
• The com.hcl.domino:domino-db Maven artifact of at least version 1.6.5 installed

If you have downloaded the AppDev Pack ZIP, you can install the domino-db driver in your local repository by extracting the "pom.xml" file from its META-INF/maven directory and then running a command like:

mvn install:install-file -Dfile=domino-db-1.6.5.jar -DpomFile=pom.xml -Djavadoc=domino-db-1.6.5-javadoc.jar

License

The code in the project is licensed under the Apache License 2.0. The dependencies in the binary distribution are licensed under compatible licenses - see NOTICE for details.