Skip to content

GITB validator wrapping the e-Ark validator for the validation of eArchiving information packages.

Notifications You must be signed in to change notification settings

ISAITB/eark-validator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Introduction

This is a GITB validator wrapping the e-Ark validator for the validation of eArchiving information packages.

The service is implemented in Java, using the Spring Boot framework. It is built and packaged using Apache Maven.

Prerequisites

The following prerequisites are required:

  • To build: JDK 17+, Maven 3.2+.
  • To run: JRE 17+.

Building and running

  1. Build using mvn clean package.
  2. Once built you can run the application in two ways:
    a. With maven: mvn spring-boot:run.
    b. Standalone: java -jar ./target/eark-validator-VERSION.jar.
  3. The service's WSDL file is accessible at http://localhost:8080/services/validation?WSDL.

Live reload for development

This project uses Spring Boot's live reloading capabilities. When running the application from your IDE or through Maven, any change in classpath resources is automatically detected to restart the application.

Packaging using Docker

Running this application as a Docker container is very simple as described in Spring Boot's Docker documentation. The first step is to Install Docker and ensure it is up and running. The next steps depend on whether or not you are running Docker natively or through a virtual machine.

Packaging with native Docker

In this case you can build the Docker image through Maven:

  1. Build JAR file with mvn package.
  2. Build the Docker image with mvn dockerfile:build.

Packaging with Docker running via virtual machine

In this case you will need to build the image manually:

  1. Create a temporary folder.
  2. Copy in this folder the JAR file from the target folder.
  3. Copy in this folder the Dockerfile file from the project root.
  4. Build from this folder using docker build -t local/eark-validator --build-arg JAR_FILE=eark-validator-VERSION.jar ..

Note that the local/eark-validator name for the image matches what is configured for the Maven build. You can adapt this as needed in the commands or the pom.xml file.

Running the Docker container

Assuming an image name of local/eark-validator, it can be ran using docker --name eark-validator -p 8080:8080 -d local/eark-validator.

The WSDL file can now be accessed at http://DOCKER_MACHINE:8080/services/validation?WSDL.

About

GITB validator wrapping the e-Ark validator for the validation of eArchiving information packages.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published