- Intellij
- Docker
- Maven
- Java 17
- Lombok
- Redis
Local Host: http://127.0.0.1:8080
WSDL Endpoint Local: http://localhost:8080/ws/RoleRegistry.Source.RoleRegistry.ws.provider:RoleRegistry?WSDL
Actuator Endpoint Local: http://localhost:8080/actuator/health
Code Climate: https://codeclimate.com/github/bcgov/jag-role-registry
BASIC_AUTH_PASS: The password for the basic authentication. This can be any value for local.
BASIC_AUTH_USER: The username for the basic authentication. This can be any value for local.
ORDS_HOST: The url for ords rest package.
ORDS_USERNAME: ORDS_HOST authentication
ORDS_PASSWORD: ORDS_HOST authentication
REDIS_HOST: Redis url, 'localhost' by default if redis is installed on the local device
REDIS_PORT: Redis port, 6379 by default
REDIS_AUTH_PASS: Redis password for authentication
REDIS_TTL_SEC: the time to live for key being set in redis. When the TTL elapses, the key is automatically destroyed.
CACHING: enable/disable redis caching.
SPLUNK_HTTP_URL: The url for the splunk hec.
SPLUNK_TOKEN: The bearer token to authenticate the application.
SPLUNK_INDEX: The index that the application will push logs to. The index must be created in splunk before they can be pushed to.
- Make sure using java 17 for the project modals and sdk
- Run
mvn compile - Make sure
role-registry-common-modelsis marked as generated sources root (xjc)
- Install and run Redis
- Run
sudo docker pull redis - Run
docker run --name redis -d -p 6379:6379 redis redis-server --requirepass ***
Via IDE
- Set env variables.
- Run the application
Via Jar
- Run
mvn package - Run
java -jar ./target/cso-application.jar $ENV_VAR$(Note that$ENV_VAR$ are environment variables)
Via Docker
- Run
mvn package - Run
docker build -t role-reg-api .from root folder - Run
docker run -p 8080:8080 role-reg-api $ENV_VAR$(Note that$ENV_VAR$ are environment variables)
- Do not commit \CRLF use unix line enders
- Run the linter
mvn spotless:apply
- Run
mvn test - Run
mvn jacoco:report - Open
target/site/jacoco/index.htmlin a browser