Core case data client
This is a client library for interacting with the core case data store application. The two main responsibilities are:
- start event for new case
- submit case to core case data app
Getting started
Prerequisites
Usage
Just include the library as your dependency and you will be to use the client class. Health check for CCD service is provided as well.
Components provided by this library will get automatically configured in a Spring context if core_case_data.api.url
configuration property is defined and does not equal false
.
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
Coding style tests
To run all checks (including unit tests) please execute the following command:
./gradlew check
Functional Tests
The functional tests rely on CCD and Idam and need to be configured with appropriate user roles and events. Before running the functional test on a local environment run the following:
./scripts/create-role.sh
./scripts/import-definintion.sh
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
To release a new version add a tag with the version number and push this up to the origin repository. This will then build and publish the release to maven.
License
This project is licensed under the MIT License - see the LICENSE file for details.