HMCTS API Marketplace Service Piloting Pathfinder

This repository provides an example for implementing a cross-cutting concern like

• Logging
• JWT decryption
• Authorisation of resource endpoints.

🚀 Installation

To get started with this project, you'll need Java and Gradle installed.

Prerequisites

• ☕️ Java 21 or later: Ensure Java is installed and available on your PATH.

• ⚙️ Gradle: You can install Gradle using your preferred method:

  macOS (Recommended with Homebrew):

  brew install gradle

  Other Platforms: Visit the Gradle installation guide for platform-specific instructions.

You can verify installation with:

java -version
gradle -v

Add Gradle Wrapper

run gradle wrapper

🔑 Environment Setup for Local Builds

Recommended Approach for macOS Users (using direnv)

If you're on macOS, you can use direnv to automatically load these environment variables per project:

1. Install direnv:

   brew install direnv

2. Hook it into your shell (example for bash or zsh):

   echo 'eval "$(direnv hook bash)"' >> ~/.bash_profile
   # or for zsh
   echo 'eval "$(direnv hook zsh)"' >> ~/.zshrc

3. Allow direnv to load:

   direnv allow

This will ensure your environment is correctly set up every time you enter the project directory.

Static code analysis

Install PMD

brew install pmd

pmd check \
    --dir src/main/java \
    --rulesets \
    .github/pmd-ruleset.xml \
    --format html \
    -r build/reports/pmd/pmd-report.html

Authentication

This service supports multiple authentication providers. See the authentication documentation for details:

• Authentication Documentation - Complete authentication guide
• Quick Reference - Quick reference for developers
• JWTFilter Documentation - JWT filter specific documentation

License

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