Skip to content

hmcts/document-management-client

Repository files navigation

Document management client

Download

The service provides a set methods to integrate with document management. The two main responsibilities are:

  • upload document/s to document management,
  • download document/s from document management

Getting started

Prerequisites

Usage

Just include the library as your dependency and you will be to use the client class. Health check for DM service is provided as well.

Components provided by this library will get automatically configured in a Spring context if document_management.url configuration property is defined and does not equal false.

You will need to provide a Bean of type RestTemplate for the library to use

Building

The project uses Gradle as a build tool but you don't have install it locally since there is a ./gradlew wrapper script.

To build project please execute the following command:

    ./gradlew build

Developing

Unit tests

To run all unit tests please execute the following command:

    ./gradlew test

Coding style tests

To run all checks (including unit tests) please execute the following command:

    ./gradlew check

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the MIT License - see the LICENSE.txt file for details.