Skip to content

Latest commit

 

History

History
82 lines (59 loc) · 4.76 KB

README.md

File metadata and controls

82 lines (59 loc) · 4.76 KB
Raw

hpcc4j Master Nightly Maven Central Maven Central Maven Central Maven Central

CodeQL

⚠️ Note: WsClient v6.8.0 and v6.8.2 include a packaging error and should be avoided Learn more here

HPCC4J Project

Java based libraries for interaction with HPCC services/tools

This repository contains multiple Java-based libraries/tools which can be utilized to interact with HPCC Systems.

Feature and change requests are tracked via JIRA. Everybody is encouraged to report issues and contribute to the project. When opening JIRA tickets, make sure to set the project as "hpcc4j".

⚡ Note: This project references log4j which has been reported to include security vulnerabilitie(s) in versions prior to v2.15.0

Projects contained within:

  • WsClient

    • Set of APIs which Standardize and facilitate interaction with HPCC Web based Services.
    • The project is based on stub code generated from WSDLs using Eclipse tools based on Apache Axis and JSch(Java Secure Channel) for secure ftp transfers
    • Open Issues
    • Sample code

  • DFS Client

    • Java based interface into HPCC's dfs backend

  • HPCC Commons

    • HPCC Systems Java API common classes

  • clienttools

    • Java based interface to HPCC client tools
    • Currently only interfaces with eclcc

  • rdf2hpcc

    • RDF data ingestion tool to HPCC
    • Based on Apache Jena and dependent on org.hpccsystems.ws.client

HPCC4J and HPCC Kubernetes Clusters

Utilizing HPCC4J with containized HPCC Systems clusters requires some additional local configuration steps. These configuration steps are documented here: Using HPCC4j with HPCC on a Kubernetes Cluster

Build

These projects are configured to be built using Maven. To build the projects using Maven, navigate to the base directory of each project and issue the following command:

mvn install

NOTE: hpcccommons, wsclient, and dfsclient are controled via the top-level maven pom file and can be built via a single command. All sub-projects can be built individually using the pom file in each sub-project directory

For more information on how to use Maven see http://maven.apache.org

Contributions

All contributions must follow the JAVA source format described in the HPCC-JAVA-Formatter.xml file which can be found in /eclipse. This formatter can be used by the Eclipse IDE to automatically format JAVA source code.

  • From eclipse, choose Window->Preferences->Java->Code Stype->Formatter...

  • Import the HPCC-JAVA-Formatter.xml file and set it as the Active profile.

  • From the JAVA editor, choose Source->Format