Git Product home page Git Product logo

jag-pcss-common's Introduction

jag-pcss-common

Lifecycle:Stable Maintainability Test Coverage

PCSS Common WebMethods Replacement

Recommended Tools

  • Intellij
  • Docker
  • Docker Compose
  • Maven
  • Java 11
  • Lombok

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-pcss-common

WSDL Endpoint Local:

  • localhost:8080/common/JusticePCSSCommon.wsProvider:pcssCommon?WSDL

  • localhost:8080/common/JusticePCSSCommon.wsProvider:pcssCommonSecure?WSDL

  • localhost:8080/common/JusticePCSSCommon.wsProvider:pcssReport?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: ORDS_HOST authentication

ORDS_PASSWORD: ORDS_HOST authentication

ADOBE_HOST: RESTful service url to retrieve justin adobe report

ORACLE_HOST: RESTful service url to retrieve justin report

ORACLE_NAME: name of the server to get justin report

GENERIC_AGENCY_ID: generic agency id being configured on server. The value is part of CodeValuesSecure's request.

GENERIC_PART_ID: generic agency id being configured on server. The value is part of CodeValuesSecure's request.

ORDS_READ_TIMEOUT: Timeout in seconds which expects the response/result from ORDS.

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 pcss-common-models, pcss-common-secure-models, and pcss-reports-models are marked as generated sources roots (xjc)

Running the application

Option A) Intellij

  1. Set env variables.
  2. Run the application

Option B) Jar

  1. Run mvn package
  2. Run cd pcss-common-application
  3. Run java -jar ./target/pcss-common-application.jar $ENV_VAR$ (Note that $ENV_VAR$ are environment variables)

Option C) Docker

  1. Run mvn package
  2. Run cd pcss-common-application
  3. Run docker build -t pcss-common-application .
  4. Run docker run -p 8080:8080 pcss-common-application $ENV_VAR$ (Note that $ENV_VAR$ are environment variables)

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 pcss-code-coverage/target/site/jacoco/index.html in a browser

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.