Skip to content

Latest commit

 

History

History
66 lines (55 loc) · 2.08 KB

README.md

File metadata and controls

66 lines (55 loc) · 2.08 KB

senzing-commons-java

If you are beginning your journey with Senzing, please start with Senzing Quick Start guides.

You are in the Senzing Garage where projects are "tinkered" on. Although this GitHub repository may help you understand an approach to using Senzing, it's not considered to be "production ready" and is not considered to be part of the Senzing product. Heck, it may not even be appropriate for your application of Senzing!

Overview

The Senzing Commons Java Library contains Java classes, interfaces and utilities that are common to multiple Senzing projects. It is initially a refactoring of classes from senzing-garage/senzing-api-server.

Dependencies

To build the Senzing Commons Java Library you will need Apache Maven (recommend version 3.6.1 or later) as well as OpenJDK version 11.0.x (recommend version 11.0.6+10 or later). All other dependencies for senzing-commons-java are maintained in the pom.xml file. No additional dependencies are required.

Building

This is a Maven project and as such standard Maven commands are used to build it:

  • Packaging the classes and javadocs in separate JAR files 
    mvn package
  • Packaging the classes and javadocs and installing in your local Maven repo: 
    mvn install
  • Simply compiling without packaging: 
    mvn compile
  • Removing artifacts from a previous build: 
    mvn clean
  • Packaging and/or installing with removal of previously built artifacts: 
    mvn clean package
    mvn clean install
  • Packaging and/or installing without running the unit tests: 
    mvn -DskipTests=true package
    mvn -DskipTests=true install

Documentation

Javadocs are provided for all classes. You can generate the Javadocs with the various build commands above. Please see the Javadocs for usage details.