- Intellij
- Docker
- Maven
- Java 17
- Lombok
Local Host: http://127.0.0.1:8080
Code Climate: https://codeclimate.com/github/bcgov/jag-adobe-common-service
WSDL Endpoint Local:
-
localhost:8080/ws/AdobeCommonServices.Source.CommonServices.ws.provider:PDFDiagnosticsWS?WSDL
-
localhost:8080/ws/AdobeCommonServices.Source.CommonServices.ws.provider:PDFTransformationsWS?WSDL
-
localhost:8080/ws/AdobeCommonServices.Source.CommonServices.ws.provider:PDFTransformationsSCPWS?WSDL
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.
LIFECYCLE_HOST: The url for lifecycle web services.
SFEG_USERNAME: username for ssh connection for transferring scp files
SPLUNK_HTTP_URL: The url for the spluck hec. For local splunk this value should be 127.0.0.1:8088 for remote do not include /services/collector.
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.
NFS_DIR: SFEG target directory for NFS transfer
SFTP_PRIVATE_KEY: Path to private key file
SFTP_KNOWN_HOSTS: Path to known hosts
SFEG_HOST: url of the secure File Transfer Protocol (SFTP)
WEBSERVICE_READ_TIMEOUT: Timeout in milliseconds which expects the response/result from Webservice.
- Set intellij to use java 11 for the project modals and sdk
- Run
mvn compile - Make sure
target/generated-sources/xjcfolder in included in module path foradobe-common-ws-models, andlifecycle-gateway-models
Option A) Intellij
- Create intellij run configuration from jag-adobe-common-service Application
- Set env variables. See the .env-template
- Run the application
Option B) Jar
- Run
mvn package - Run
java -jar ./target/jag-adobe-application.jar
Option C) Docker
- Run
mvn package - Run
docker build -t acs .from root folder to build image - Run
docker docker run -e $ENV_VAR$ acs(Note that environment variables need to be set)
- Dockerfile is to create container from Openshift, Dockerfile.local is to create container locally. This is because Openshift terminal root can't be found via '~'.
- To create docker container that runs application, 'known_hosts' is needed, and accessibility of read and write is needed.
Option D) Eclipse
- Clone the project into a local folder.
- Import the Maven project using the Maven Project Import Wizard.
- Set Variables either as Windows/Linux Environmental variables or POM goal Environment Variables:
BASIC_AUTH_PASS
BASIC_AUTH_USER
LIFECYCLE_HOST
SFEG_USERNAME
SPLUNK_HTTP_URL
SPLUNK_TOKEN
SPLUNK_INDEX
NFS_DIR
SFTP_PRIVATE_KEY
SFTP_KNOWN_HOSTS
SFEG_HOST
LIFECYCLE_HOST
- Create POM goals: clean install, spring-boot:run (when running locally).
- Do not commit \CRLF use unix line enders
- Run the linter
mvn spotless:apply
- Run
mvn clean verify - Open
adobe-code-coverage/target/site/jacoco-aggregate/index.htmlin a browser
- spring-starters-bom and spring-sftp-starter are libs branched from
https://github.com/bcgov/spring-boot-starters - id_rsa.pseudo is merely a pseudo key, used to pass unit test in maven package for git pipeline