jag-icon-2

Recommended Tools

• Intellij
• Docker
• Maven
• Java 11
• Lombok
• RabbitMQ

Application Endpoints

Local Host: http://127.0.0.1:8080

Actuator Endpoint Local: http://localhost:8080/actuator/health

Code Climate: https://codeclimate.com/github/bcgov/jag-icon-2

WSDL Endpoint Local:

• common-1-1: 1) localhost:8080/common-1-1/ICON2.Source.EReporting.ws.provider:Audit?WSDL

2) localhost:8080/common-1-1/ICON2.Source.MyInfo.ws.provider:MyInfo?WSDL

3) localhost:8080/common-1-1/ICON2.Source.EReporting.ws.provider:EReporting?WSDL

4) localhost:8080/common-1-1/ICON2.Source.Common.ws.provider:ErrorHandling?WSDL

5) localhost:8080/common-1-1/ICON2.Source.HealthServiceRequest.ws.provider:HSR?WSDL

6) localhost:8080/common-1-1/ICON2.Source.Message.ws.provider:Message?WSDL

7) localhost:8080/common-1-1/ICON2.Source.Version.ws.provider:PackageInfo?WSDL

8) localhost:8080/common-1-1/ICON2.Source.Common.ws.provider:SessionParameter?WSDL

9) localhost:8080/common-1-1/ICON2.Source.TombStoneInfo.ws.provider:TombStoneInfo?WSDL

10) localhost:8080/common-1-1/ICON2.Source.TrustAccount.ws.provider:TrustAccount?WSDL

11) localhost:8080/common-1-1/ICON2.Source.VisitSchedule.ws.provider:VisitSchedule?WSDL

• Biometrics:

  • localhost:8080/Biometrics/ICON2_Biometrics.Source.Biometrics.ws.provider:Biometrics?WSDL

• common-1-2:

  • localhost:8080/common-1-2/ICON2.Source.Authorization.ws.provider:AuthAuth?WSDL

• MyFiles:

  • localhost:8080/MyFiles/ICON2_MyFiles.Source.MyFiles.ws:MyFiles?WSDL

Required Environmental Variables

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: credential of ORDS_HOST.

ORDS_PASSWORD: credential of ORDS_HOST.

Additional Env Variables

• common-application-1-1: 1) PING_QUEUE_NAME: RabbitMQ queue name for testing, up to 255 bytes of UTF-8 characters. 2) PING_ROUTING_KEY: RabbitMQ routing key linking to PING_QUEUE_NAME for testing. 3) HSR_SERVICE_URL: A HealthServiceRequest web service url 4) HSR_QUEUE_NAME: RabbitMQ queue name for hsr messages, up to 255 bytes of UTF-8 characters. 5) HSR_ROUTING_KEY: RabbitMQ routing key linking to HSR_QUEUE_NAME. 6) RABBIT_EXCHANGE_NAME: RabbitMQ direct exchange name, which links a pair of routing key and queue name 7) RABBIT_MQ_HOST: RabbitMQ host, 'localhost' by default if installing a RabbitMQ on a local computer 8) RABBIT_MQ_USERNAME: RabbitMQ host username 9) RABBIT_MQ_PASSWORD: RabbitMQ host password

• common-Comparison-Tool-1-1/Common-Comparison-Tool-1-2: 1) API_HOST: Spring Boot API url 2) WM_HOST: webMethods url

• hsr-application: 1) HSR_QUEUE_NAME: RabbitMQ queue name for hsr messages, up to 255 bytes of UTF-8 characters. 2) HSR_SERVICE_URL: A HealthServiceRequest web service url 3) RABBIT_MQ_HOST: RabbitMQ host, 'localhost' by default if installing a RabbitMQ on a local computer 4) RABBIT_MQ_USERNAME: RabbitMQ host username 5) RABBIT_MQ_PASSWORD: RabbitMQ host password

• biometrics-application: 1) ONLINE_SERVICE_ID: Biometrics Online Service Id 2) IPS_HOST: IPS web service url 3) BCS_HOST: BCS web service url 4) IIS_HOST: IIS web service url

• AutomatedTests

  • API_HOST: Integration Test url

• myfiles-application/common-application-1-2:

  • none

Optional Enviromental Variables

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.

Building the Application

1) Make sure using java 11 for the project modals and sdk 2) Run mvn compile 3) Make sure icon2-common-models and icon2-hsr-models are marked as generated sources roots (xjc)

Pre-running the application

Run docker run -p 5672:5672 -p 15672:15672 rabbitmq:management

Running the application

Option A) Intellij 1) Set env variables. 2) Run the application

Option B) Jar, e.g., to run 'jag-icon2-common-application' application 1) Run mvn package 2) Run cd jag-icon2-common-application 3) Run java -jar ./target/jag-icon2-common-application.jar $ENV_VAR$ (Note that $ENV_VAR$ are environment variables)

Option C) Docker, e.g., to run 'jag-icon2-common-application' application 1) Run mvn package 2) Run cd jag-icon2-common-application 3) Run docker build -t jag-icon2-common-application . from root folder 4) Run docker run -p 8080:8080 jag-icon2-common-application $ENV_VAR$ (Note that $ENV_VAR$ are environment variables)

Running RabbitMQ

• http://localhost:15672/
• Username: 'guest' by default
• Password: 'guest' by default

Pre Commit

1) Do not commit \CRLF use unix line enders 2) Run the linter mvn spotless:apply

JaCoCo Coverage Report

1) Run mvn clean verify 2) Open ccd-code-coverage/target/site/jacoco/index.html in a browser