Document Management Store App

License: MIT Build Status codecov Codacy Badge Codacy Badge Known Vulnerabilities

Document Management is a backend service to store and retrieve documents.

Tech

It uses:

  • Java8
  • Spring boot
  • Junit, Mockito and SpringBootTest and Powermockito
  • Gradle
  • lombok project - Lombok project

Plugins

Environment variables

The following environment variables are required:

Name Default Description
IDAM_USER_BASE_URI - Base URL for IdAM's User API service (idam-app). http://localhost:4501 for the dockerised local instance or tunneled dev instance.
IDAM_S2S_BASE_URI - Base URL for IdAM's S2S API service (service-auth-provider). http://localhost:4502 for the dockerised local instance or tunneled dev instance.
MAX_FILE_SIZE 100MB Max file size

Note: The MAX_FILE_SIZE enforces limit on the document upload in the document management backend service. Additionally, the max request content length (including file sizes) need to be configured for the IIS web server (on Azure) via maxAllowedContentLength property for request filter in web.config (config file within source repository).

Quickstart

# Get the connection string for Azure Blob Store and put it in place of getOneFromPortalAzure in application.yaml
# Do not commit it!!!
azure:
  storage:
      connection-string: ${STORAGEACCOUNT_PRIMARY_CONNECTION_STRING:getOneFromPortalAzure}
# Cloning repo and running though docker
git clone https://github.com/hmcts/document-management-store-app.git
cd document-management-store-app/
./buildrundm-docker.sh
# Run this script to aquire IDAM credentials required for DM API.
./idam.sh

Integration

There is currently a Java Client available here: https://github.com/hmcts/document-management-client

Swagger UI

To view our REST API go to {HOST}:{PORT}/swagger-ui.html

http://localhost:8080/swagger-ui.html

API Endpoints

A list of our endpoints can be found here

https://hmcts.github.io/reform-api-docs/swagger.html?url=https://hmcts.github.io/reform-api-docs/specs/document-management-store-app.json

Functional Tests

To use the functional tests locally for large .mp4 and .doc files please first download them from here : Large Files and place them under your resources folder document-management-store-app/src/functionalTest/resources This would make them available to be used in the Functional Test -

MV1 (R1) As authenticated user I should not be able to upload files that exceed permitted sizes
  • Ensure the @Pending annotation is removed before running the test locally.
  • Revert your changes after tests are run as these are for running the above F-Test on local only.

Document Management Store App

Spring Boot Application to store Documents

Document Management Store App Info

⭐ Stars 10
🔗 Source Code github.com
🕒 Last Update a year ago
🕒 Created 4 years ago
🐞 Open Issues 3
➗ Star-Issue Ratio 3
😎 Author hmcts