/HPCC-JAPIs

Java based HPCC WebServices Client API project

Primary LanguageJava

HPCC-Java-APIs Project

Java based APIs for interaction with HPCC services/tools

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

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 "JAPI".

Projects contained within:

  • wsclient

    • Set of APIs which Standardize and facilitate interaction with HPCC Web based Services. README
    • 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
    • Changelog
    • Future Releases
    • Open Issues
    • Sample code

  • dfs client

    • Java based interface into HPCC's dfs backend README

  • clienttools

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

  • rdf2hpcc

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

  • hpcc commons

    • HPCC Systems Java API common classes README

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

Each sub-project must be built individually.

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