Java / Spring Boot Client Library for Document Store

Overview

• Utility Library Index

• Java Docs for einnovator-documents-starter

Getting Started

External Configuration

Table below provides a quick summary for the configuration options:

DocumentsClientConfiguration:

FilesConfiguration:

Example: Configuring File Storage in Remote Document (application.yaml)

documents:
  server: http://documents.mydomain.com
  root: "/.upload/myapp"

Programmatic Configuration

Documents API

Example: Writing a File

@Autowired
private DocumentsClient client;

private URI writeDocument(String path, String content) {
	Document document = new Document()
			.withPath(path)
			.withInfo("My File...")
			.withInputStream(new ByteArrayInputStream(content.getBytes()))
			.withContentLength((long)content.length());
	URI uri = client.write(document, null, null);
	assertNotNull(uri);
	return uri;

Example: Read User JSON File

public Map<String, Object> readFavoritesFileForPrincipal(String path) {
	final String FAVORITES_PATH = "/.myapp/favorites.json";
	Document document = client.read(FAVORITES_PATH, DocumentOptions.CONTENT_AND_META, null);
	return MappingUtils.fromJson(document2.getOrReadContent(), Map.class);
}

Example: Discard files

final String TMP_PATH = "/tmp/.myapp";

public Map<String, Object> deleteTmpFiles() {
	client.delete(TMP_PATH, DocumentOptions.FORCE, null);		
}

Rest Endpoints

This section describes the REST endpoints automatically setup the the einnovator-documents-starter.

Table below provides a quick summary:

DocumentRestController:

FileUploadController: